Environments

List all environments.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "name" "-name" "namespace" "-namespace" "engine_id" "-engine_id" "enabled" "-enabled" "is_cluster" "-is_cluster"
Example: sort=id
Responses
200

OK

get/environments
Response samples
application/json
{
  • "items": [
    ],
  • "errors": [
    ],
  • "response_metadata": {
    }
}

Create an environment.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The parameters to create an environment.

name
string [ 1 .. 256 ] characters

The name of the environment.

engine_id
required
string

The ID of the Engine onto which to create the environment.

os_name
required
string

Operating system type of the environment.

Enum: "UNIX" "WINDOWS"
is_cluster
boolean
Default: false

Whether the environment to be created is a cluster.

cluster_home
string [ 1 .. 256 ] characters

Absolute path to cluster home drectory. This parameter is mandatory for UNIX cluster environments.

hostname
required
string [ 1 .. 256 ] characters

host address of the machine.

staging_environment
string [ 1 .. 256 ] characters

Id of the connector environment which is used to connect to this source environment. This is mandatory parameter when creating Windows source environments.

connector_port
integer <int32> [ 1 .. 65535 ]

Specify port on which Delphix connector will run. This is mandatory parameter when creating Windows target environments.

connector_authentication_key
string

Unique per Delphix key used to authenticate with the remote Delphix Connector.

is_target
boolean

Whether the environment to be created is a target cluster environment. This property is used only when creating Windows cluster environments.

ssh_port
integer <int64> [ 1 .. 65535 ]
Default: 22

ssh port of the host.

toolkit_path
string [ 1 .. 256 ] characters

The path for the toolkit that resides on the host.

username
string [ 1 .. 256 ] characters

Username of the OS.

password
string [ 1 .. 256 ] characters

Password of the OS.

vault
string [ 1 .. 256 ] characters

The name or reference of the vault from which to read the host credentials.

vault_username
string [ 1 .. 256 ] characters

Delphix display name for the vault user

hashicorp_vault_engine
string [ 1 .. 256 ] characters

Vault engine name where the credential is stored.

hashicorp_vault_secret_path
string [ 1 .. 256 ] characters

Path in the vault engine where the credential is stored.

hashicorp_vault_username_key
string [ 1 .. 256 ] characters

Key for the username in the key-value store.

hashicorp_vault_secret_key
string [ 1 .. 256 ] characters

Key for the password in the key-value store.

cyberark_vault_query_string
string [ 1 .. 256 ] characters

Query to find a credential in the CyberArk vault.

azure_vault_name
string [ 1 .. 256 ] characters

Azure key vault name.

azure_vault_username_key
string [ 1 .. 256 ] characters

Azure vault key for the username in the key-value store.

azure_vault_secret_key
string [ 1 .. 256 ] characters

Azure vault key for the password in the key-value store.

use_kerberos_authentication
boolean

Whether to use kerberos authentication.

use_engine_public_key
boolean

Whether to use public key authentication.

nfs_addresses
Array of strings

array of ip address or hostnames

ase_db_vault_username
string [ 1 .. 256 ] characters

Delphix display name for the vault user

ase_db_username
string [ 1 .. 256 ] characters

username of the SAP ASE database.

ase_db_password
string [ 1 .. 256 ] characters

password of the SAP ASE database.

ase_db_vault
string [ 1 .. 256 ] characters

The name or reference of the vault from which to read the ASE database credentials.

ase_db_hashicorp_vault_engine
string [ 1 .. 256 ] characters

Vault engine name where the credential is stored.

ase_db_hashicorp_vault_secret_path
string [ 1 .. 256 ] characters

Path in the vault engine where the credential is stored.

ase_db_hashicorp_vault_username_key
string [ 1 .. 256 ] characters

Key for the username in the key-value store.

ase_db_hashicorp_vault_secret_key
string [ 1 .. 256 ] characters

Key for the password in the key-value store.

ase_db_cyberark_vault_query_string
string [ 1 .. 256 ] characters

Query to find a credential in the CyberArk vault.

