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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Delphix

Delphix VDBs API

The VDBs API from Delphix — 54 operation(s) for vdbs.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 57 operations across 54 paths, and defines 104 schemas. It is described by OpenAPI 3.2.0, at version 3.28.0.

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

57 operations 54 paths 104 schemas 8 GET1 PATCH48 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
Contact
Delphix Support
Resource Areas
1

Authentication & Security 1

Delphix VDBs 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 57

Across 54 paths, the API surfaces 57 operations — 8 GET, 1 PATCH, 48 POST. Each is listed below with its method, path, parameters, and response codes.

VDBs 57
GET
/vdbs
List all vdbs
get_vdbs 4 params → 200
POST
/vdbs/empty-recycle-bin
Empty VDB recycle bin
empty_recycle_bin → 200
POST
/vdbs/search
Search for VDBs
search_vdbs 4 params body → 200
GET
/vdbs/{vdbId}
Get a VDB by ID
get_vdb_by_id 1 param → 200
PATCH
/vdbs/{vdbId}
Update values of a VDB
update_vdb_by_id 1 param body → 200
GET
/vdbs/{vdbId}/snapshots
List Snapshots for a VDB
get_vdb_snapshots 3 params → 200
POST
/vdbs/{vdbId}/snapshots
Snapshot a VDB
snapshot_vdb 1 param → 200
GET
/vdbs/{vdbId}/bookmarks
List Bookmarks compatible with this VDB
get_bookmarks_by_vdb 4 params → 200
POST
/vdbs/{vdbId}/bookmarks/search
Search Bookmarks compatible with this VDB
search_bookmarks_by_vdb 4 params body → 200
GET
/vdbs/{vdbId}/deletion-dependencies
Get deletion dependencies of a VDB
get_vdb_deletion_dependencies 1 param → 200
POST
/vdbs/{vdbId}/tags
Create tags for a VDB
create_vdb_tags 1 param body → 201
GET
/vdbs/{vdbId}/tags
Get tags for a VDB
get_tags_vdb 1 param → 200
POST
/vdbs/{vdbId}/tags/delete
Delete tags for a VDB
delete_vdb_tags 1 param body → 204
POST
/vdbs/{vdbId}/start
Start a VDB
start_vdb 1 param body → 200
POST
/vdbs/{vdbId}/stop
Stop a VDB
stop_vdb 1 param body → 200
POST
/vdbs/{vdbId}/enable
Enable a VDB
enable_vdb 1 param body → 200
POST
/vdbs/{vdbId}/disable
Disable a VDB
disable_vdb 1 param body → 200
POST
/vdbs/{vdbId}/migrate
Migrate a VDB
migrate_vdb 1 param body → 200
GET
/vdbs/{vdbId}/migrate_compatible_repositories
Returns a list of compatible repositories for vdb migration
get_migrate_compatible_repo 1 param → 200
POST
/vdbs/{vdbId}/restore-from-recycle-bin
Restore a VDB from recycle bin
restore_vdb_from_recycle_bin 1 param → 200
POST
/vdbs/{vdbId}/lock
Lock a VDB
lock_vdb 1 param body → 200
POST
/vdbs/{vdbId}/unlock
Unlock a VDB
unlock_vdb 1 param → 200
POST
/vdbs/{vdbId}/delete
Delete a VDB
delete_vdb 1 param body → 200
POST
/vdbs/{vdbId}/rollback_by_timestampdeprecated
Rollback a VDB by timestamp
rollback_vdb_by_timestamp 1 param body → 200
POST
/vdbs/{vdbId}/rollback_by_snapshotdeprecated
Rollback a VDB by snapshot
rollback_vdb_by_snapshot 1 param body → 200
POST
/vdbs/{vdbId}/rollback_from_bookmarkdeprecated
Rollback a VDB from a bookmark with only the same VDB
rollback_vdb_from_bookmark 1 param body → 200
POST
/vdbs/{vdbId}/refresh_by_timestamp
Refresh a VDB by timestamp
refresh_vdb_by_timestamp 1 param body → 200
POST
/vdbs/{vdbId}/refresh_by_snapshot
Refresh a VDB by snapshot
refresh_vdb_by_snapshot 1 param body → 200
POST
/vdbs/{vdbId}/refresh_from_bookmark
Refresh a VDB from bookmark with a single VDB
refresh_vdb_from_bookmark 1 param body → 200
POST
/vdbs/{vdbId}/refresh_by_location
Refresh a VDB by location
refresh_vdb_by_location 1 param body → 200
POST
/vdbs/{vdbId}/undo_refresh
Undo the last refresh operation
undo_refresh 1 param → 200
POST
/vdbs/{vdbId}/export_cleanup
Export cleanup for incremental V2P operation
export_cleanup 1 param body → 202
POST
/vdbs/{vdbId}/switch_timeflow
Switches the current timeflow of a VDB
switch_timeflow 1 param body → 200
POST
/vdbs/oracle/{vdbId}/upgradedeprecated
Upgrade Oracle VDB
upgrade_oracle_vdb 1 param body → 200
POST
/vdbs/{vdbId}/upgrade
Upgrade VDB
upgrade_vdb 1 param body → 200
GET
/vdbs/{vdbId}/upgrade_compatible_repositories
Returns a list of compatible repositories for vdb upgrade
get_upgrade_compatible_repo_for_vdb 1 param → 200
POST
/vdbs/{vdbId}/jdbc-check
Verify JDBC connection string for VDB
verify_vdb_jdbc_connection_string 1 param body → 200
POST
/vdbs/provision_by_timestamp
Provision a new VDB by timestamp
provision_vdb_by_timestamp body → 200
POST
/vdbs/provision_by_timestamp/defaults
Get default provision parameters for provisioning a new VDB by timestamp
provision_vdb_by_timestamp_defaults body → 200
POST
/vdbs/provision_by_location
Provision a new VDB by location
provision_vdb_by_location body → 200
POST
/vdbs/provision_by_location/defaults
Get default provision parameters for provisioning a new VDB by location
provision_vdb_by_location_defaults body → 200
POST
/vdbs/provision_by_snapshot
Provision a new VDB by snapshot
provision_vdb_by_snapshot body → 200
POST
/vdbs/provision_by_snapshot/defaults
Get default provision parameters for provisioning a new VDB by snapshot
provision_vdb_by_snapshot_defaults body → 200
POST
/vdbs/provision_from_bookmark
Provision a new VDB from a bookmark with a single VDB
provision_vdb_from_bookmark body → 200
POST
/vdbs/provision_from_bookmark/defaults
Get default provision parameters for provisioning a new VDB from a bookmark
provision_vdb_from_bookmark_defaults body → 200
POST
/vdbs/empty_vdb
Provision an empty VDB
empty_vdb body → 200
POST
/vdbs/{vdbId}/asm-in-place-export
Convert a virtual database to a physical database on Oracle ASM file system
oracle_asm_in_place_vdb_export 1 param body → 200
POST
/vdbs/{vdbId}/in-place-export
Convert a virtual database to a physical database on physical file system
export_vdb_in_place 1 param body → 200
POST
/vdbs/{vdbId}/asm-export-by-snapshot
Export a vdb using snapshot to an ASM file system
export_vdb_to_asm_by_snapshot 1 param body → 200
POST
/vdbs/{vdbId}/asm-export-by-location
Export a vdb using SCN to an ASM file system
export_vdb_to_asm_by_location 1 param body → 200
POST
/vdbs/{vdbId}/asm-export-by-timestamp
Export a vdb using timestamp to an ASM file system
export_vdb_to_asm_by_timestamp 1 param body → 200
POST
/vdbs/{vdbId}/export-from-bookmark
Export a vdb using bookmark to physical file system
export_vdb_from_bookmark 1 param body → 200
POST
/vdbs/{vdbId}/asm-export-from-bookmark
Export a vdb using bookmark to an ASM file system
export_vdb_to_asm_by_bookmark 1 param body → 200
POST
/vdbs/{vdbId}/export-by-timestamp
Export a vdb using timestamp to a physical file system
export_vdb_by_timestamp 1 param body → 200
POST
/vdbs/{vdbId}/export-by-snapshot
Export a vdb using snapshot to a physical file system
export_vdb_by_snapshot 1 param body → 200
POST
/vdbs/{vdbId}/export-by-location
Export a vdb using timeflow location to a physical file system
export_vdb_by_location 1 param body → 200
POST
/vdbs/{vdbId}/export_finalize
Finalize operation on incremental V2P export
export_finalize 1 param body → 202

