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

The PaaSInstances API from Delphix — 15 operation(s) for paasinstances.

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

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

This API exposes 18 operations across 15 paths, and defines 30 schemas. It is described by OpenAPI 3.0.0, at version 3.28.0.

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

18 operations 15 paths 30 schemas 4 GET1 PATCH13 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 PaaSInstances 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 18

Across 15 paths, the API surfaces 18 operations — 4 GET, 1 PATCH, 13 POST. Each is listed below with its method, path, parameters, and response codes.

PaaSInstances 18
GET
/paas-instances
List all PaaS Instances.
get_paas_instances 4 params → 200
POST
/paas-instances
Provision a new PaaS Instance
provision_paas_instance body → 200
POST
/paas-instances/search
Search for PaaS Instances.
search_paas_instances 4 params body → 200
GET
/paas-instances/{paaSInstanceId}
Get a PaaS Instance by ID.
get_paas_instance_by_id 1 param → 200
PATCH
/paas-instances/{paaSInstanceId}
Update a PaaS Instance.
update_paas_instance 1 param body → 200
POST
/paas-instances/{paaSInstanceId}/delete
Delete a PaaS Instance
delete_paas_instance 1 param body → 202
POST
/paas-instances/{paaSInstanceId}/refresh
Refresh a PaaS Instance
refresh_paas_instance 1 param body → 202
POST
/paas-instances/{paaSInstanceId}/tags
Create tags for a PaaS Instance.
create_paas_instance_tags 1 param body → 201
GET
/paas-instances/{paaSInstanceId}/tags
Get tags for a PaaS Instance.
get_paas_instance_tags 1 param → 200
POST
/paas-instances/{paaSInstanceId}/tags/delete
Delete tags for a PaaS Instance.
delete_paas_instance_tags 1 param body → 204
POST
/paas-instances/provision_from_bookmark
Provision a new PaaS Instance from a bookmark
provision_paas_instance_from_bookmark body → 200
GET
/paas-instances/{paaSInstanceId}/bookmarks
List Bookmarks compatible with this PaaS Instance.
get_bookmarks_by_paas_instance 4 params → 200
POST
/paas-instances/{paaSInstanceId}/bookmarks/search
Search Bookmarks compatible with this PaaS Instance.
search_bookmarks_by_paas_instance 4 params body → 200
POST
/paas-instances/{paaSInstanceId}/refresh_from_bookmark
Refresh a PaaS Instance from a bookmark
refresh_paas_instance_from_bookmark 1 param body → 202
POST
/paas-instances/{paaSInstanceId}/de-provision
De-provision a PaaS Instance, meaning that the instance object will remain in DCT, along with its permissions, tags, snapshots, ... but the instance will no longer be running. If the current instance…
deprovision_paas_instance 1 param → 202
POST
/paas-instances/{paaSInstanceId}/re-provision
Re-provision a PaaS Instance which has previously been de-provisioned. The provision parameters specified at provisioning time will be respected, with the exception of the timestamp or snapshot id to…
reprovision_paas_instance 1 param body → 202
POST
/paas-instances/{paaSInstanceId}/start
Start a PaaS Instance
start_paas_instance 1 param → 202
POST
/paas-instances/{paaSInstanceId}/stop
Stop a PaaS Instance
stop_paas_instance 1 param → 202

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are PaaSInstance (42 properties), Bookmark (33 properties), Job (25 properties), VirtualizationTask (8 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
RefreshPaaSInstanceParameters
object
Parameters to refresh a PaaS Instance.
3 properties
VirtualizationTaskEvent
object
1 property
BookmarkVDBs
object
VDB id and name associated with bookmark.
7 properties
CloudTagsResponse
object
1 property
CloudTag
object
3 properties 2 required
DeletePaaSInstanceParameters
object
Parameters to delete a PaaS Instance.
2 properties
Engine
object
2 properties
ProvisionPaaSInstanceParameters
Parameters to provision a PaaS Instance.
PaginatedResponseMetadata
object
3 properties
JobTaskEvent
object
1 property
JobTask
object
8 properties
BookmarkPaaSInstances
object
PaaS Instance id and name associated with bookmark.
5 properties
RefreshPaaSInstanceFromBookmarkParameters
object
Parameters to refresh a PaaS Instance from bookmark.
1 property 1 required
SearchBody
object
Search body.
1 property
PaaSConnectionEndpoint
object
A structured connection endpoint discovered from a PaaS Instance.
5 properties
PaaSInstance
object
A database instance running in a cloud environment managed by a PaaS service.
42 properties
Replica
object
4 properties
CloudTagsRequest
object
1 property 1 required
VirtualizationTask
object
8 properties
DeleteCloudTag
object
3 properties
Bookmark
object
A Data Control Tower object that references points in time for one or more datasets.
33 properties
UpdatePaaSInstanceParameters
object
Parameters to set, update, or unset PaaS Instance parameters.
6 properties
BookmarkDSources
object
dSource id and name associated with bookmark.
5 properties
ProvisionPaaSInstanceFromBookmarkParameters
Parameters to provision a PaaS Instance from bookmark.
ProvisionPaaSInstanceBaseParameters
object
Base parameters to provision a PaaS Instance.
5 properties
Job
object
An asynchronous task.
25 properties
ReProvisionPaaSInstanceParameters
object
Parameters to re-provision a PaaS Instance.
3 properties
PermissionEnum
string
Type of the permission on DCT object.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

delphix-paasinstances-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 PaaSInstances 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.