ase_db_use_kerberos_authentication
boolean

Whether to use kerberos authentication for ASE DB discovery.

ase_db_azure_vault_name
string [ 1 .. 256 ] characters

Azure key vault name.

ase_db_azure_vault_username_key
string [ 1 .. 256 ] characters

Azure vault key for the username in the key-value store.

ase_db_azure_vault_secret_key
string [ 1 .. 256 ] characters

Azure vault key for the password in the key-value store.

java_home
string [ 1 .. 256 ] characters

The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used.

dsp_keystore_path
string [ 1 .. 256 ] characters

DSP keystore path.

dsp_keystore_password
string [ 1 .. 256 ] characters

DSP keystore password.

dsp_keystore_alias
string [ 1 .. 256 ] characters

DSP keystore alias.

dsp_truststore_path
string [ 1 .. 256 ] characters

DSP truststore path.

dsp_truststore_password
string [ 1 .. 256 ] characters

DSP truststore password.

description
string [ 1 .. 1024 ] characters

The environment description.

Array of objects (Tag) [ 1 .. 1000 ] items

The tags to be created for this environment.

make_current_account_owner
boolean
Default: true

Whether the account creating this environment must be configured as owner of the environment.

Responses
201

Environment creation initiated

post/environments
Request samples
application/json

The request example is intended for creating Unix standalone environments.

{
  • "name": "oracle-environment",
  • "engine_id": "1",
  • "os_name": "UNIX",
  • "hostname": "db.host.com",
  • "ssh_port": 22,
  • "toolkit_path": "/work",
  • "username": "username",
  • "password": "password",
  • "vault": "my-vault",
  • "hashicorp_vault_engine": "kv",
  • "hashicorp_vault_secret_path": "oracle-env",
  • "hashicorp_vault_username_key": "username",
  • "hashicorp_vault_secret_key": "password",
  • "cyberark_vault_query_string": "Safe=Test;Folder=Test;Object=Test",
  • "azure_vault_name": "azure_vault",
  • "azure_vault_username_key": "username",
  • "azure_vault_secret_key": "secret",
  • "use_kerberos_authentication": true,
  • "use_engine_public_key": true,
  • "nfs_addresses": [
    ],
  • "ase_db_username": "user-123",
  • "ase_db_password": "test",
  • "ase_db_vault": "my-vault",
  • "ase_db_hashicorp_vault_engine": "kv",
  • "ase_db_hashicorp_vault_secret_path": "ase-env",
  • "ase_db_hashicorp_vault_username_key": "username",
  • "ase_db_hashicorp_vault_secret_key": "password",
  • "ase_db_cyberark_vault_query_string": "Safe=Test;Folder=Test;Object=Test",
  • "ase_db_azure_vault_name": "azure_vault",
  • "ase_db_azure_vault_username_key": "username",
  • "ase_db_azure_vault_secret_key": "secret",
  • "ase_db_use_kerberos_authentication": true,
  • "java_home": "/Library/Java/JavaVirtualMachines/jdk/Contents/Home",
  • "dsp_keystore_path": "/tmp/keystore.keystore",
  • "dsp_keystore_password": "temp123",
  • "dsp_keystore_alias": "oracle-env",
  • "dsp_truststore_path": "/tmp/truststore.keystore",
  • "dsp_truststore_password": "truststore123",
  • "description": "Unix Oracle source host",
  • "tags": [
    ]
}
Response samples
application/json
{
  • "job": {
    },
  • "environment_id": "host-environment-1"
}

Get compatible repositories corresponding to the snapshot.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The request to get compatible repositories for provisioning a new VDB by snapshot.

source_data_id
string [ 1 .. 256 ] characters

The ID of the source object (dSource or VDB) to get the compatible repos. All other objects referenced by the parameters must live on the same engine as the source.

engine_id
string [ 1 .. 256 ] characters

The ID of the Engine from where to get the compatible repos. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored.

snapshot_id
string [ 1 .. 256 ] characters

The ID of the snapshot from which to execute the operation.

environment_id
string [ 1 .. 256 ] characters

