CATs
Contents
CATs
List CATs
GET /v3/plugins/tosca/cats
Lists all CATs.
Inputs
None
Returns
An array of CATs of the following format:
Field | Type | Description |
---|---|---|
id | String | Identifier of the CAT. |
name | String | Name of the CAT. |
version | String | The version of the CAT. |
inputs | Array of String | An array of strings that contains the inputs for the CAT. |
is_mock | Boolean | Indicates whether this CAT is mock or not. |
global | Boolean | Indicates whether this CAT is global or not. |
Show CAT
GET /v3/plugins/tosca/cats/:id
Shows information about a specific CAT.
Inputs
None
Returns
A CAT of the following format:
Field | Type | Description |
---|---|---|
id | String | Identifier of the CAT. |
name | String | Name of the CAT. |
version | String | The version of the CAT. |
inputs | Array of String | An array of strings that contains the inputs for the CAT. |
is_mock | Boolean | Indicates whether this CAT is mock or not. |
global | Boolean | Indicates whether this CAT is global or not. |
Create CAT
POST /v3/plugins/tosca/cats
Creates a new CAT.
Inputs
Field | Type | Description | Required |
---|---|---|---|
provider_cat_id | String | Identifies a CAT where this CAT will be based on. | No* |
vendor_id | String | Identifies the vendor that this CAT will be associated with. | No* |
(*) Note: If provider_cat_id and vendor_id are provided, provider_cat_id will have preference over vendor_id.
Returns
A CAT of the following format:
Field | Type | Description |
---|---|---|
id | String | Identifier of the CAT. |
name | String | Name of the CAT. |
version | String | Version of the CAT. |
inputs | Array of String | Array of strings that contains the inputs for the CAT. |
is_mock | Boolean | Indicates whether this CAT is mock or not. |
global | Boolean | Indicates whether this CAT is global or not. |
upload_url | String | URL where the user must upload the CAT file. |
Parse CAT Metadata
PUT /v3/plugins/tosca/cats/:id/parse_metadata
Parses the data of the CAT file uploaded by the user.
Inputs
None
Returns
A CAT of the following format:
Field | Type | Description |
---|---|---|
id | String | Identifier of the CAT. |
name | String | Name of the CAT. |
version | String | The version of the CAT. |
inputs | Array of String | An array of strings that contains the inputs for the CAT. |
is_mock | Boolean | Indicates whether this CAT is mock or not. |
global | Boolean | Indicates whether this CAT is global or not. |
Destroy CAT
DELETE /v3/plugins/tosca/cats/:id
It destroys a CAT.
Inputs
None
Returns
None