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

The Environments API from Delphix — 24 operation(s) for environments.

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

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

This API exposes 36 operations across 24 paths, and defines 43 schemas. It is described by OpenAPI 3.0.0, at version 3.28.0.

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

36 operations 24 paths 43 schemas 6 DELETE7 GET5 PATCH17 POST1 PUT

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 Environments 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 36

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

Environments 36
GET
/environments
List all environments.
get_environments 3 params → 200
POST
/environments
Create an environment.
create_environment body → 201
POST
/environments/compatible_repositories_by_snapshot
Get compatible repositories corresponding to the snapshot.
compatible_repositories_by_snapshot body → 200
POST
/environments/compatible_repositories_by_timestamp
Get compatible repositories corresponding to the timestamp.
compatible_repositories_by_timestamp body → 200
POST
/environments/compatible_repositories_from_bookmark
Get compatible repositories corresponding to the bookmark.
compatible_repositories_from_bookmark body → 200
POST
/environments/compatible_repositories_by_location
Get compatible repositories corresponding to the location.
compatible_repositories_by_location body → 200
PATCH
/environments/{environmentId}/repository/{repositoryId}
Update a Repository.
update_repository 2 params body → 202
DELETE
/environments/{environmentId}/repository/{repositoryId}
Delete a repository.
delete_repository 2 params → 200
POST
/environments/{environmentId}/repository
Create a repository.
create_repository 1 param body → 201
POST
/environments/{environmentId}/hosts
Create a new Host.
create_host 1 param body → 201
PATCH
/environments/{environmentId}/hosts/{hostId}
Update a Host.
update_host 2 params body → 202
DELETE
/environments/{environmentId}/hosts/{hostId}
Delete a Host.
delete_host 2 params → 202
POST
/environments/{environmentId}/tags
Create tags for an Environment.
create_environment_tags 1 param body → 201
GET
/environments/{environmentId}/tags
Get tags for an Environment.
get_tags_environment 1 param → 200
POST
/environments/{environmentId}/tags/delete
Delete tags for an Environment.
delete_environment_tags 1 param body → 204
GET
/environments/{environmentId}
Returns an environment by ID.
get_environment_by_id 1 param → 200
DELETE
/environments/{environmentId}
Delete an environment by ID.
delete_environment 1 param → 200
PATCH
/environments/{environmentId}
Update an environment by ID.
update_environment 1 param body → 200
POST
/environments/search
Search for environments.
search_environments 3 params body → 200
POST
/environments/{environmentId}/enable
Enable a disabled environment.
enable_environment 1 param → 200
POST
/environments/{environmentId}/disable
Disable environment.
disable_environment 1 param → 200
POST
/environments/{environmentId}/refresh
Refresh environment.
refresh_environment 1 param → 200
POST
/environments/{environmentId}/users
Create environment user.
create_environment_user 1 param body → 201
GET
/environments/{environmentId}/users
List environment users.
list_environment_users 1 param → 200
PUT
/environments/{environmentId}/users/{userRef}
Update environment user.
update_environment_user 2 params body → 200
DELETE
/environments/{environmentId}/users/{userRef}
Delete environment user.
delete_environment_user 2 params → 200
POST
/environments/{environmentId}/users/{userRef}/primary
Set primary environment user.
primary_environment_user 2 params → 200
POST
/environments/{environmentId}/listeners
Create Oracle listener.
create_oracle_listener 1 param body → 201
PATCH
/environments/{environmentId}/listeners/{listenerId}
Update an Oracle listener.
update_oracle_listener 2 params body → 200
DELETE
/environments/{environmentId}/listeners/{listenerId}
Delete an Oracle listener.
delete_oracle_listener 2 params → 200
GET
/environments/hosts/{hostId}
Fetch an environment host by host id.
get_host_by_id 1 param → 200
GET
/environments/hosts/{hostId}/okv-clients
List OKV clients running on the specified host.
list_okv_clients 1 param → 200
POST
/environments/hosts/{hostId}/okv-clients
Create an OKV Client for the specific host.
create_okv_client 1 param body → 201
GET
/environments/hosts/okv-clients/{okvClientId}
Fetch an OKV Client by okvClient id.
get_okv_client_by_id 1 param → 200404
DELETE
/environments/hosts/okv-clients/{okvClientId}
Delete an OKV Client
delete_okv_client 1 param → 200
PATCH
/environments/hosts/okv-clients/{okvClientId}
Update an OKV Client.
update_okv_client 1 param body → 200

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are EnvironmentCreateParameters (54 properties), Host (37 properties), Repository (35 properties), Environment (30 properties). Each schema is shown below with its type and property counts.

Host
object
A physical/virtual server.
37 properties
Tag
object
2 properties 2 required
EnvironmentUser
object
14 properties
MSSQLListenerTypeEnum
string
OkvClient
object
8 properties
OracleListenerTypeEnum
string
VirtualizationTaskEvent
object
1 property
Environment
object
A grouping of a single host or a cluster of hosts.
30 properties
MSSQLClusterListener
object
4 properties
Engine
object
2 properties
UpdateRepositoryParameters
object
13 properties 1 required
EnvironmentUserParams
object
17 properties
CreateOracleListenerParams
object
4 properties 1 required
PaginatedResponseMetadata
object
3 properties
UpdateOracleListenerParams
object
2 properties
BookmarkCompatibleRepositoryRequest
object
2 properties 1 required
OracleVirtualIP
object
A virtual IP address.
3 properties
EnvironmentCreateParameters
object
54 properties 3 required
JobTaskEvent
object
1 property
LocationCompatibleRepositoryRequest
object
5 properties
DeleteTag
object
3 properties
JobTask
object
8 properties
HostUpdateParameters
object
20 properties
TagsRequest
object
1 property 1 required
Error
object
2 properties
SnapshotCompatibleRepositoryRequest
object
4 properties
OracleListener
object
7 properties
CreateRepositoryParams
1 required
Errors
array
Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. The Errors object contains information about full or p…
SearchBody
object
Search body.
1 property
HostCreateParameters
object
16 properties 1 required
DbVaultCredentials
object
10 properties
Repository
object
35 properties
ListEnvironmentUsers
object
1 property
VirtualizationTask
object
8 properties
EnvironmentUpdateParameters
object
24 properties
TagsResponse
object
1 property
OracleClusterNodeInstance
object
An oracle cluster node instance.
3 properties
TimestampCompatibleRepositoryRequest
object
5 properties
UpdateOkvClientParameters
object
3 properties
CreateOkvClientParameters
object
3 properties 2 required
SSHVerificationStrategy
object
Mechanism to use for ssh host verification.
5 properties 1 required
Job
object
An asynchronous task.
25 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

delphix-environments-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 Environments 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.