The Sources API from Delphix — 18 operation(s) for sources.
openapi: 3.0.0
info:
title: Delphix DCT Algorithms Sources 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: Sources
paths:
/sources:
get:
summary: List all sources.
operationId: get_sources
tags:
- Sources
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/sourcesSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListSourcesResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/Source'
errors:
$ref: '#/components/schemas/Errors'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/sources/oracle:
post:
tags:
- Sources
summary: Create an Oracle Source.
operationId: create_oracle_source
requestBody:
$ref: '#/components/requestBodies/CreateOracleSourceBody'
responses:
'201':
description: Oracle Source creation initiated
content:
application/json:
schema:
type: object
title: CreateOracleSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
source_id:
type: string
description: The id of the created source.
example: 1-ORACLE_SINGLE_CONFIG-32
/sources/oracle/{sourceId}:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
patch:
summary: Update an Oracle source by ID.
operationId: update_oracle_source_by_id
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/UpdateOracleSourceBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdateOracleSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/sources/{sourceId}/jdbc-check:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
post:
tags:
- Sources
summary: Verify JDBC connection string for a source.
operationId: verify_source_jdbc_connection_string
requestBody:
$ref: '#/components/requestBodies/OracleVerifyJdbcConnectionStringBody'
responses:
'200':
description: Success or Failure.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectivityCheckResponse'
/sources/postgres:
post:
summary: Create a PostgreSQL source.
operationId: create_postgres_source
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/CreatePostgresSource'
responses:
'201':
description: PostgreSQL Source creation initiated
content:
application/json:
schema:
type: object
title: CreatePostgresSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
source_id:
type: string
description: The id of the created source.
example: source-1
/sources/appdata:
post:
summary: Create an AppData source.
operationId: create_app_data_source
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/CreateAppDataSource'
responses:
'201':
description: AppData Source creation initiated
content:
application/json:
schema:
type: object
title: CreateAppDataSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
source_id:
type: string
description: The id of the created source.
example: source-1
/sources/appdata/{sourceId}:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
patch:
summary: Update a AppData source by ID.
operationId: update_appdata_source_by_id
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/UpdateAppDataSource'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdateAppDataSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/sources/postgres/{sourceId}:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
patch:
summary: Update a PostgreSQL source by ID.
operationId: update_postgres_source_by_id
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/UpdatePostgresSource'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdatePostgresSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/sources/ase:
post:
summary: Create an ASE source.
operationId: create_ase_source
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/CreateAseSourceBody'
responses:
'201':
description: Sybase ASE Source creation initiated
content:
application/json:
schema:
type: object
title: CreateAseSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
source_id:
type: string
description: The id of the created source.
example: 1-source-3
/sources/mssql:
post:
summary: Create an MSSQL source.
operationId: create_mssql_source
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/CreateMssqlSourceBody'
responses:
'201':
description: MSSQL Source creation initiated
content:
application/json:
schema:
type: object
title: CreateMssqlSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
source_id:
type: string
description: The id of the created source.
example: 1-source-3
/sources/ase/{sourceId}:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
patch:
summary: Update an ASE source by ID.
operationId: update_ase_source_by_id
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/UpdateAseSourceBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdateAseSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/sources/mssql/{sourceId}:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
patch:
summary: Update an MSSQL source by ID.
operationId: update_mssql_source_by_id
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/UpdateMssqlSourceBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdateMssqlSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/sources/search:
post:
summary: Search for Sources.
operationId: search_sources
tags:
- Sources
x-filterable:
fields:
id:
type: string
database_type:
type: string
name:
type: string
database_version:
type: string
environment_id:
type: string
environment_name:
type: string
data_uuid:
type: string
ip_address:
type: string
fqdn:
type: string
size:
type: integer
jdbc_connection_string:
type: string
plugin_version:
type: string
is_dsource:
type: boolean
namespace_id:
type: string
namespace_name:
type: string
is_replica:
type: boolean
recovery_model:
type: string
mssql_source_type:
type: string
appdata_source_type:
type: string
is_pdb:
type: boolean
instance_name:
type: string
instance_number:
type: integer
user:
type: string
environment_user_ref:
type: string
non_sys_user:
type: string
discovered:
type: boolean
linking_enabled:
type: boolean
repository:
type: string
cdb_type:
type: string
data_connection_id:
type: string
database_name:
type: string
database_unique_name:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/sourcesSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SearchSourcesResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/Source'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/sources/{sourceId}:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
get:
summary: Get a source by ID.
operationId: get_source_by_id
tags:
- Sources
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Source'
delete:
summary: Delete a source by ID.
operationId: delete_source
tags:
- Sources
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: DeleteSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/sources/{sourceId}/update:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
patch:
deprecated: true
summary: Update a Source.
tags:
- Sources
operationId: update_source_by_id
requestBody:
content:
application/json:
schema:
x-body-name: update_source_parameter
$ref: '#/components/schemas/UpdateSourceParameters'
description: The parameters to update a Source.
responses:
'200':
description: Source update initiated.
content:
application/json:
schema:
type: object
title: UpdateSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/sources/{sourceId}/tags:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
post:
tags:
- Sources
summary: Create tags for a Source.
operationId: create_source_tags
requestBody:
content:
application/json:
schema:
x-body-name: vdb_tags
$ref: '#/components/schemas/TagsRequest'
description: Tags information for Source.
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
get:
tags:
- Sources
summary: Get tags for a Source.
operationId: get_source_tags
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
/sources/{sourceId}/staging_compatible_repositories:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
get:
tags:
- Sources
summary: Returns a list of repositories that match the specified source.
operationId: get_source_compatible_repo
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: StagingCompatibleEnvironmentsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/Environment'
/sources/{sourceId}/tags/delete:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
post:
tags:
- Sources
summary: Delete tags for a Source.
operationId: delete_source_tags
requestBody:
$ref: '#/components/requestBodies/DeleteTags'
responses:
'204':
description: No Content
components:
requestBodies:
UpdateAseSourceBody:
description: The parameters to update an ASE source.
content:
application/json:
schema:
x-body-name: source
$ref: '#/components/schemas/AseSourceUpdateParameters'
examples:
ASE:
description: 'The request example is intended for updating a ASE source.
'
summary: ASE source update
value:
database_name: testDb
repository_id: 1-ASE_INSTANCE-10
required: true
UpdateOracleSourceBody:
description: The parameters to update a Oracle source
content:
application/json:
schema:
x-body-name: oracle_source_update_parameters
$ref: '#/components/schemas/OracleSourceUpdateParameters'
examples:
oracle:
description: 'The request example is intended for updating an Oracle source.
'
summary: Oracle source update
value:
user: myuser
password: mypwd
oracle_services:
- jdbc:oracle:thin:@hostname:port/service_name
- jdbc:oracle:thin:@hostname:port:SID
linking_enabled: true
UpdateMssqlSourceBody:
description: The parameters to update an MSSQL source.
content:
application/json:
schema:
x-body-name: source
$ref: '#/components/schemas/MSSQLSourceUpdateParameters'
examples:
MSSQL:
description: 'The request example is intended for updating an MSSQL source.
'
summary: MSSQL source update
value:
database_name: testDb
repository_id: 1-MSSQL_INSTANCE-2
required: true
CreatePostgresSource:
description: The parameters to create a PostgreSQL source.
content:
application/json:
schema:
x-body-name: source
$ref: '#/components/schemas/PostgresSourceCreateParameters'
examples:
Postgres:
description: 'The request example is intended for creating a PostgreSQL source.
'
summary: PostgreSQL source create
value:
name: postgres-source
repository_id: APPDATA_REPOSITORY-10
engine_id: '1'
environment_id: UNIX_HOST_ENVIRONMENT-3
required: true
OracleVerifyJdbcConnectionStringBody:
description: The parameters to verify oracle jdbc connection string.
content:
application/json:
schema:
x-body-name: oracle_verify_jdbc_connection_parameters
$ref: '#/components/schemas/OracleVerifyJdbcConnectionStringParams'
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')
UpdatePostgresSource:
description: The parameters to update a PostgreSQL source
content:
application/json:
schema:
x-body-name: source
$ref: '#/components/schemas/PostgresSourceUpdateParameters'
examples:
postgres:
description: 'The request example is intended for updating a PostgreSQL source.
'
summary: PostgreSQL source update
value:
name: postgres-source-update
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
CreateAseSourceBody:
description: The parameters to create an ASE source.
content:
application/json:
schema:
x-body-name: source
$ref: '#/components/schemas/AseSourceCreateParameters'
examples:
Create ASE Source With Required Params:
description: 'The request example is intended for creating an ASE source with required params only.
'
summary: Create ASE source with required params only
value:
database_name: testDb
repository_id: 1-ASE_INSTANCE-10
engine_id: '1'
Create ASE Source With Optional Params:
description: 'The request example is intended for creating an ASE source including optional params.
'
summary: Create ASE source with including optional params
value:
database_name: testDb
repository_id: 1-ASE_INSTANCE-10
engine_id: '1'
required: true
CreateMssqlSourceBody:
description: The parameters to create an MSSQL source.
content:
application/json:
schema:
x-body-name: source
$ref: '#/components/schemas/MssqlSourceCreateParameters'
examples:
Create MSSQL Source With Required Params:
description: 'The request example is intended for creating an MSSQL source with required params only.
'
summary: Create MSSQL source with required params only
value:
mssql_config_type: MSSqlSIConfig
database_name: testDb
repository_id: 1-MSSQL_INSTANCE-13
Create MSSQL Source With Optional Params:
description: 'The request example is intended for creating an MSSQL source including optional params.
'
summary: Create MSSQL source including optional params
value:
mssql_config_type: MSSqlSIConfig
database_name: testDb
repository_id: 1-MSSQL_INSTANCE-13
engine_id: 1
required: true
UpdateAppDataSource:
description: The parameters to update an AppData source.
content:
application/json:
schema:
x-body-name: source
$ref: '#/components/schemas/AppDataSourceUpdateParameters'
examples:
AppData:
description: 'The request example is intended for updating a AppData source.
'
summary: AppData source update
value:
name: appdata-source
repository_id: 1-APPDATA_REPOSITORY-10
required: true
CreateAppDataSource:
description: The parameters to create a AppData source.
content:
application/json:
schema:
x-body-name: source
$ref: '#/components/schemas/AppDataSourceCreateParameters'
examples:
AppData:
description: 'The request example is intended for creating a AppData source.
'
summary: AppData source create
value:
name: appdata-source
type: STAGED
repository_id: 1-APPDATA_REPOSITORY-10
engine_id: '1'
required: true
CreateOracleSourceBody:
description: The parameters to create an Oracle source.
content:
application/json:
schema:
x-body-name: create_oracle_source_params
$ref: '#/components/schemas/OracleSourceCreateParameters'
examples:
Oracle Single Instance Source:
description: This example can be used for creating an Oracle single instance source.
summary: Oracle single instance source create
value:
oracle_config_type: OracleSIConfig
engine_id: 1
environment_id: 1-UNIX_HOST_ENVIRONMENT-17
database_name: MYSIDB
repository_id: 1-ORACLE_INSTALL-3
unique_name: MYSIDB
instance_name: MYSIDB
Oracle RAC Source:
description: This example can be used for creating an Oracle RAC source.
summary: Oracle RAC source create
value:
oracle_config_type: OracleRACConfig
engine_id: 1
environment_id: 1-UNIX_HOST_ENVIRONMENT-17
database_name: MYRACDB
repository_id: 1-ORACLE_INSTALL-3
unique_name: MYRACDB
instances:
- node_reference: ORACLE_CLUSTER_NODE-1
instance_number: 1
instance_name: MYRACDB1
- node_reference: ORACLE_CLUSTER_NODE-2
instance_number: 2
instance_name: MYRACDB2
schemas:
Host:
description: A physical/virtual server.
type: object
properties:
id:
description: The entity ID of this Host.
type: string
minLength: 1
maxLength: 256
example: 3-UNIX_HOST-5
reference:
description: Delphix engine equivalent constant
type: string
example: UNIX_HOST-5
hostname:
description: The hostname or IP address of this host.
type: string
example: linux.dev.delphix.com
os_name:
description: The name of the OS on this host.
type: string
example: Linux
os_version:
description: The version of the OS on this host.
type: string
example: Red Hat Enterprise Linux Server release 7.3 (Maipo)
distribution:
description: The name of the OS distribution on this host.
type: string
example: RedHat
memory_size:
description: The total amount of memory on this host in bytes.
type: integer
format: int64
example: 8382160896
available:
description: True if the host is up and a connection can be established from the engine.
type: boolean
example: false
available_timestamp:
description: The last time the available property was updated.
type: string
format: date-time
example: '2022-06-02T17:49:11.457Z'
not_available_reason:
description: The reason why the host is not available.
type: string
example: Failed to connect to host
oracle_cluster_node_reference:
description: The reference to the associated OracleClusterNode.
type: string
example: ORACLE_CLUSTER_NODE-1
oracle_cluster_node_name:
description: The name of the associated OracleClusterNod
# --- truncated at 32 KB (86 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-sources-api-openapi.yml