The ID or name of the target environment.

Responses
200

OK

post/environments/compatible_repositories_by_snapshot
Request samples
application/json
{
  • "source_data_id": "source-123",
  • "engine_id": "engine-123",
  • "snapshot_id": "snapshot-123",
  • "environment_id": "1-UNIX_HOST_ENVIRONMENT-1"
}
Response samples
application/json
{
  • "items": [
    ]
}

Get compatible repositories corresponding to the timestamp.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The request to get compatible repositories for provisioning a new VDB by timestamp.

source_data_id
string [ 1 .. 256 ] characters

The ID of the source object (dSource or VDB) to get the compatible repos. All other objects referenced by the parameters must live on the same engine as the source.

engine_id
string [ 1 .. 256 ] characters

The ID of the Engine from where to get the compatible repos. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored.

timestamp
string <date-time>

The point in time from which to execute the operation. If the timestamp is not set, selects the latest point.

timeflow_id
string [ 1 .. 256 ] characters

ID of the timeflow from which compatible repos need to be fetched, mutually exclusive with source_data_id.

environment_id
string [ 1 .. 256 ] characters

The ID or name of the target environment.

Responses
200

OK

post/environments/compatible_repositories_by_timestamp
Request samples
application/json
{
  • "source_data_id": "source-123",
  • "engine_id": "engine-123",
  • "timestamp": "2021-05-01T08:51:34.148Z",
  • "timeflow_id": "timeflow_123",
  • "environment_id": "1-UNIX_HOST_ENVIRONMENT-1"
}
Response samples
application/json
{
  • "items": [
    ]
}

Get compatible repositories corresponding to the bookmark.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The request to get compatible repositories for provisioning a new VDB by bookmark.

bookmark_id
required
string [ 1 .. 256 ] characters

The ID of the bookmark from which to execute the operation. The bookmark must contain only one VDB.

environment_id
string [ 1 .. 256 ] characters

The ID or name of the target environment.

Responses
200

OK

post/environments/compatible_repositories_from_bookmark
Request samples
application/json
{
  • "bookmark_id": "string",
  • "environment_id": "1-UNIX_HOST_ENVIRONMENT-1"
}
Response samples
application/json
{
  • "items": [
    ]
}

Get compatible repositories corresponding to the location.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The request to get compatible repositories for provisioning a new VDB by location.

source_data_id
string [ 1 .. 256 ] characters

The ID of the source object (dSource or VDB) to get the compatible repos. All other objects referenced by the parameters must live on the same engine as the source.

engine_id
string [ 1 .. 256 ] characters

The ID of the Engine from where to get the compatible repos. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored.

location
string [ 1 .. 256 ] characters

location from where compatible repo to be fetched.

timeflow_id
string [ 1 .. 256 ] characters

ID of the timeflow from which compatible repos need to be fetched.

environment_id
string [ 1 .. 256 ] characters

The ID or name of the target environment.

Responses
200

OK

post/environments/compatible_repositories_by_location
Request samples
application/json
{
  • "source_data_id": "source-123",
  • "engine_id": "engine-123",
  • "location": "string",
  • "timeflow_id": "timeflow_123",
  • "environment_id": "1-UNIX_HOST_ENVIRONMENT-1"
}
Response samples
application/json
{
  • "items": [
    ]
}

Delete a repository.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

repositoryId
required
string [ 1 .. 256 ] characters

The ID of the repository.

Responses
200

OK

delete/environments/{environmentId}/repository/{repositoryId}
Response samples
application/json
{
  • "job": {
    }
}

Update a Repository.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

repositoryId
required
string [ 1 .. 256 ] characters

The ID of the repository.

Request Body schema: application/json
required
database_type
required
string

The database type of this repository.

Enum: "ORACLE" "MSSQL" "ASE" "APPDATA"
allow_provisioning
boolean

Flag indicating whether the repository should be used for provisioning.

is_staging
boolean

Flag indicating whether this repository can be used by the Delphix Engine for internal processing.

version
string

Version of the repository.

oracle_base
string

