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

The VDBGroups API from Delphix — 21 operation(s) for vdbgroups.

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

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

This API exposes 25 operations across 21 paths, and defines 53 schemas. It is described by OpenAPI 3.0.0, at version 3.28.0.

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

25 operations 21 paths 53 schemas 1 DELETE5 GET1 PATCH18 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 VDBGroups 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 25

Across 21 paths, the API surfaces 25 operations — 1 DELETE, 5 GET, 1 PATCH, 18 POST. Each is listed below with its method, path, parameters, and response codes.

VDBGroups 25
GET
/vdb-groups
List all VDBGroups.
get_vdb_groups 3 params → 200
POST
/vdb-groups
Create a new VDB Group.
create_vdb_group body → 201
POST
/vdb-groups/provision_from_bookmark
Provision a new VDB Group from a Bookmark.
provision_vdb_group_from_bookmark body → 200
POST
/vdb-groups/search
Search for VDB Groups.
search_vdb_groups 3 params body → 200
GET
/vdb-groups/{vdbGroupId}
Get a VDB Group by name.
get_vdb_group 1 param → 200
PATCH
/vdb-groups/{vdbGroupId}
Update values of a VDB group.
update_vdb_group_by_id 1 param body → 200
DELETE
/vdb-groups/{vdbGroupId}
Delete a VDBGoup.
delete_vdb_group 1 param → 204
GET
/vdb-groups/{vdbGroupId}/latest-snapshots
Get latest snapshot of all the vdbs in VDB Group.
get_vdb_group_vdbs_latest_snapshots 1 param → 200
POST
/vdb-groups/{vdbGroupId}/timestamp-summary
Get timestamp summary of all the vdbs in VDB Group.
get_vdb_group_timestamp_summary 1 param body → 200
POST
/vdb-groups/{vdbGroupId}/tags
Create tags for a VDB Group.
create_vdb_groups_tags 1 param body → 201
GET
/vdb-groups/{vdbGroupId}/tags
Get tags for a VDB Group.
get_vdb_group_tags 1 param → 200
POST
/vdb-groups/{vdbGroupId}/tags/delete
Delete tags for a VDB Group.
delete_vdb_group_tags 1 param body → 204
POST
/vdb-groups/{vdbGroupId}/refreshdeprecated
Refresh a VDB Group from bookmark.
refresh_vdb_group 1 param body → 200
POST
/vdb-groups/{vdbGroupId}/refresh_from_bookmark
Refresh a VDB Group from bookmark.
refresh_vdb_group_from_bookmark 1 param body → 200
POST
/vdb-groups/{vdbGroupId}/refresh_by_snapshot
Refresh a VDB Group by snapshot.
refresh_vdb_group_by_snapshot 1 param body → 200
POST
/vdb-groups/{vdbGroupId}/refresh_by_timestamp
Refresh a VDB Group by timestamp.
refresh_vdb_group_by_timestamp 1 param body → 200
POST
/vdb-groups/{vdbGroupId}/rollbackdeprecated
Rollback a VDB Group from a bookmark.
rollback_vdb_group 1 param body → 200
GET
/vdb-groups/{vdbGroupId}/bookmarks
List bookmarks compatible with this VDB Group.
get_bookmarks_by_vdb_group 4 params → 200
POST
/vdb-groups/{vdbGroupId}/bookmarks/search
Search for bookmarks compatible with this VDB Group.
search_bookmarks_by_vdb_group 4 params body → 200
POST
/vdb-groups/{vdbGroupId}/lock
Lock a VDB Group.
lock_vdb_group 1 param body → 200
POST
/vdb-groups/{vdbGroupId}/unlock
Unlock a VDB Group.
unlock_vdb_group 1 param → 200
POST
/vdb-groups/{vdbGroupId}/start
Start a VDB Group.
start_vdb_group 1 param body → 200
POST
/vdb-groups/{vdbGroupId}/stop
Stop a VDB Group.
stop_vdb_group 1 param body → 200
POST
/vdb-groups/{vdbGroupId}/enable
Enable a VDB Group.
enable_vdb_group 1 param body → 200
POST
/vdb-groups/{vdbGroupId}/disable
Disable a VDB Group.
disable_vdb_group 1 param body → 200

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are Snapshot (36 properties), Bookmark (33 properties), Job (25 properties), VDBGroup (15 properties). Each schema is shown below with its type and property counts.

