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

The Snapshots API from Delphix — 14 operation(s) for snapshots.

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

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

This API exposes 17 operations across 14 paths, and defines 27 schemas. It is described by OpenAPI 3.0.0, at version 3.28.0.

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

17 operations 14 paths 27 schemas 1 DELETE10 GET1 PATCH5 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 Snapshots 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 17

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

Snapshots 17
GET
/snapshots
Retrieve the list of snapshots.
get_snapshots 3 params → 200
GET
/snapshots/{snapshotId}
Get a Snapshot by ID.
get_snapshot_by_id 1 param → 200
PATCH
/snapshots/{snapshotId}
Update values of a Snapshot.
update_snapshot 1 param body → 200
DELETE
/snapshots/{snapshotId}deprecated
Delete a Snapshot.
delete_snapshot 1 param → 200
POST
/snapshots/{snapshotId}/delete
Delete a Snapshot.
delete_snapshot_by_id 1 param body → 200
POST
/snapshots/{snapshotId}/unset_expiration
Unset a Snapshot's expiration, removing expiration and retainforever values for the snapshot.
unset_snapshot_retention 1 param → 200
POST
/snapshots/{snapshotId}/tags
Create tags for a Snapshot.
create_snapshot_tags 1 param body → 201
GET
/snapshots/{snapshotId}/tags
Get tags for a Snapshot.
get_snapshot_tags 1 param → 200
POST
/snapshots/{snapshotId}/tags/delete
Delete tags for a Snapshot.
delete_snapshot_tags 1 param body → 204
POST
/snapshots/search
Search snapshots.
search_snapshots 3 params body → 200
GET
/snapshots/find_by_location
Get the snapshots at this location for a dataset.
find_by_location 2 params → 200
GET
/snapshots/find_by_timestamp
Get the snapshots at this timestamp for a dataset.
find_by_timestamp 2 params → 200
GET
/snapshots/{snapshotId}/timeflow_range
Return the provisionable timeflow range based on a specific snapshot.
get_snapshot_timeflow_range 1 param → 200
GET
/snapshots/{snapshotId}/runtime
Get a runtime object of a snapshot by id
get_snapshot_runtime_by_id 1 param → 200
GET
/snapshots/capacity
Lists capacity metrics for all snapshots of dataset or the engine.
get_snapshots_capacity_data 4 params → 200
GET
/snapshots/shared-space
API to fetch the shared snapshot space.
get_shared_snapshot_space 1 param → 200
GET
/snapshots/{snapshotId}/deletion-dependencies
Get deletion dependencies for a snapshot.
get_snapshot_deletion_dependencies 1 param → 200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are Snapshot (36 properties), Job (25 properties), DeletionDependencyObject (14 properties), SnapshotRuntime (12 properties). Each schema is shown below with its type and property counts.

SnapshotMissingLog
object
Missing Log information
3 properties
Tag
object
2 properties 2 required
SnapshotRuntime
object
Snapshot Runtime information
12 properties
VirtualizationTaskEvent
object
1 property
Engine
object
2 properties
PaginatedResponseMetadata
object
3 properties
UpdateSnapshotParameters
object
Parameters to update the expiration of a Snapshot.
2 properties
JobTaskEvent
object
1 property
DeleteTag
object
3 properties
JobTask
object
8 properties
DeletionDependencyPrerequisiteAction
object
Deletion dependency prerequisite action.
8 properties
TagsRequest
object
1 property 1 required
GetSnapshotDeletionDependenciesResponse
object
The deletion dependencies of a snapshot.
DeletionDependenciesTreeResponse
object
The deletion dependencies of an object which occupies disk space.
2 properties
SnapshotCapacity
object
Snapshot Capacity information
8 properties
DeletionDependencyObjectType
string
Deletion dependency object type.
SearchBody
object
Search body.
1 property
VirtualizationTask
object
8 properties
ListSnapshotsResponse
object
2 properties
TimeflowRange
object
Represents a time range within a timeflow.
8 properties
TagsResponse
object
1 property
DeleteSnapshotParameters
object
Parameters to delete a snapshot.
1 property
Snapshot
object
Virtualization Engine Snapshot of a dSource or VDB.
36 properties
DeletionDependencyObject
object
Deletion dependency object.
14 properties
BaseDeletetionDependenciesResponse
object
Base class for deletion dependencies response.
3 properties
SnapshotCapacityResponse
object
Snapshot Capacity information
2 properties
Job
object
An asynchronous task.
25 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

delphix-snapshots-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 Snapshots 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.