The Oracle base where database binaries are located.

bits
integer

32 or 64 bits.

Responses
202

OK

patch/environments/{environmentId}/repository/{repositoryId}
Request samples
application/json
{
  • "database_type": "ORACLE",
  • "allow_provisioning": true,
  • "is_staging": true,
  • "version": "string",
  • "oracle_base": "string",
  • "bits": 0
}
Response samples
application/json
{
  • "job": {
    }
}

Create a repository.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

Request Body schema: application/json
required
database_type
required
string

The database type of this repository.

Enum: "ORACLE" "MSSQL"
bits
integer

32 or 64 bits.

Enum: 32 64
installation_home
string [ 1 .. 300 ] characters

The Oracle install or SQL Server instance home.

version
string

Version of the oracle repository or SQL Server instance.

oracle_base
string <= 256 characters

The Oracle base where database binaries are located.

allow_provisioning
boolean
Default: true

Flag indicating whether the repository should be used for provisioning.

is_staging
boolean
Default: false

Flag indicating whether this repository can be used by the Delphix Engine for internal processing.

applied_patches
Array of integers <int64>

List of Oracle patches that have been applied to this Oracle Home.

full_text_installed
boolean

This property determines if the full-text search and semantic search is installed or not (MSSql only).

server_name
string <= 128 characters

The Server Name of the SQL Server instance.

port
integer <int64>

The network port for connecting to the SQL Server instance.

instance_owner
string [ 1 .. 255 ] characters

Account the SQL Server instance is running as.

instance_name
string [ 1 .. 256 ] characters

The name of the SQL Server instance.

Responses
201

Repository creation initiated

post/environments/{environmentId}/repository
Request samples
application/json

The request example is intended for creating a oracle repository.

{
  • "database_type": "ORACLE",
  • "bits": 32,
  • "installation_home": "/u01/app/oracle/product/18.0.0.0/dbhome_1",
  • "version": "18.3.0.0.0"
}
Response samples
application/json
{
  • "job": {
    },
  • "repository_id": "1-ORACLE_INSTALL-15"
}

Create a new Host.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

Request Body schema: application/json
required
name
string non-empty

The name to associate with the host.

hostname
string non-empty

The hostname or IP address of this host.

nfs_addresses
Array of strings

The list of host/IP addresses to use for NFS export.

ssh_port
integer
Default: 22

The port number used to connect to the host via SSH.

privilege_elevation_profile_reference
string non-empty

Reference to a profile for escalating user privileges.

dsp_keystore_alias
string non-empty

The lowercase alias to use inside the user managed DSP keystore.

dsp_keystore_password
string <password> non-empty

The password for the user managed DSP keystore.

dsp_keystore_path
string non-empty

The path to the user managed DSP keystore.

dsp_truststore_password
string <password> non-empty

The password for the user managed DSP truststore.

dsp_truststore_path
string non-empty

The path to the user managed DSP truststore.

java_home
string non-empty

The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used.

toolkit_path
string non-empty

The path for the toolkit that resides on the host.

oracle_jdbc_keystore_password
string <password> non-empty

The password for the user managed Oracle JDBC keystore.

oracle_tde_keystores_root_path
string non-empty

The path to the root of the Oracle TDE keystores artifact directories.

object (SSHVerificationStrategy)

Mechanism to use for ssh host verification.

Array of objects (OracleVirtualIP)

The Virtual IP addresses associated with the OracleClusterNode.

Responses
201

Host Creation initiated

post/environments/{environmentId}/hosts
Request samples
application/json
{
  • "name": "string",
  • "hostname": "db1.host.com",
  • "nfs_addresses": [
    ],
  • "ssh_port": 22,
  • "privilege_elevation_profile_reference": "string",
  • "dsp_keystore_alias": "string",
  • "dsp_keystore_password": "pa$$word",
  • "dsp_keystore_path": "string",
  • "dsp_truststore_password": "pa$$word",
  • "dsp_truststore_path": "string",
  • "java_home": "string",
  • "toolkit_path": "string",
  • "oracle_jdbc_keystore_password": "pa$$word",
  • "oracle_tde_keystores_root_path": "string",
  • "ssh_verification_strategy": {
    },
  • "oracle_cluster_node_virtual_ips": [
    ]
}
Response samples
application/json
{
  • "job": {
    },
  • "cluster_node_id": "ORACLE_CLUSTER_NODE-7"
}