Tag
object
2 properties 2 required
BookmarkPaaSDatabases
object
PaaS Database id and name associated with bookmark.
5 properties
StartVDBParameters
object
Parameters to start a VDB.
1 property
CreateVDBGroupOrder
object
2 properties
VirtualizationTaskEvent
object
1 property
BookmarkVDBs
object
VDB id and name associated with bookmark.
7 properties
VDBGroupRefreshByTimestamp
object
Parameters to refresh a VDB Group by timestamp.
5 properties 1 required
Engine
object
2 properties
VDBEnableParametersMapping
Parameters to enable a VDB.
PaginatedResponseMetadata
object
3 properties
VirtualDatasetHooks
object
VDB operation hooks.
13 properties
RefreshModeEnum
string
Refresh Mode either self or parent, if PARENT then VDB Group is refreshed from parent of each VDB, else refreshed from self.
JobTaskEvent
object
1 property
VDBDisableParametersMapping
Parameters to disable a VDB.
DeleteTag
object
3 properties
EnableVDBParameters
object
Parameters to enable a VDB.
3 properties
UpdateVDBGroupParameters
object
Parameters to update a VDB group.
4 properties
JobTask
object
8 properties
TagsRequest
object
1 property 1 required
StopVDBParameters
object
Parameters to stop a VDB.
2 properties
BookmarkPaaSInstances
object
PaaS Instance id and name associated with bookmark.
5 properties
VDBOrder
SearchBody
object
Search body.
1 property
DisableVDBParameters
object
Parameters to disable a VDB.
2 properties
VDBGroupRefreshBySnapshot
object
Parameters to refresh a VDB Group by snapshot.
2 properties 2 required
Replica
object
4 properties
OracleRacCustomEnvFile
object
2 properties
VirtualizationTask
object
8 properties
AdditionalMountPoint
object
Specifies an additional location on which to mount a subdirectory of an AppData container.
3 properties
RefreshVDBGroupByTimestampParameters
object
Parameters to refresh a VDB Group by timestamp.
2 properties
Bookmark
object
A Data Control Tower object that references points in time for one or more datasets.
33 properties
ConfigSettingsStg
object
Custom Database-Level config settings.
3 properties
VDBStartParametersMapping
Parameters to start a VDB.
OracleTdeKeystoreConfigTypeEnum
string
Oracle TDE keystore configuration type.
BookmarkDSources
object
dSource id and name associated with bookmark.
5 properties
ClusterNodeInstance
object
4 properties 3 required
BaseProvisionVDBParameters
VDBGroup
object
A collection of virtual databases and datesets.
15 properties 2 required
TagsResponse
object
1 property
RollbackVDBGroupParameters
object
Parameters to rollback a VDB Group.
1 property 1 required
EnableVDBGroupParameters
object
Parameters to enable a VDB Group.
1 property
Hook
object
7 properties
RefreshVDBGroupParameters
object
Parameters to refresh a VDB Group.
1 property 1 required
OracleRacCustomEnvVar
object
3 properties
RefreshVDBGroupBySnapshotParameters
object
Parameters to refresh a VDB Group by snapshot.
1 property
ProvisionVDBGroupFromBookmarkParameters
object
5 properties 3 required
DisableVDBGroupParameters
object
Parameters to disable a VDB Group.
1 property
Snapshot
object
Virtualization Engine Snapshot of a dSource or VDB.
36 properties
StartVDBGroupParameters
object
Parameters to start a VDB Group.
1 property
StopVDBGroupParameters
object
Parameters to stop a VDB Group.
1 property
Job
object
An asynchronous task.
25 properties
VDBStopParametersMapping
Parameters to stop a VDB.
CredentialsEnvVariable
object
15 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

delphix-vdbgroups-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 VDBGroups 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.