The Toolkits API from Delphix — 8 operation(s) for toolkits.
openapi: 3.0.0
info:
title: Delphix DCT Algorithms Toolkits API
version: 3.28.0
description: Delphix DCT API
contact:
name: Delphix Support
url: https://portal.perforce.com/s/
email: support@delphix.com
servers:
- url: /dct/v3
security:
- ApiKeyAuth: []
tags:
- name: Toolkits
paths:
/toolkits:
get:
summary: List all toolkits.
operationId: get_toolkits
tags:
- Toolkits
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/toolkitSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListToolkitResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/Toolkit'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/toolkits/search:
post:
summary: Search for toolkits.
operationId: search_toolkits
tags:
- Toolkits
x-filterable:
fields:
id:
type: string
type:
type: string
pretty_name:
type: string
name:
type: string
reference:
type: string
version:
type: string
display_name:
type: string
plugin_id:
type: string
external_version:
type: string
engine_name:
type: string
engine_id:
type: string
build_api:
type: string
namespace:
type: string
identifier:
type: string
root_squash_enabled:
type: string
default_locale:
type: string
status:
type: string
language:
type: string
lua_name:
type: string
minimum_lua_version:
type: string
host_types:
type: array
items:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/toolkitSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SearchToolkitResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/Toolkit'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/toolkits/{toolkitId}:
parameters:
- $ref: '#/components/parameters/toolkitIdParam'
get:
summary: Get Toolkit by ID.
operationId: get_toolkit_by_id
tags:
- Toolkits
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Toolkit'
delete:
summary: Delete a Toolkit by ID.
operationId: delete_toolkit_by_id
tags:
- Toolkits
responses:
'200':
description: Ok
content:
application/json:
schema:
type: object
title: ToolkitDeleteJobResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/toolkits/{toolkitId}/tags:
parameters:
- $ref: '#/components/parameters/toolkitIdParam'
post:
tags:
- Toolkits
summary: Create tags for a toolkit.
operationId: create_toolkit_tags
requestBody:
content:
application/json:
schema:
x-body-name: toolkit_tags
$ref: '#/components/schemas/TagsRequest'
description: Tags information for Toolkit.
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
get:
tags:
- Toolkits
summary: Get tags for a Toolkit.
operationId: get_toolkit_tags
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
/toolkits/{toolkitId}/tags/delete:
parameters:
- $ref: '#/components/parameters/toolkitIdParam'
post:
tags:
- Toolkits
summary: Delete tags for a Toolkit.
operationId: delete_toolkit_tags
requestBody:
$ref: '#/components/requestBodies/DeleteTags'
responses:
'204':
description: No Content
/toolkits/upload:
post:
tags:
- Toolkits
summary: Upload toolkit to engines.
operationId: upload_toolkit
requestBody:
content:
multipart/form-data:
schema:
type: object
required:
- file
- engine_id
properties:
file:
description: The toolkit file to upload.
type: string
format: binary
engine_id:
description: ID or name of the registered engine to which toolkit needs to be uploaded.
type: string
responses:
'200':
description: Ok
content:
application/json:
schema:
type: object
title: ToolkitUploadJobResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/toolkits/schema_definitions:
get:
tags:
- Toolkits
summary: Get toolkit schema definitions.
operationId: get_toolkit_schema_definitions
responses:
'200':
description: Ok
content:
application/json:
schema:
type: object
title: ToolkitSchemaDefinitionsResponse
$ref: '#/components/schemas/ToolkitSchemaDefinitions'
/toolkits/{toolkitId}/upgrade:
parameters:
- $ref: '#/components/parameters/toolkitIdParam'
post:
tags:
- Toolkits
summary: Upgrade an Inactive appdata toolkit
operationId: upgrade_inactive_toolkit
responses:
'200':
description: Ok
content:
application/json:
schema:
type: object
title: InactiveToolkitUpgradeJobResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
components:
schemas:
Tag:
type: object
required:
- key
- value
properties:
key:
description: Key of the tag
type: string
minLength: 1
maxLength: 4000
example: key-1
value:
description: Value of the tag
type: string
minLength: 1
maxLength: 4000
example: value-1
VirtualizationTaskEvent:
deprecated: true
properties:
message_details:
type: string
Engine:
properties:
engine_id:
type: string
minLength: 1
maxLength: 4000
engine_name:
type: string
minLength: 1
maxLength: 4000
PaginatedResponseMetadata:
type: object
properties:
prev_cursor:
description: Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
type: string
next_cursor:
description: Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
type: string
total:
description: The total number of results. This value may not be provided.
type: integer
format: int_64
JobTaskEvent:
properties:
message_details:
type: string
DeleteTag:
type: object
properties:
key:
description: Key of the tag
type: string
minLength: 1
maxLength: 4000
example: key-1
value:
description: Value of the tag
type: string
minLength: 1
maxLength: 4000
example: value-1
tags:
description: List of tags to be deleted
type: array
minItems: 1
maxItems: 1000
uniqueItems: true
items:
$ref: '#/components/schemas/Tag'
JobTask:
properties:
id:
type: string
parent_job_id:
type: string
start_time:
type: string
format: date-time
end_time:
type: string
format: date-time
title:
type: string
percent_complete:
type: integer
minimum: 0
maximum: 100
events:
type: array
items:
$ref: '#/components/schemas/JobTaskEvent'
status:
type: string
enum:
- PENDING
- STARTED
- TIMEDOUT
- RUNNING
- CANCELED
- FAILED
- SUSPENDED
- WAITING
- COMPLETED
- ABANDONED
TagsRequest:
type: object
required:
- tags
properties:
tags:
description: Array of tags with key value pairs
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 1
maxItems: 1000
uniqueItems: true
Toolkit:
description: A toolkit or plugin.
type: object
properties:
id:
description: Id of the toolkit.
type: string
type:
description: Specifies whether this object is toolkit or plugin
type: string
reference:
description: The object reference.
type: string
engine_name:
description: Name of the engine.
type: string
engine_id:
description: Id of the engine.
type: string
virtual_source_definition:
description: Definition of how to provision virtual sources of this type
type: object
additionalProperties: true
linked_source_definition:
description: Definition of how to link sources of this type.
type: object
additionalProperties: true
discovery_definition:
description: Definition of how to discover sources of this type.
type: object
additionalProperties: true
upgrade_definition:
description: Definition of how to upgrade sources of this type.
type: object
additionalProperties: true
snapshot_parameters_definition:
description: The schema that defines the structure of the fields in AppDataSyncParameters.
type: object
additionalProperties: true
build_api:
description: The Delphix API version that the toolkit was built against.
type: string
display_name:
type: string
pretty_name:
type: string
version:
type: string
namespace:
type: string
identifier:
type: string
root_squash_enabled:
type: string
default_locale:
type: string
status:
type: string
language:
type: string
extended_start_stop_hooks:
type: string
entry_point:
type: string
lua_name:
type: string
minimum_lua_version:
type: string
host_types:
type: array
items:
type: string
snapshot_schema:
type: object
additionalProperties: true
resources:
type: object
manifest:
description: The manifest of the toolkit.
type: object
additionalProperties: true
tags:
description: Tags associated to this toolkit.
type: array
items:
$ref: '#/components/schemas/Tag'
SearchBody:
description: Search body.
type: object
properties:
filter_expression:
type: string
minLength: 5
maxLength: 50000
example: string_field CONTAINS "over" AND numberic_field GT 9000 OR string_field2 EQ "Goku"
VirtualizationTask:
deprecated: true
properties:
id:
type: string
parent_job_id:
type: string
start_time:
type: string
format: date-time
end_time:
type: string
format: date-time
title:
type: string
percent_complete:
type: integer
minimum: 0
maximum: 100
events:
type: array
items:
$ref: '#/components/schemas/VirtualizationTaskEvent'
status:
type: string
enum:
- PENDING
- STARTED
- TIMEDOUT
- RUNNING
- CANCELED
- FAILED
- SUSPENDED
- WAITING
- COMPLETED
- ABANDONED
ToolkitSchemaDefinitions:
description: Delphix plugin platform schema definitions.
type: object
properties:
id:
type: string
description:
type: string
definitions:
type: object
additionalProperties: true
TagsResponse:
type: object
properties:
tags:
description: Array of tags with key value pairs
type: array
items:
$ref: '#/components/schemas/Tag'
Job:
description: An asynchronous task.
type: object
properties:
id:
description: The Job entity ID.
type: string
example: job-123
status:
description: The status of the job.
type: string
enum:
- PENDING
- STARTED
- TIMEDOUT
- RUNNING
- CANCELED
- FAILED
- SUSPENDED
- WAITING
- COMPLETED
- ABANDONED
example: RUNNING
is_waiting_for_telemetry:
description: Indicates that the operations performed by this Job have completed successfully, but the object changes are not yet reflected. This is only set when when the JOB is in STARTED status, with the guarantee that the job will not transition to the FAILED status. Note that this flag will likely be replaced with a new status in future API versions and be deprecated.
type: boolean
type:
description: The type of job being done.
type: string
example: DB_REFRESH
localized_type:
description: The i18n translated type of job being done.
type: string
example: DB Refresh
error_details:
description: Details about the failure for FAILED jobs.
type: string
example: Unable to connect to the engine.
warning_message:
description: Warnings for the job.
type: string
example: 'Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.'
target_id:
description: A reference to the job's target.
type: string
example: vdb-123
target_name:
description: A reference to the job's target name.
type: string
example: vdb
start_time:
description: The time the job started executing.
type: string
format: date-time
example: '2022-01-02T05:11:24.148000+00:00'
update_time:
description: The time the job was last updated.
type: string
format: date-time
example: '2022-01-02T06:11:24.148000+00:00'
trace_id:
description: traceId of the request which created this Job
type: string
engine_ids:
description: IDs of the engines this Job is executing on.
type: array
items:
type: string
deprecated: true
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
engines:
type: array
items:
$ref: '#/components/schemas/Engine'
account_id:
description: The ID of the account who initiated this job.
type: integer
example: 1
account_name:
description: The account name which initiated this job. It can be either firstname and lastname combination or firstname or lastname or username or email address or Account-<id>.
type: string
example: User 1
compliance_node_id:
description: The ID of the associated compliance node, if applicable.
type: string
nullable: true
compliance_node_name:
description: The name of the associated compliance node, if applicable.
type: string
nullable: true
percent_complete:
description: Completion percentage of the Job.
type: integer
minimum: 0
maximum: 100
example: '50'
virtualization_tasks:
deprecated: true
type: array
items:
$ref: '#/components/schemas/VirtualizationTask'
tasks:
type: array
items:
$ref: '#/components/schemas/JobTask'
execution_id:
description: The ID of the associated masking execution, if any.
type: string
nullable: true
result_type:
description: The type of the job result. This is the type of the object present in the result.
type: string
result:
description: The result of the job execution. This is JSON serialized string of the result object whose type is specified by result_type property.
type: object
discriminator:
propertyName: class_type
parameters:
toolkitSortParam:
name: sort
in: query
description: The field to sort results by. A property name with a prepended '-' signifies descending order.
example: id
required: false
schema:
type: string
enum:
- id
- type
- pretty_name
- name
- reference
- version
- display_name
- plugin_id
- external_version
- engine_name
- engine_id
- type
- build_api
- identifier
- status
- lua_name
- minimum_lua_version
- -id
- -type
- -pretty_name
- -name
- -reference
- -version
- -display_name
- -plugin_id
- -external_version
- -engine_name
- -engine_id
- -type
- -build_api
- -identifier
- -status
- -lua_name
- -minimum_lua_version
nullable: true
example: name
limit:
name: limit
in: query
description: Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.
example: 50
schema:
type: integer
minimum: 1
maximum: 1000
default: 100
toolkitIdParam:
in: path
name: toolkitId
required: true
schema:
type: string
minLength: 1
description: The ID of the toolkit.
cursor:
name: cursor
in: query
description: Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.
schema:
type: string
minLength: 1
maxLength: 4096
requestBodies:
SearchBody:
x-skip-codegen-attr: description
description: 'A request body containing a filter expression. This enables searching
for items matching arbitrarily complex conditions. The list of
attributes which can be used in filter expressions is available
in the x-filterable vendor extension.
# Filter Expression Overview
**Note: All keywords are case-insensitive**
## Comparison Operators
| Operator | Description | Example |
| --- | --- | --- |
| CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS ''foobar'', field4 CONTAINS TRUE |
| IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN [''Goku'', ''Vegeta''] |
| GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 |
| GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 |
| LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 |
| LT | Tests if a field is less than a literal value | field1 LT 9.02 |
| NE | Tests if a field is not equal to a literal value | field1 NE 42 |
| EQ | Tests if a field is equal to a literal value | field1 EQ 42 |
## Search Operator
The SEARCH operator filters for items which have any filterable
attribute that contains the input string as a substring, comparison
is done case-insensitively. This is not restricted to attributes with
string values. Specifically `SEARCH ''12''` would match an item with an
attribute with an integer value of `123`.
## Logical Operators
Ordered by precedence.
| Operator | Description | Example |
| --- | --- | --- |
| NOT | Logical NOT (Right associative) | NOT field1 LE 9000 |
| AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ ''Goku'' |
| OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ ''Goku'' |
## Grouping
Parenthesis `()` can be used to override operator precedence.
For example:
NOT (field1 LT 1234 AND field2 CONTAINS ''foo'')
## Literal Values
| Literal | Description | Examples |
| --- | --- | --- |
| Nil | Represents the absence of a value | nil, Nil, nIl, NIL |
| Boolean | true/false boolean | true, false, True, False, TRUE, FALSE |
| Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 |
| String | Single or double quoted | "foo", "bar", "foo bar", ''foo'', ''bar'', ''foo bar'' |
| Datetime | Formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 |
| List | Comma-separated literals wrapped in square brackets | [0], [0, 1], [''foo'', "bar"] |
## Limitations
- A maximum of 8 unique identifiers may be used inside a filter expression.
'
content:
application/json:
schema:
$ref: '#/components/schemas/SearchBody'
examples:
nested:
description: 'An example of a nested Object comparison testing that at least one repository has a
version which is equal to 19.0.0.
'
summary: Nested Object Comparison
value:
filter_expression: repositories CONTAINS {version eq '19.0.0'}
relative:
description: 'An example of a relative comparison testing that field1 has a
value which is less than 123.
'
summary: Relative comparison
value:
filter_expression: field1 LE 123
nil:
description: 'An example of using nil to test for the absence of a value for field2.
'
summary: Absence of an attribute value
value:
filter_expression: field2 EQ NIL
non-nil:
description: 'An example of using nil to test for the existence of a value for field2.
'
summary: Existence of an attribute value
value:
filter_expression: field2 NE NIL
contains:
description: 'An example of using the ''CONTAINS'' operator to check if
field2 contains the string ''foo''. If field2 is string valued
then this is checking if ''foo'' is a substring of field2. If
field2 is a list of strings then this is checking if ''foo''
is a member of the list.
'
summary: Use of the CONTAINS operator
value:
filter_expression: field2 CONTAINS 'foo'
in:
description: 'An example of using the ''IN'' operator to check if field1
is an element of a list literal.
'
summary: Use of the IN operator
value:
filter_expression: field1 IN [1, 2, 3]
search:
description: 'An example of using the ''SEARCH'' operator to retrieve all elements
for which ''foo'' is a substring of a filterable attribute.
'
summary: Use of the SEARCH operator
value:
filter_expression: SEARCH 'foo'
parenthesis:
description: 'An example of parenthesis being used to group operators & override
operator precedence.
'
summary: Overriding operator precedence
value:
filter_expression: field1 LT 1234 AND (field2 CONTAINS 'foo' OR field3 CONTAINS 'bar')
DeleteTags:
description: The parameters to delete tags
content:
application/json:
schema:
x-body-name: environment
$ref: '#/components/schemas/DeleteTag'
examples:
delete_all_tags:
description: Delete all tags for given object - No request body required
summary: Delete all tags
value: {}
delete_tags_by_key:
description: Delete all tags for given object with matching key
summary: Delete tags by key
value:
key: key-1
delete_tags_by_key_value:
description: Delete tag for given object with matching key and value
summary: Delete a tag by key & value
value:
key: key-1
value: value-1
delete_multiple_tags_by_key_value:
description: Delete tags for given list of tags with matching key and value
summary: Delete multiple tags by key & value
value:
tags:
- key: key-1
value: value-1
- key: key-2
value: value-2
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: Authorization