Schemas 104

The contract defines 104 schemas that model the data the API accepts and returns. The most detailed are VDB (95 properties), UpdateVDBParameters (39 properties), Host (37 properties), Snapshot (36 properties). Each schema is shown below with its type and property counts.

TagsResponse
object
1 property
OracleTdeKeystoreConfigTypeEnum
string
Oracle TDE keystore configuration type.
DataPointByLocationParameters
object
2 properties
StartVDBParameters
object
Parameters to start a VDB.
1 property
MSSQLListenerTypeEnum
string
OracleClusterNodeInstance
object
An oracle cluster node instance.
3 properties
ProvisionVDBByLocationDefaultsRequest
object
4 properties
UpgradeDatabaseParameters
object
Parameters to upgrade a dSource/VDB.
3 properties 1 required
RollbackVDBByTimestampParameters
EnvironmentUser
object
14 properties
ExportFinalizeParameters
object
Parameters to finalize export (V2P) from the VDB created as part of the Incremental V2P
2 properties
ClusterNodeInstance
object
4 properties 3 required
ExportCleanupParameters
object
Parameters to cleanup VDB created as part of the Incremental V2P
2 properties
Replica
object
4 properties
DataPointBySnapshotParameters
object
1 property
ExportFromBookmarkParameters
JobTaskEvent
object
1 property
OracleAsmExportBySnapshotParameters
DeleteVDBParameters
object
Parameters to delete a VDB.
3 properties
ProvisionVDBBySnapshotParameters
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…
ExportDBTimeflowPointParameters
object
31 properties
Engine
object
2 properties
ExportByTimestampParameters
PermissionEnum
string
Type of the permission on DCT object.
Error
object
2 properties
VirtualDatasetHooks
object
VDB operation hooks.
13 properties
OracleAsmExportFromBookmarkParameters
StopVDBParameters
object
Parameters to stop a VDB.
2 properties
ConnectivityCheckResponse
object
The result of the connectivity check.
2 properties 1 required
BookmarkDSources
object
dSource id and name associated with bookmark.
5 properties
EngineStorageCapacityData
object
19 properties
ProvisionVDBByTimestampParameters
OracleAsmLayoutParameters
object
2 properties 1 required
VirtualizationTaskEvent
object
1 property
ProvisionVDBBySnapshotDefaultsRequest
object
3 properties
BookmarkPaaSInstances
object
PaaS Instance id and name associated with bookmark.
5 properties
Host
object
A physical/virtual server.
37 properties
Bookmark
object
A Data Control Tower object that references points in time for one or more datasets.
33 properties
DataPointFromBookmarkParameters
object
1 property 1 required
DisableVDBParameters
object
Parameters to disable a VDB.
2 properties
ExportBySnapshotParameters
EngineStorageDatasetType
string
Type of the dataset.
RefreshVDBByLocationParameters
object
Parameters to refresh by a database-specific identifier (SCN, LSN, etc).
3 properties
Snapshot
object
Virtualization Engine Snapshot of a dSource or VDB.
36 properties
ProvisionVDBByTimestampDefaultsRequest
object
5 properties 1 required
OracleListener
object
7 properties
OracleAsmInPlaceExportParameters
OracleCustomEnvVar
object
4 properties
FilesystemLayoutParameters
object
8 properties
ProvisionVDBFromBookmarkParameters
EngineStorageCapacityDependencyData
Engine storage capacity dependency data.
BookmarkPaaSDatabases
object
PaaS Database id and name associated with bookmark.
5 properties
VirtualizationTask
object
8 properties
ProvisionVDBFromBookmarkDefaultsRequest
object
1 property 1 required
MssqlAgReplica
object
A replica MSSQL source that constitutes an MSSQL AG virtual source.
11 properties
NfsVersionReasonEnum
string
The reason why the source is being mounted with nfsVersion.
TagsRequest
object
1 property 1 required
OracleVerifyJdbcConnectionStringParams
object
3 properties 3 required
ConfigSettingsStg
object
Custom Database-Level config settings.
3 properties
DataPointByTimestampParameters
object
3 properties
OracleVirtualIP
object
A virtual IP address.
3 properties
InPlaceExportParameters
RollbackVDBBySnapshotParameters
OracleListenerTypeEnum
string
Environment
object
A grouping of a single host or a cluster of hosts.
30 properties
AdditionalMountPoint
object
Specifies an additional location on which to mount a subdirectory of an AppData container.
3 properties
ProvisionVDBResponse
object
2 properties
MSSQLClusterListener
object
4 properties
JobTask
object
8 properties
Repository
object
35 properties
SearchBody
object
Search body.
1 property
OracleService
object
2 properties
MigrateVDBParameters
object
Parameters to migrate a VDB.
6 properties
VDB
object
A Delphix virtual database or dataset.
95 properties
RefreshVDBFromBookmarkParameters
DeleteTag
object
3 properties
ProvisionEmptyVDBParameters
2 required
Job
object
An asynchronous task.
25 properties
RefreshVDBByTimestampParameters
OracleAsmExportByLocationParameters
OracleActiveInstance
object
3 properties
BaseExportTransferStrategyParameters
object
2 properties
Hook
object
7 properties
PaginatedResponseMetadata
object
3 properties
CredentialsEnvVariable
object
15 properties 1 required
BaseProvisionVDBParameters
ContainerizationStateEnum
string
Indicates the virtual database's containerization state, created for or running inside a containerized environment like Linux containers.
Tag
object
2 properties 2 required
RefreshVDBBySnapshotParameters
DeletionDependenciesResponse
object
The deletion dependencies of a dataset.
1 property
UpgradeOracleDatabaseParameters
object
Parameters to upgrade an Oracle dataset.
2 properties 2 required
ExportByLocationParameters
SwitchTimeflowParameters
object
Parameters to switch the timeflow of a VDB.
1 property
OracleRacCustomEnvFile
object
2 properties
BookmarkVDBs
object
VDB id and name associated with bookmark.
7 properties
OracleAsmExportByTimestampParameters
UpdateVDBParameters
object
Parameters to update a VDB.
39 properties
OracleRacCustomEnvVar
object
3 properties
ListSnapshotsResponse
object
2 properties
RollbackVDBFromBookmarkParameters
ProvisionVDBByLocationParameters
EnableVDBParameters
object
Parameters to enable a VDB.
3 properties
OracleRACDatabaseInstance
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

delphix-vdbs-api-openapi.yml Raw ↑

Other APIs Delphix publishes across the network.

Delphix Algorithms API
AE Profile APIs.io
Delphix Bookmarks API
AE Profile APIs.io
Delphix CDB DSources API
AE Profile APIs.io
Delphix CDBs API
AE Profile APIs.io
Delphix Classifiers API
AE Profile APIs.io
Delphix ComplianceJobCollections API
AE Profile APIs.io
Delphix ComplianceJobs API
AE Profile APIs.io
Delphix ComplianceNodes API
AE Profile APIs.io
Delphix Connectivity API
AE Profile APIs.io
Delphix Connectors API
AE Profile APIs.io
Delphix DatabaseTemplates API
AE Profile APIs.io
Delphix DataLayouts API
AE Profile APIs.io
#VDBs
← Back to D APIs
API Details
ID
delphix:delphix-vdbs-api
Base URL
https://help-api.delphix.com/dct/v3
Docs
https://help-api.delphix.com/data-control-tower/continuous-data/2026.3.0.0/continuous-data-apis-dct-2026.3.0.0.html
Provider
Delphix
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=delphix-vdbs-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/delphix-vdbs-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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