The VDBs API from Delphix — 54 operation(s) for vdbs.
openapi: 3.0.0
info:
title: Delphix DCT Algorithms VDBs API
version: 3.28.0
description: Delphix DCT API
contact:
name: Delphix Support
url: https://portal.perforce.com/s/
email: support@delphix.com
servers:
- url: /dct/v3
security:
- ApiKeyAuth: []
tags:
- name: VDBs
paths:
/vdbs:
get:
summary: List all vdbs.
operationId: get_vdbs
tags:
- VDBs
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/vdbsSortParam'
- $ref: '#/components/parameters/permission'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListVDBsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/VDB'
errors:
$ref: '#/components/schemas/Errors'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/vdbs/empty-recycle-bin:
x-internal: true
post:
summary: Empty VDB recycle bin.
operationId: empty_recycle_bin
tags:
- VDBs
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: EmptyRecycleBinResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/search:
post:
summary: Search for VDBs.
operationId: search_vdbs
tags:
- VDBs
x-filterable:
fields:
id:
type: string
database_type:
type: string
name:
type: string
description:
type: string
database_name:
type: string
database_version:
type: string
jdbc_connection_string:
type: string
size:
type: integer
storage_size:
type: integer
unvirtualized_space:
type: integer
engine_id:
type: string
status:
type: string
environment_id:
type: string
ip_address:
type: string
fqdn:
type: string
parent_id:
type: string
parent_dsource_id:
type: string
group_name:
type: string
creation_date:
type: string
last_refreshed_date:
type: string
current_timeflow_id:
type: string
previous_timeflow_id:
type: string
masked:
type: boolean
namespace_id:
type: string
namespace_name:
type: string
is_replica:
type: boolean
is_locked:
type: boolean
logsync_enabled:
x-internal: true
type: boolean
exported_data_directory:
type: string
vcdb_exported_data_directory:
type: string
locked_by:
type: integer
format: int64
locked_by_name:
type: string
content_type:
type: string
template_id:
type: string
template_name:
type: string
tags:
type: array[object]
fields:
key:
type: string
value:
type: string
hooks:
type: array[object]
fields:
name:
type: string
command:
type: string
shell:
type: string
element_id:
type: string
has_credentials:
type: string
hook_point:
type: string
engine_name:
type: string
cdb_id:
type: string
appdata_source_params:
type: string
config_params:
type: string
primary_object_id:
type: string
primary_engine_id:
type: string
primary_engine_name:
type: string
replicas:
type: array[object]
fields:
replica_id:
type: string
replica_engine_id:
type: string
replica_engine_name:
type: string
invoke_datapatch:
type: boolean
node_listeners:
type: array[string]
instance_name:
type: string
instance_number:
type: integer
repository_id:
type: string
containerization_state:
type: string
parent_tde_keystore_path:
type: string
target_vcdb_tde_keystore_path:
type: string
tde_key_identifier:
type: string
parent_pdb_tde_keystore_path:
type: string
target_pdb_tde_keystore_path:
type: string
environment_user_ref:
type: string
recovery_model:
type: string
cdc_on_provision:
type: boolean
data_connection_id:
type: string
mssql_ag_backup_location:
type: string
mssql_ag_backup_based:
type: boolean
mssql_ag_replicas:
type: array[object]
fields:
name:
type: string
ag_replica_id:
type: string
vdb_id:
type: string
current_timeflow_id:
type: string
mount_point:
type: string
exported_data_directory:
type: string
repository_id:
type: string
environment_id:
type: string
curr_timeflow_support_provision_without_backup:
type: boolean
curr_timeflow_ag_replica_sync_status:
type: string
curr_timeflow_last_hardened_lsn:
type: string
database_unique_name:
type: string
db_username:
type: string
new_db_id:
type: boolean
redo_log_groups:
type: integer
format: int32
redo_log_size_in_mb:
type: integer
format: int32
toolkit_id:
type: string
nfs_version:
type: integer
format: int32
nfs_version_reason:
type: string
nfs_encryption_enabled:
type: boolean
mssql_incremental_export_backup_frequency_minutes:
type: integer
format: int32
truncate_log_on_checkpoint:
type: boolean
durability_level:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/vdbsSortParam'
- $ref: '#/components/parameters/permission'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SearchVDBsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/VDB'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/vdbs/{vdbId}:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
get:
summary: Get a VDB by ID.
operationId: get_vdb_by_id
tags:
- VDBs
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/VDB'
patch:
tags:
- VDBs
summary: Update values of a VDB
operationId: update_vdb_by_id
requestBody:
content:
application/json:
schema:
x-body-name: update_vdb_parameter
$ref: '#/components/schemas/UpdateVDBParameters'
description: The new data to update a VDB.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdateVDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/snapshots:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
get:
summary: List Snapshots for a VDB.
operationId: get_vdb_snapshots
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
tags:
- VDBs
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListSnapshotsResponse'
post:
summary: Snapshot a VDB.
operationId: snapshot_vdb
tags:
- VDBs
responses:
'200':
description: VDB snapshot initiated.
content:
application/json:
schema:
type: object
title: SnapshotVDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/bookmarks:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
get:
summary: List Bookmarks compatible with this VDB.
operationId: get_bookmarks_by_vdb
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/bookmarksSortParam'
tags:
- VDBs
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListBookmarksByVDBResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/Bookmark'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/vdbs/{vdbId}/bookmarks/search:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Search Bookmarks compatible with this VDB.
operationId: search_bookmarks_by_vdb
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/bookmarksSortParam'
tags:
- VDBs
x-filterable:
fields:
id:
type: string
name:
type: string
creation_date:
type: date-time
vdb_ids:
type: array[string]
retention:
type: integer
expiration:
type: date
ss_data_layout_id:
type: string
ss_bookmark_reference:
type: string
ss_bookmark_errors:
type: array[string]
vdbs:
type: array[object]
fields:
vdb_id:
type: string
vdb_name:
type: string
tags:
type: array[object]
fields:
key:
type: string
value:
type: string
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SearchBookmarksByVDBResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/Bookmark'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/vdbs/{vdbId}/deletion-dependencies:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
get:
summary: Get deletion dependencies of a VDB.
operationId: get_vdb_deletion_dependencies
tags:
- VDBs
responses:
'200':
description: Deletion dependencies of a VDB.
content:
application/json:
schema:
$ref: '#/components/schemas/DeletionDependenciesResponse'
/vdbs/{vdbId}/tags:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
tags:
- VDBs
summary: Create tags for a VDB.
operationId: create_vdb_tags
requestBody:
content:
application/json:
schema:
x-body-name: vdb_tags
$ref: '#/components/schemas/TagsRequest'
description: Tags information for VDB.
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
get:
tags:
- VDBs
summary: Get tags for a VDB.
operationId: get_tags_vdb
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
/vdbs/{vdbId}/tags/delete:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
tags:
- VDBs
summary: Delete tags for a VDB.
operationId: delete_vdb_tags
requestBody:
$ref: '#/components/requestBodies/DeleteTags'
responses:
'204':
description: No Content
/vdbs/{vdbId}/start:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Start a VDB.
tags:
- VDBs
operationId: start_vdb
requestBody:
content:
application/json:
schema:
x-body-name: StartVdbParameters
$ref: '#/components/schemas/StartVDBParameters'
required: false
responses:
'200':
description: VDB start initiated.
content:
application/json:
schema:
type: object
title: StartVDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/stop:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Stop a VDB.
tags:
- VDBs
operationId: stop_vdb
requestBody:
content:
application/json:
schema:
x-body-name: StopVdbParameters
$ref: '#/components/schemas/StopVDBParameters'
required: false
responses:
'200':
description: VDB stop initiated.
content:
application/json:
schema:
type: object
title: StopVDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/enable:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Enable a VDB.
tags:
- VDBs
operationId: enable_vdb
requestBody:
content:
application/json:
schema:
x-body-name: enable_vdb_parameter
$ref: '#/components/schemas/EnableVDBParameters'
description: The parameters to enable a VDB.
responses:
'200':
description: VDB enable initiated.
content:
application/json:
schema:
type: object
title: EnableVDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/disable:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Disable a VDB.
tags:
- VDBs
operationId: disable_vdb
requestBody:
content:
application/json:
schema:
x-body-name: disable_vdb_parameter
$ref: '#/components/schemas/DisableVDBParameters'
description: The parameters to disable a VDB.
responses:
'200':
description: VDB disable initiated.
content:
application/json:
schema:
type: object
title: DisableVDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/migrate:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Migrate a VDB.
tags:
- VDBs
operationId: migrate_vdb
requestBody:
content:
application/json:
schema:
x-body-name: migrate_vdb_parameter
$ref: '#/components/schemas/MigrateVDBParameters'
description: The parameters to migrate a VDB.
responses:
'200':
description: VDB migrate initiated.
content:
application/json:
schema:
type: object
title: MigrateVDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/migrate_compatible_repositories:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
get:
tags:
- VDBs
summary: Returns a list of compatible repositories for vdb migration.
operationId: get_migrate_compatible_repo
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: MigrateCompatibleEnvironmentsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/Environment'
/vdbs/{vdbId}/restore-from-recycle-bin:
x-internal: true
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Restore a VDB from recycle bin.
tags:
- VDBs
operationId: restore_vdb_from_recycle_bin
responses:
'200':
description: VDB is restored.
content:
application/json:
schema:
$ref: '#/components/schemas/VDB'
/vdbs/{vdbId}/lock:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Lock a VDB.
tags:
- VDBs
operationId: lock_vdb
requestBody:
content:
application/json:
schema:
type: object
title: LockVDBParameters
properties:
account_id:
description: Id of the account on whose behalf this request is being made. Only accounts having LOCK_FOR_OTHER_ACCOUNT permission can lock VDBs on behalf of other accounts. If this property is not specified then the account id of the authenticated user making the request is used.
type: integer
format: int64
description: The parameters to lock a VDB.
required: true
responses:
'200':
description: VDB is locked.
content:
application/json:
schema:
$ref: '#/components/schemas/VDB'
/vdbs/{vdbId}/unlock:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Unlock a VDB.
tags:
- VDBs
operationId: unlock_vdb
responses:
'200':
description: VDB is unlocked.
content:
application/json:
schema:
$ref: '#/components/schemas/VDB'
/vdbs/{vdbId}/delete:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Delete a VDB.
tags:
- VDBs
operationId: delete_vdb
requestBody:
content:
application/json:
schema:
x-body-name: delete_vdb_parameter
$ref: '#/components/schemas/DeleteVDBParameters'
description: The parameters to delete a VDB.
responses:
'200':
description: VDB delete initiated.
content:
application/json:
schema:
type: object
title: DeleteVDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/rollback_by_timestamp:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
deprecated: true
summary: Rollback a VDB by timestamp.
tags:
- VDBs
operationId: rollback_vdb_by_timestamp
requestBody:
content:
application/json:
schema:
x-body-name: rollback_vdb_parameter
$ref: '#/components/schemas/RollbackVDBByTimestampParameters'
description: The parameters to rollback a VDB.
responses:
'200':
description: VDB rollback initiated.
content:
application/json:
schema:
type: object
title: RollbackVDBByTimestampResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/rollback_by_snapshot:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
deprecated: true
summary: Rollback a VDB by snapshot.
tags:
- VDBs
operationId: rollback_vdb_by_snapshot
requestBody:
content:
application/json:
schema:
x-body-name: rollback_vdb_parameter
$ref: '#/components/schemas/RollbackVDBBySnapshotParameters'
description: The parameters to rollback a VDB.
responses:
'200':
description: VDB rollback initiated.
content:
application/json:
schema:
type: object
title: RollbackVDBBySnapshotResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/rollback_from_bookmark:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
deprecated: true
summary: Rollback a VDB from a bookmark with only the same VDB.
tags:
- VDBs
operationId: rollback_vdb_from_bookmark
requestBody:
content:
application/json:
schema:
x-body-name: rollback_vdb_parameter
$ref: '#/components/schemas/RollbackVDBFromBookmarkParameters'
description: The parameters to rollback a VDB.
responses:
'200':
description: VDB rollback initiated.
content:
application/json:
schema:
type: object
title: RollbackVDBFromBookmarkResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/refresh_by_timestamp:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Refresh a VDB by timestamp.
tags:
- VDBs
operationId: refresh_vdb_by_timestamp
requestBody:
content:
application/json:
schema:
x-body-name: refresh_vdb_parameter
$ref: '#/components/schemas/RefreshVDBByTimestampParameters'
description: The parameters to refresh a VDB.
responses:
'200':
description: VDB refresh initiated.
content:
application/json:
schema:
type: object
title: RefreshVDBByTimestampResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/refresh_by_snapshot:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Refresh a VDB by snapshot.
tags:
- VDBs
operationId: refresh_vdb_by_snapshot
requestBody:
content:
application/json:
schema:
x-body-name: refresh_vdb_parameter
$ref: '#/components/schemas/RefreshVDBBySnapshotParameters'
description: The parameters to refresh a VDB.
responses:
'200':
description: VDB refresh initiated.
content:
application/json:
schema:
type: object
title: RefreshVDBBySnapshotResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/refresh_from_bookmark:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Refresh a VDB from bookmark with a single VDB.
tags:
- VDBs
operationId: refresh_vdb_from_bookmark
requestBody:
content:
application/json:
schema:
x-body-name: refresh_vdb_parameter
$ref: '#/components/schemas/RefreshVDBFromBookmarkParameters'
description: The parameters to refresh a VDB.
responses:
'200':
description: VDB refresh initiated.
content:
application/json:
schema:
type: object
title: RefreshVDBFromBookmarkResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/refresh_by_location:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Refresh a VDB by location.
tags:
- VDBs
operationId: refresh_vdb_by_location
requestBody:
content:
application/json:
schema:
x-body-name: refresh_vdb_parameter
$ref: '#/components/schemas/RefreshVDBByLocationParameters'
description: The parameters to refresh a VDB.
responses:
'200':
description: VDB refresh initiated.
content:
application/json:
schema:
type: object
title: RefreshVDBByLocationResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/undo_refresh:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Undo the last refresh operation.
tags:
- VDBs
operationId: undo_refresh
responses:
'200':
description: VDB undo refresh initiated.
content:
application/json:
schema:
type: object
title: UndoRefreshVDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/export_cleanup:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Export cleanup for incremental V2P operation
tags:
- VDBs
operationId: export_cleanup
requestBody:
content:
application/json:
schema:
x-body-name: export_cleanup
$ref: '#/components/schemas/ExportCleanupParameters'
description: Parameters to cleanup VDB created as part of the Incremental V2P
required: true
responses:
'202':
description: Cleanup VDB created as part of the Incremental V2P.
content:
application/json:
schema:
type: object
title: ExportCleanupResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/switch_timeflow:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Switches the current timeflow of a VDB.
tags:
- VDBs
operationId: switch_timeflow
requestBody:
content:
application/json:
schema:
x-body-name: switch_timeflow_parameter
$ref: '#/components/schemas/SwitchTimeflowParameters'
description: The parameters to switch the timeflow of a VDB.
responses:
'200':
description: Switch timeflow initiated.
content:
application/json:
schema:
type: object
title: SwitchTimeflowResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/oracle/{vdbId}/upgrade:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
deprecated: true
summary: Upgrade Oracle VDB
description: This API is marked as deprecated in favour of generalized API '/vdbs/{vdbId}/upgrade'
tags:
- VDBs
operationId: upgrade_oracle_vdb
requestBody:
content:
application/json:
schema:
x-body-name: upgrade_oracle_vdb_parameters
$ref: '#/components/schemas/UpgradeOracleDatabaseParameters'
description: The new API to upgrade Oracle VDB
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpgradeVDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/upgrade:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
post:
summary: Upgrade VDB
tags:
- VDBs
operationId: upgrade_vdb
requestBody:
content:
application/json:
schema:
x-body-name: upgrade_vdb_parameters
$ref: '#/components/schemas/UpgradeDatabaseParameters'
description: The new API to upgrade VDB
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpgradeVDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vdbs/{vdbId}/upgrade_compatible_repositories:
parameters:
- $ref: '#/components/parameters/vdbIdParam'
get:
tags:
- VDBs
summary: Returns a list of compatible repositories for vdb upgrade.
operationId: get_upgrade_compatible_repo_for_vdb
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpgradeCompatibleEnvironmentsResponse
# --- truncated at 32 KB (236 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-vdbs-api-openapi.yml