How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Delphix Sources API

The Sources API from Delphix — 18 operation(s) for sources.

Delphix Sources API is one of 60 APIs that Delphix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sources. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 20 operations across 18 paths, and defines 42 schemas. It is described by OpenAPI 3.0.0, at version 3.28.0.

Requests are made against a single base URL, /dct/v3.

20 operations 18 paths 42 schemas 1 DELETE4 GET6 PATCH9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.28.0
Base URL
https://help-api.delphix.com/dct/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Delphix Sources API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 20

Across 18 paths, the API surfaces 20 operations — 1 DELETE, 4 GET, 6 PATCH, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Sources 20
GET
/sources
List all sources.
get_sources 3 params → 200
POST
/sources/oracle
Create an Oracle Source.
create_oracle_source body → 201
PATCH
/sources/oracle/{sourceId}
Update an Oracle source by ID.
update_oracle_source_by_id 1 param body → 200
POST
/sources/{sourceId}/jdbc-check
Verify JDBC connection string for a source.
verify_source_jdbc_connection_string 1 param body → 200
POST
/sources/postgres
Create a PostgreSQL source.
create_postgres_source body → 201
POST
/sources/appdata
Create an AppData source.
create_app_data_source body → 201
PATCH
/sources/appdata/{sourceId}
Update a AppData source by ID.
update_appdata_source_by_id 1 param body → 200
PATCH
/sources/postgres/{sourceId}
Update a PostgreSQL source by ID.
update_postgres_source_by_id 1 param body → 200
POST
/sources/ase
Create an ASE source.
create_ase_source body → 201
POST
/sources/mssql
Create an MSSQL source.
create_mssql_source body → 201
PATCH
/sources/ase/{sourceId}
Update an ASE source by ID.
update_ase_source_by_id 1 param body → 200
PATCH
/sources/mssql/{sourceId}
Update an MSSQL source by ID.
update_mssql_source_by_id 1 param body → 200
POST
/sources/search
Search for Sources.
search_sources 3 params body → 200
GET
/sources/{sourceId}
Get a source by ID.
get_source_by_id 1 param → 200
DELETE
/sources/{sourceId}
Delete a source by ID.
delete_source 1 param → 200
PATCH
/sources/{sourceId}/updatedeprecated
Update a Source.
update_source_by_id 1 param body → 200
POST
/sources/{sourceId}/tags
Create tags for a Source.
create_source_tags 1 param body → 201
GET
/sources/{sourceId}/tags
Get tags for a Source.
get_source_tags 1 param → 200
GET
/sources/{sourceId}/staging_compatible_repositories
Returns a list of repositories that match the specified source.
get_source_compatible_repo 1 param → 200
POST
/sources/{sourceId}/tags/delete
Delete tags for a Source.
delete_source_tags 1 param body → 204

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are Source (38 properties), Host (37 properties), Repository (35 properties), Environment (30 properties). Each schema is shown below with its type and property counts.

Host
object
A physical/virtual server.
37 properties
Tag
object
2 properties 2 required
MssqlSourceCreateParameters
object
9 properties 3 required
EnvironmentUser
object
14 properties
MSSQLListenerTypeEnum
string
Source
object
The Delphix representation of the source database (not typically managed by Delphix).
38 properties
AseSourceCreateParameters
object
6 properties 2 required
OracleListenerTypeEnum
string
VirtualizationTaskEvent
object
1 property
Environment
object
A grouping of a single host or a cluster of hosts.
30 properties
MSSQLClusterListener
object
4 properties
Engine
object
2 properties
PaginatedResponseMetadata
object
3 properties
OracleVirtualIP
object
A virtual IP address.
3 properties
MssqlConfigTypeEnum
string
JobTaskEvent
object
1 property
DeleteTag
object
3 properties
JobTask
object
8 properties
TagsRequest
object
1 property 1 required
OracleListener
object
7 properties
OracleRACDatabaseInstance
object
4 properties 3 required
Error
object
2 properties
ConnectivityCheckResponse
object
The result of the connectivity check.
2 properties 1 required
UpdateSourceParameters
object
Parameters to update a Source.
1 property
OracleService
object
2 properties
Errors
array
Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. The Errors object contains information about full or p…
SearchBody
object
Search body.
1 property
Repository
object
35 properties
VirtualizationTask
object
8 properties
AppDataSourceCreateParameters
object
9 properties 3 required
PostgresSourceCreateParameters
object
4 properties 2 required
AppDataSourceUpdateParameters
object
7 properties
OracleSourceCreateParameters
object
9 properties 2 required
TagsResponse
object
1 property
OracleConfigTypeEnum
string
OracleVerifyJdbcConnectionStringParams
object
3 properties 3 required
MSSQLSourceUpdateParameters
object
4 properties
OracleClusterNodeInstance
object
An oracle cluster node instance.
3 properties
AseSourceUpdateParameters
object
7 properties
PostgresSourceUpdateParameters
object
1 property
OracleSourceUpdateParameters
object
Parameters to update an Oracle source.
4 properties
Job
object
An asynchronous task.
25 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

delphix-sources-api-openapi.yml Raw ↑

Other APIs Delphix publishes across the network.

Delphix Algorithms API
Delphix Bookmarks API
Delphix CDB DSources API
Delphix CDBs API
Delphix Classifiers API
Delphix CloudAccounts API
Delphix ComplianceJobCollections API
Delphix ComplianceJobs API
Delphix ComplianceNodes API
Delphix Connectivity API
Delphix Connectors API
Delphix DatabaseTemplates API
Where this information came from

This is an independent, third-party profile of Delphix Sources API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.