Delete a Host.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

hostId
required
string [ 1 .. 256 ] characters

The ID of the host.

Responses
202

OK

delete/environments/{environmentId}/hosts/{hostId}
Response samples
application/json
{
  • "job": {
    }
}

Update a Host.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

hostId
required
string [ 1 .. 256 ] characters

The ID of the host.

Request Body schema: application/json
required

the parameters to update a host.

hostname
string [ 1 .. 256 ] characters

host address of the machine.

oracle_cluster_node_name
string [ 1 .. 256 ] characters

The name of the associated OracleClusterNode.

oracle_cluster_node_enabled
boolean

Whether the associated OracleClusterNode is enabled.

Array of objects (OracleVirtualIP)

The Virtual IP addresses associated with the OracleClusterNode.

nfs_addresses
Array of strings

array of ip addresses or hostnames

ssh_port
integer <int64> [ 1 .. 65535 ]

ssh port of the host.

toolkit_path
string [ 1 .. 256 ] characters

The path for the toolkit that resides on the host.

java_home
string [ 1 .. 256 ] characters

The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used.

dsp_keystore_path
string [ 1 .. 256 ] characters

DSP keystore path.

dsp_keystore_password
string [ 1 .. 256 ] characters

DSP keystore password.

dsp_keystore_alias
string [ 1 .. 256 ] characters

DSP keystore alias.

dsp_truststore_path
string [ 1 .. 256 ] characters

DSP truststore path.

dsp_truststore_password
string [ 1 .. 256 ] characters

DSP truststore password.

connector_port
integer <int32> [ 1 .. 65535 ]

Specify port on which Delphix connector will run.

oracle_jdbc_keystore_password
string <password> non-empty

The password for the user managed Oracle JDBC keystore.

oracle_tde_keystores_root_path
string non-empty

The path to the root of the Oracle TDE keystores artifact directories.

object (SSHVerificationStrategy)

Mechanism to use for ssh host verification.

connector_authentication_key
string

Unique per Delphix key used to authenticate with the remote Delphix Connector.

Responses
202

OK

patch/environments/{environmentId}/hosts/{hostId}
Request samples
application/json

The request example is intended for updating Unix standalone hosts.

{
  • "hostname": "host.company.co",
  • "java_home": "/Library/Java/JavaVirtualMachines/jdk/Contents/Home",
  • "dsp_keystore_path": "/tmp/keystore.keystore",
  • "dsp_keystore_password": "temp123",
  • "dsp_keystore_alias": "oracle-env",
  • "dsp_truststore_path": "/tmp/truststore.keystore",
  • "dsp_truststore_password": "truststore123",
  • "oracle_jdbc_keystore_password": "secret-pass",
  • "oracle_tde_keystores_root_path": "/keystore/root/path",
  • "ssh_verification_strategy": {
    }
}
Response samples
application/json
{
  • "job": {
    }
}

Get tags for an Environment.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

Responses
200

Ok

get/environments/{environmentId}/tags
Response samples
application/json
{
  • "tags": [
    ]
}

Create tags for an Environment.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

Request Body schema: application/json
required

Tags information for Environment.

required
Array of objects (Tag) [ 1 .. 1000 ] items unique

Array of tags with key value pairs

Responses
201

Created

post/environments/{environmentId}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "tags": [
    ]
}

Delete tags for an Environment.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

Request Body schema: application/json

The parameters to delete tags

key
string [ 1 .. 4000 ] characters

Key of the tag

value
string [ 1 .. 4000 ] characters

Value of the tag

Array of objects (Tag) [ 1 .. 1000 ] items unique

List of tags to be deleted

Responses
204

No Content

post/environments/{environmentId}/tags/delete
Request samples
application/json

