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 CDBs API

The CDBs API from Delphix — 14 operation(s) for cdbs.

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

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

This API exposes 16 operations across 14 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 3.28.0.

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

16 operations 14 paths 32 schemas 4 GET2 PATCH10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 CDBs 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 16

Across 14 paths, the API surfaces 16 operations — 4 GET, 2 PATCH, 10 POST. Each is listed below with its method, path, parameters, and response codes.

CDBs 16
GET
/cdbs
List all CDBs (Oracle only)
get_cdbs 3 params → 200
POST
/cdbs/search
Search for CDBs (Oracle only)
search_cdbs 3 params body → 200
GET
/cdbs/{cdbId}
Get a CDB by ID (Oracle only)
get_cdb_by_id 1 param → 200
PATCH
/cdbs/{cdbId}
Update a CDB
update_cdb 1 param body → 200
PATCH
/cdbs/{cdbId}/updatedeprecated
Update a CDB
update_cdb_by_id 1 param body → 200
POST
/cdbs/{cdbId}/tags
Create tags for a CDB
create_cdb_tags 1 param body → 201
GET
/cdbs/{cdbId}/tags
Get tags for a CDB
get_tags_cdb 1 param → 200
POST
/cdbs/{cdbId}/tags/delete
Delete tags for a CDB
delete_cdb_tags 1 param body → 204
POST
/cdbs/{cdbId}/enabledeprecated
Enable a CDB
enable_cdb 1 param body → 200
POST
/cdbs/{cdbId}/disabledeprecated
Disable a CDB
disable_cdb 1 param body → 200
GET
/cdbs/{cdbId}/deletion-dependencies
Get deletion dependencies of a CDB
get_cdb_deletion_dependencies 1 param → 200
POST
/cdbs/{cdbId}/deletedeprecated
Delete a CDB
delete_cdb 1 param body → 200
POST
/cdbs/{cdbId}/upgradedeprecated
Upgrade Oracle CDB
upgrade_cdb 1 param body → 200
POST
/cdbs/{cdbId}/detachSourcedeprecated
Detaches an Oracle CDB from an Oracle database
detach_cdb 1 param → 200
POST
/cdbs/{cdbId}/attachSourcedeprecated
Attach an Oracle CDB to an Oracle database
attach_cdb 1 param body → 200
POST
/cdbs/{cdbId}/jdbc-check
Verify JDBC connection string for a CDB
verify_cdb_jdbc_connection_string 1 param body → 200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are CDB (42 properties), UpdateCDBParameters (26 properties), Job (25 properties), EngineStorageCapacityData (19 properties). Each schema is shown below with its type and property counts.

EngineStorageDatasetType
string
Type of the dataset.
OracleTdeKeystoreConfigTypeEnum
string
Oracle TDE keystore configuration type.
TagsResponse
object
1 property
SourceOperation
object
5 properties
DeleteTag
object
3 properties
Job
object
An asynchronous task.
25 properties
PaginatedResponseMetadata
object
3 properties
CredentialsEnvVariable
object
15 properties 1 required
EngineStorageCapacityDependencyData
Engine storage capacity dependency data.
OracleLogsyncModeTypeEnum
string
LogSync operation mode for this dSource.
VirtualizationTask
object
8 properties
Tag
object
2 properties 2 required
TagsRequest
object
1 property 1 required
CDB
object
The Delphix representation of an Oracle Container Database.
42 properties
ConnectivityCheckResponse
object
The result of the connectivity check.
2 properties 1 required
DeletionDependenciesResponse
object
The deletion dependencies of a dataset.
1 property
OracleVerifyJdbcConnectionStringParams
object
3 properties 3 required
UpgradeOracleContainerDatabaseParameters
object
Parameters to upgrade CDB/vCDB.
2 properties 2 required
UpdateCDBParameters
object
Parameters to update a CDB.
26 properties
EngineStorageCapacityData
object
19 properties
EnableCDBParameters
object
Parameters to enable a CDB.
1 property
OracleAttachParameters
object
16 properties
VirtualizationTaskEvent
object
1 property
JobTask
object
8 properties
JobTaskEvent
object
1 property
DeleteCDBParameters
object
Parameters to delete a CDB.
2 properties
OracleAttachCdbParameters
SearchBody
object
Search body.
1 property
OracleService
object
2 properties
DisableCDBParameters
object
Parameters to disable a CDB.
1 property
OracleRACDatabaseInstance
object
4 properties 3 required
Engine
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

delphix-cdbs-api-openapi.yml Raw ↑

Other APIs Delphix publishes across the network.

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

This is an independent, third-party profile of Delphix CDBs 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.