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

The VCDBs API from Delphix — 14 operation(s) for vcdbs.

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

Tagged areas include VCDBs. 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 35 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 35 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 VCDBs 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.

VCDBs 16
GET
/vcdbs
List all vCDBs (Oracle only)
get_vcdbs 3 params → 200
POST
/vcdbs/search
Search for vCDBs (Oracle only)
search_vcdbs 3 params body → 200
GET
/vcdbs/{vcdbId}
Get a vCDB by ID (Oracle only)
get_vcdb_by_id 1 param → 200
PATCH
/vcdbs/{vcdbId}
Update values of a VCDB
update_vcdb 1 param body → 200
POST
/vcdbs/{vcdbId}/tags
Create tags for a vCDB
create_vcdb_tags 1 param body → 201
GET
/vcdbs/{vcdbId}/tags
Get tags for a vCDB
get_tags_vcdb 1 param → 200
POST
/vcdbs/{vcdbId}/tags/delete
Delete tags for a vCDB
delete_vcdb_tags 1 param body → 204
POST
/vcdbs/{vcdbId}/enable
Enable a vCDB
enable_vcdb 1 param body → 200
POST
/vcdbs/{vcdbId}/disable
Disable a vCDB
disable_vcdb 1 param body → 200
GET
/vcdbs/{vcdbId}/deletion-dependencies
Get deletion dependencies of a vCDB
get_vcdb_deletion_dependencies 1 param → 200
POST
/vcdbs/{vcdbId}/delete
Delete a vCDB
delete_vcdb 1 param body → 200
PATCH
/vcdbs/{vcdbId}/updatedeprecated
Update a VCDB
update_vcdb_by_id 1 param body → 200
POST
/vcdbs/{vcdbId}/start
Start a vCDB
start_vcdb 1 param body → 200
POST
/vcdbs/{vcdbId}/stop
Stop a vCDB
stop_vcdb 1 param body → 200
POST
/vcdbs/{vcdbId}/upgrade
Upgrade Oracle vCDB
upgrade_vcdb 1 param body → 200
POST
/vcdbs/{vcdbId}/jdbc-check
Verify JDBC connection string for a vCDB
verify_vcdb_jdbc_connection_string 1 param body → 200

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are VCDB (47 properties), Job (25 properties), UpdateVCDBParameters (21 properties), EngineStorageCapacityData (19 properties). Each schema is shown below with its type and property counts.

OracleTdeKeystoreConfigTypeEnum
string
Oracle TDE keystore configuration type.
DeleteVCDBParameters
object
Parameters to delete a vCDB.
2 properties
TagsResponse
object
1 property
DeleteTag
object
3 properties
OracleCustomEnvVar
object
4 properties
StopVCDBParameters
object
Parameters to stop a vCDB.
2 properties
Job
object
An asynchronous task.
25 properties
OracleActiveInstance
object
3 properties
EnableVCDBParameters
object
Parameters to enable a vCDB.
1 property
VCDB
object
The Delphix Oracle Virtual Container Database.
47 properties
PaginatedResponseMetadata
object
3 properties
EngineStorageCapacityDependencyData
Engine storage capacity dependency data.
ContainerizationStateEnum
string
Indicates the virtual database's containerization state, created for or running inside a containerized environment like Linux containers.
VirtualizationTask
object
8 properties
Tag
object
2 properties 2 required
TagsRequest
object
1 property 1 required
NfsVersionReasonEnum
string
The reason why the source is being mounted with nfsVersion.
DeletionDependenciesResponse
object
The deletion dependencies of a dataset.
1 property
ConnectivityCheckResponse
object
The result of the connectivity check.
2 properties 1 required
OracleVerifyJdbcConnectionStringParams
object
3 properties 3 required
DisableVCDBParameters
object
Parameters to disable a vCDB.
1 property
EngineStorageCapacityData
object
19 properties
OracleRACDatabaseInstance
object
4 properties 3 required
OracleRacCustomEnvFile
object
2 properties
OracleRacCustomEnvVar
object
3 properties
StartVCDBParameters
object
Parameters to start a vCDB.
1 property
VirtualizationTaskEvent
object
1 property
UpdateVCDBParameters
object
Parameters to update a VCDB.
21 properties
JobTask
object
8 properties
JobTaskEvent
object
1 property
SearchBody
object
Search body.
1 property
OracleService
object
2 properties
EngineStorageDatasetType
string
Type of the dataset.
UpgradeOracleContainerDatabaseParameters
object
Parameters to upgrade CDB/vCDB.
2 properties 2 required
Engine
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

delphix-vcdbs-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 ComplianceJobCollections API
Delphix ComplianceJobs API
Delphix ComplianceNodes API
Delphix Connectivity API
Delphix Connectors API
Delphix DatabaseTemplates API
Delphix DataLayouts API
Where this information came from

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