Delete all tags for given object - No request body required

{ }

Returns an environment by ID.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

Responses
200

OK

get/environments/{environmentId}
Response samples
application/json
{
  • "id": "environment-123",
  • "name": "Linux Test Host",
  • "namespace_id": "1-NAMESPACE-1",
  • "namespace_name": "test-engine-1",
  • "is_replica": true,
  • "namespace": "NAMESPACE-1",
  • "engine_id": "engine-123",
  • "enabled": true,
  • "is_cluster": false,
  • "cluster_home": "/u01/app/12.2.0.1/grid",
  • "is_windows_target": false,
  • "staging_environment": "1-WINDOWS_HOST-8",
  • "hosts": [
    ],
  • "tags": [
    ],
  • "repositories": [
    ],
  • "listeners": [
    ],
  • "os_type": "UNIX"
}

Delete an environment by ID.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

Responses
200

OK

delete/environments/{environmentId}
Response samples
application/json
{
  • "job": {
    }
}

Update an environment by ID.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

Request Body schema: application/json

the parameters to update an environment

name
string [ 1 .. 256 ] characters

The name of the environment.

staging_environment
string [ 1 .. 256 ] characters

Id of the connector environment which is used to connect to this source environment.

cluster_address
string [ 1 .. 256 ] characters

Address of the cluster. This property can be modified for Windows cluster only.

cluster_home
string [ 1 .. 256 ] characters

Absolute path to cluster home directory. This parameter is for UNIX cluster environments.

ase_db_username
string [ 1 .. 256 ] characters

username of the SAP ASE database.

ase_db_password
string [ 1 .. 256 ] characters

password of the SAP ASE database.

ase_db_vault
string [ 1 .. 256 ] characters

The name or reference of the vault from which to read the ASE database credentials.

ase_db_vault_username
string [ 1 .. 256 ] characters

Delphix display name for the vault user

ase_db_hashicorp_vault_engine
string [ 1 .. 256 ] characters

Vault engine name where the credential is stored.

ase_db_hashicorp_vault_secret_path
string [ 1 .. 256 ] characters

Path in the vault engine where the credential is stored.

ase_db_hashicorp_vault_username_key
string [ 1 .. 256 ] characters

Key for the username in the key-value store.

ase_db_hashicorp_vault_secret_key
string [ 1 .. 256 ] characters

Key for the password in the key-value store.

ase_db_cyberark_vault_query_string
string [ 1 .. 256 ] characters

Query to find a credential in the CyberArk vault.

ase_db_azure_vault_name
string [ 1 .. 256 ] characters

Azure key vault name.

ase_db_azure_vault_username_key
string [ 1 .. 256 ] characters

Azure vault key for the username in the key-value store.

ase_db_azure_vault_secret_key
string [ 1 .. 256 ] characters

Azure vault key for the password in the key-value store.

ase_db_use_kerberos_authentication
boolean

Whether to use kerberos authentication for ASE DB discovery.

description
string [ 1 .. 1024 ] characters

The environment description.

Responses
200

OK

patch/environments/{environmentId}
Request samples
application/json

The request example is intended for updating Unix standalone environments.

{
  • "name": "oracle-environment",
  • "ase_db_username": "user-123",
  • "ase_db_password": "test",
  • "ase_db_vault": "my-vault",
  • "ase_db_hashicorp_vault_engine": "kv",
  • "ase_db_hashicorp_vault_secret_path": "ase-env",
  • "ase_db_hashicorp_vault_username_key": "username",
  • "ase_db_hashicorp_vault_secret_key": "password",
  • "ase_db_cyberark_vault_query_string": "Safe=Test;Folder=Test;Object=Test",
  • "ase_db_use_kerberos_authentication": true,
  • "description": "Unix Oracle source host"
}
Response samples
application/json
{
  • "job": {
    }
}

Search for environments.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "name" "-name" "namespace" "-namespace" "engine_id" "-engine_id" "enabled" "-enabled" "is_cluster" "-is_cluster"
Example: sort=id
Request Body schema: application/json

