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_groups3 params→ 200
POST
/vdb-groups
Create a new VDB Group.
create_vdb_groupbody→ 201
POST
/vdb-groups/provision_from_bookmark
Provision a new VDB Group from a Bookmark.
provision_vdb_group_from_bookmarkbody→ 200
POST
/vdb-groups/search
Search for VDB Groups.
search_vdb_groups3 paramsbody→ 200
GET
/vdb-groups/{vdbGroupId}
Get a VDB Group by name.
get_vdb_group1 param→ 200
PATCH
/vdb-groups/{vdbGroupId}
Update values of a VDB group.
update_vdb_group_by_id1 parambody→ 200
DELETE
/vdb-groups/{vdbGroupId}
Delete a VDBGoup.
delete_vdb_group1 param→ 204
GET
/vdb-groups/{vdbGroupId}/latest-snapshots
Get latest snapshot of all the vdbs in VDB Group.
get_vdb_group_vdbs_latest_snapshots1 param→ 200
POST
/vdb-groups/{vdbGroupId}/timestamp-summary
Get timestamp summary of all the vdbs in VDB Group.
get_vdb_group_timestamp_summary1 parambody→ 200
POST
/vdb-groups/{vdbGroupId}/tags
Create tags for a VDB Group.
create_vdb_groups_tags1 parambody→ 201
GET
/vdb-groups/{vdbGroupId}/tags
Get tags for a VDB Group.
get_vdb_group_tags1 param→ 200
POST
/vdb-groups/{vdbGroupId}/tags/delete
Delete tags for a VDB Group.
delete_vdb_group_tags1 parambody→ 204
POST
/vdb-groups/{vdbGroupId}/refreshdeprecated
Refresh a VDB Group from bookmark.
refresh_vdb_group1 parambody→ 200
POST
/vdb-groups/{vdbGroupId}/refresh_from_bookmark
Refresh a VDB Group from bookmark.
refresh_vdb_group_from_bookmark1 parambody→ 200
POST
/vdb-groups/{vdbGroupId}/refresh_by_snapshot
Refresh a VDB Group by snapshot.
refresh_vdb_group_by_snapshot1 parambody→ 200
POST
/vdb-groups/{vdbGroupId}/refresh_by_timestamp
Refresh a VDB Group by timestamp.
refresh_vdb_group_by_timestamp1 parambody→ 200
POST
/vdb-groups/{vdbGroupId}/rollbackdeprecated
Rollback a VDB Group from a bookmark.
rollback_vdb_group1 parambody→ 200
GET
/vdb-groups/{vdbGroupId}/bookmarks
List bookmarks compatible with this VDB Group.
get_bookmarks_by_vdb_group4 params→ 200
POST
/vdb-groups/{vdbGroupId}/bookmarks/search
Search for bookmarks compatible with this VDB Group.
search_bookmarks_by_vdb_group4 paramsbody→ 200
POST
/vdb-groups/{vdbGroupId}/lock
Lock a VDB Group.
lock_vdb_group1 parambody→ 200
POST
/vdb-groups/{vdbGroupId}/unlock
Unlock a VDB Group.
unlock_vdb_group1 param→ 200
POST
/vdb-groups/{vdbGroupId}/start
Start a VDB Group.
start_vdb_group1 parambody→ 200
POST
/vdb-groups/{vdbGroupId}/stop
Stop a VDB Group.
stop_vdb_group1 parambody→ 200
POST
/vdb-groups/{vdbGroupId}/enable
Enable a VDB Group.
enable_vdb_group1 parambody→ 200
POST
/vdb-groups/{vdbGroupId}/disable
Disable a VDB Group.
disable_vdb_group1 parambody→ 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 properties2 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 properties1 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 property1 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 properties2 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 properties3 required
BaseProvisionVDBParameters
VDBGroup
object
A collection of virtual databases and datesets.
15 properties2 required
TagsResponse
object
1 property
RollbackVDBGroupParameters
object
Parameters to rollback a VDB Group.
1 property1 required
EnableVDBGroupParameters
object
Parameters to enable a VDB Group.
1 property
Hook
object
7 properties
RefreshVDBGroupParameters
object
Parameters to refresh a VDB Group.
1 property1 required
OracleRacCustomEnvVar
object
3 properties
RefreshVDBGroupBySnapshotParameters
object
Parameters to refresh a VDB Group by snapshot.
1 property
ProvisionVDBGroupFromBookmarkParameters
object
5 properties3 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 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 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.