A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension.

Filter Expression Overview

Note: All keywords are case-insensitive

Comparison Operators

Operator Description Example
CONTAINS Substring or membership testing for string and list attributes respectively. field3 CONTAINS 'foobar', field4 CONTAINS TRUE
IN Tests if field is a member of a list literal. List can contain a maximum of 100 values field2 IN ['Goku', 'Vegeta']
GE Tests if a field is greater than or equal to a literal value field1 GE 1.2e-2
GT Tests if a field is greater than a literal value field1 GT 1.2e-2
LE Tests if a field is less than or equal to a literal value field1 LE 9000
LT Tests if a field is less than a literal value field1 LT 9.02
NE Tests if a field is not equal to a literal value field1 NE 42
EQ Tests if a field is equal to a literal value field1 EQ 42

Search Operator

The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically SEARCH '12' would match an item with an attribute with an integer value of 123.

Logical Operators

Ordered by precedence.

Operator Description Example
NOT Logical NOT (Right associative) NOT field1 LE 9000
AND Logical AND (Left Associative) field1 GT 9000 AND field2 EQ 'Goku'
OR Logical OR (Left Associative) field1 GT 9000 OR field2 EQ 'Goku'

Grouping

Parenthesis () can be used to override operator precedence.

For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo')

Literal Values

Literal Description Examples
Nil Represents the absence of a value nil, Nil, nIl, NIL
Boolean true/false boolean true, false, True, False, TRUE, FALSE
Number Signed integer and floating point numbers. Also supports scientific notation. 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2
String Single or double quoted "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar'
Datetime Formatted according to RFC3339 2018-04-27T18:39:26.397237+00:00
List Comma-separated literals wrapped in square brackets [0], [0, 1], ['foo', "bar"]

Limitations

  • A maximum of 8 unique identifiers may be used inside a filter expression.
filter_expression
string [ 5 .. 2000 ] characters
Responses
200

OK

post/environments/search
Request samples
application/json

An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0.

{
  • "filter_expression": "repositories CONTAINS {version eq '19.0.0'}"
}
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Enable a disabled environment.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

Responses
200

OK

post/environments/{environmentId}/enable
Response samples
application/json
{
  • "job": {
    }
}

Disable environment.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

Responses
200

OK

post/environments/{environmentId}/disable
Response samples
application/json
{
  • "job": {
    }
}

Refresh environment.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

Responses
200

OK

post/environments/{environmentId}/refresh
Response samples
application/json
{
  • "job": {
    }
}

List environment users.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

Responses
200

OK

get/environments/{environmentId}/users
Response samples
application/json
{
  • "users": [
    ]
}

Create environment user.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

Request Body schema: application/json

The parameters to create an environment user.

username
string [ 1 .. 256 ] characters

Username of the OS.

password
string [ 1 .. 256 ] characters

Password of the OS.

vault
string [ 1 .. 256 ] characters

The name or reference of the vault from which to read the host credentials.

vault_username
string [ 1 .. 256 ] characters

Delphix display name for the vault user

hashicorp_vault_engine
string [ 1 .. 256 ] characters

Vault engine name where the credential is stored.

hashicorp_vault_secret_path
string [ 1 .. 256 ] characters

Path in the vault engine where the credential is stored.

hashicorp_vault_username_key
string [ 1 .. 256 ] characters

Key for the username in the key-value store.

hashicorp_vault_secret_key
string [ 1 .. 256 ] characters

Key for the password in the key-value store.

cyberark_vault_query_string
string [ 1 .. 256 ] characters

Query to find a credential in the CyberArk vault.

azure_vault_name
string [ 1 .. 256 ] characters

Azure key vault name.

azure_vault_username_key
string [ 1 .. 256 ] characters

Azure vault key for the username in the key-value store.

azure_vault_secret_key
string [ 1 .. 256 ] characters

Azure vault key for the password in the key-value store.

use_kerberos_authentication
boolean

Whether to use kerberos authentication.

use_engine_public_key
boolean

Whether to use public key authentication.

Responses
201

Environment user created

post/environments/{environmentId}/users
Request samples
application/json

This example can be used for creating a user with username and password.

{
  • "username": "username-1",
  • "password": "password-1"
}
Response samples
application/json
{
  • "user_ref": "user-reference-1",
  • "job": {
    }
}

Update environment user.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

userRef
required
string non-empty

Environment user reference.

Request Body schema: application/json

The parameters to create an environment user.

username
string [ 1 .. 256 ] characters

Username of the OS.

password
string [ 1 .. 256 ] characters

Password of the OS.

vault
string [ 1 .. 256 ] characters

The name or reference of the vault from which to read the host credentials.

vault_username
string [ 1 .. 256 ] characters

Delphix display name for the vault user

hashicorp_vault_engine
string [ 1 .. 256 ] characters

Vault engine name where the credential is stored.

hashicorp_vault_secret_path
string [ 1 .. 256 ] characters

Path in the vault engine where the credential is stored.

hashicorp_vault_username_key
string [ 1 .. 256 ] characters

Key for the username in the key-value store.

hashicorp_vault_secret_key
string [ 1 .. 256 ] characters

Key for the password in the key-value store.

cyberark_vault_query_string
string [ 1 .. 256 ] characters

Query to find a credential in the CyberArk vault.

azure_vault_name
string [ 1 .. 256 ] characters

Azure key vault name.

azure_vault_username_key
string [ 1 .. 256 ] characters

Azure vault key for the username in the key-value store.

azure_vault_secret_key
string [ 1 .. 256 ] characters

Azure vault key for the password in the key-value store.

use_kerberos_authentication
boolean

Whether to use kerberos authentication.

use_engine_public_key
boolean

Whether to use public key authentication.

Responses
200

OK

put/environments/{environmentId}/users/{userRef}
Request samples
application/json

This example can be used for creating a user with username and password.

{
  • "username": "username-1",
  • "password": "password-1"
}
Response samples
application/json
{
  • "job": {
    }
}

Delete environment user.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

userRef
required
string non-empty

Environment user reference.

Responses
200

OK

delete/environments/{environmentId}/users/{userRef}
Response samples
application/json
{
  • "job": {
    }
}

Set primary environment user.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

userRef
required
string non-empty

Environment user reference.

Responses
200

OK

post/environments/{environmentId}/users/{userRef}/primary
Response samples
application/json
{
  • "job": {
    }
}

Create Oracle listener.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

Request Body schema: application/json

The parameters to create an Oracle listener.

type
required
string (OracleListenerTypeEnum)
Enum: "NODE" "SCAN"
name
string

The name of the Oracle listener.

protocol_addresses
Array of strings

The protocol addresses of the Oracle listener.

host_id
string

The id of the host on which the Oracle listener runs.

Responses
201

Oracle listener created

post/environments/{environmentId}/listeners
Request samples
application/json

This example can be used for creating an Oracle node listener.

{
  • "type": "NODE",
  • "name": "my-listener",
  • "protocol_addresses": [
    ],
  • "host_id": "1-UNIX_HOST-1"
}
Response samples
application/json
{
  • "listener_ref": "ORACLE_NODE_LISTENER-9",
  • "job": {
    }
}

Delete an Oracle listener.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

listenerId
required
string non-empty

Oracle listener id.

Responses
200

OK

delete/environments/{environmentId}/listeners/{listenerId}
Response samples
application/json
{
  • "job": {
    }
}

Update an Oracle listener.

SecurityApiKeyAuth
Request
path Parameters
environmentId
required
string non-empty

The ID of the environment.

listenerId
required
string non-empty

Oracle listener id.

Request Body schema: application/json
required
name
string

The name of the Oracle listener.

protocol_addresses
Array of strings

The protocol addresses of the Oracle listener.

Responses
200

OK

patch/environments/{environmentId}/listeners/{listenerId}
Request samples
application/json
{
  • "name": "my-listener",
  • "protocol_addresses": [
    ]
}
Response samples
application/json
{
  • "job": {
    }
}
➔ Next to Management