openapi: 3.0.0 info: title: Delphix DCT Algorithms Environments 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: Environments paths: /environments: get: summary: List all environments. operationId: get_environments tags: - Environments parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/envSortParam' responses: '200': description: OK content: application/json: schema: type: object title: ListEnvironmentsResponse properties: items: type: array items: $ref: '#/components/schemas/Environment' errors: $ref: '#/components/schemas/Errors' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' post: tags: - Environments summary: Create an environment. operationId: create_environment requestBody: $ref: '#/components/requestBodies/CreateEnvironment' responses: '201': description: Environment creation initiated content: application/json: schema: type: object title: CreateEnvironmentResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. environment_id: type: string description: The id of environment created. example: host-environment-1 /environments/compatible_repositories_by_snapshot: post: summary: Get compatible repositories corresponding to the snapshot. tags: - Environments operationId: compatible_repositories_by_snapshot requestBody: content: application/json: schema: x-body-name: snapshot_compatible_repositories_parameter $ref: '#/components/schemas/SnapshotCompatibleRepositoryRequest' description: The request to get compatible repositories for provisioning a new VDB by snapshot. required: true responses: '200': description: OK content: application/json: schema: type: object title: SnapshotCompatibleEnvironmentsResponse properties: items: type: array items: $ref: '#/components/schemas/Environment' /environments/compatible_repositories_by_timestamp: post: summary: Get compatible repositories corresponding to the timestamp. tags: - Environments operationId: compatible_repositories_by_timestamp requestBody: content: application/json: schema: x-body-name: timestamp_compatible_repositories_parameter $ref: '#/components/schemas/TimestampCompatibleRepositoryRequest' description: The request to get compatible repositories for provisioning a new VDB by timestamp. required: true responses: '200': description: OK content: application/json: schema: type: object title: TimestampCompatibleEnvironmentsResponse properties: items: type: array items: $ref: '#/components/schemas/Environment' /environments/compatible_repositories_from_bookmark: post: summary: Get compatible repositories corresponding to the bookmark. tags: - Environments operationId: compatible_repositories_from_bookmark requestBody: content: application/json: schema: x-body-name: bookmark_compatible_repositories_parameter $ref: '#/components/schemas/BookmarkCompatibleRepositoryRequest' description: The request to get compatible repositories for provisioning a new VDB by bookmark. required: true responses: '200': description: OK content: application/json: schema: type: object title: BookmarkCompatibleEnvironmentsResponse properties: items: type: array items: $ref: '#/components/schemas/Environment' /environments/compatible_repositories_by_location: post: summary: Get compatible repositories corresponding to the location. tags: - Environments operationId: compatible_repositories_by_location requestBody: content: application/json: schema: x-body-name: location_compatible_repositories_parameter $ref: '#/components/schemas/LocationCompatibleRepositoryRequest' description: The request to get compatible repositories for provisioning a new VDB by location. required: true responses: '200': description: OK content: application/json: schema: type: object title: LocationCompatibleEnvironmentsResponse properties: items: type: array items: $ref: '#/components/schemas/Environment' /environments/{environmentId}/repository/{repositoryId}: parameters: - $ref: '#/components/parameters/environmentIdParam' - $ref: '#/components/parameters/repositoryIdParam' patch: tags: - Environments summary: Update a Repository. operationId: update_repository requestBody: content: application/json: schema: x-body-name: update_repository_parameters $ref: '#/components/schemas/UpdateRepositoryParameters' required: true responses: '202': description: OK content: application/json: schema: type: object title: UpdateRepositoryResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. delete: tags: - Environments summary: Delete a repository. operationId: delete_repository responses: '200': description: OK content: application/json: schema: type: object title: RepositoryDeleteJobResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /environments/{environmentId}/repository: parameters: - $ref: '#/components/parameters/environmentIdParam' post: summary: Create a repository. operationId: create_repository tags: - Environments requestBody: content: application/json: schema: x-body-name: create_repository $ref: '#/components/schemas/CreateRepositoryParams' examples: oracle_repository: description: The request example is intended for creating a oracle repository. summary: Oracle - Repository value: database_type: ORACLE bits: 32 installation_home: /u01/app/oracle/product/18.0.0.0/dbhome_1 version: 18.3.0.0.0 mssql_repository: description: The request example is intended for creating a mssql repository. summary: MSSql - Repository value: database_type: MSSQL installation_home: C:/Program Files/Microsoft SQL Server/130 version: 13.2.5233.0 full_text_installed: true instance_owner: qa-ad\delphix instance_name: SQL2016 port: 49854 ase_repository: description: The request example is intended for creating a Sybase ASE repository. summary: ASE - Repository value: database_type: ASE installation_path: /opt/sybase/16-0/install instance_owner: sybase instance_name: ASE160_SRC port: 5500 required: true responses: '201': description: Repository creation initiated content: application/json: schema: type: object title: CreateRepositoryResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. repository_id: type: string description: The id of the created repository. example: 1-ORACLE_INSTALL-15 /environments/{environmentId}/hosts: parameters: - $ref: '#/components/parameters/environmentIdParam' post: tags: - Environments summary: Create a new Host. operationId: create_host requestBody: content: application/json: schema: x-body-name: create_host_parameters $ref: '#/components/schemas/HostCreateParameters' required: true responses: '201': description: Host Creation initiated content: application/json: schema: type: object title: CreateHostResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. cluster_node_id: type: string description: The id of the created cluster node. example: ORACLE_CLUSTER_NODE-7 /environments/{environmentId}/hosts/{hostId}: parameters: - $ref: '#/components/parameters/environmentIdParam' - $ref: '#/components/parameters/hostIdParam' patch: tags: - Environments summary: Update a Host. operationId: update_host requestBody: $ref: '#/components/requestBodies/UpdateHost' responses: '202': description: OK content: application/json: schema: type: object title: UpdateHostResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. delete: tags: - Environments summary: Delete a Host. operationId: delete_host responses: '202': description: OK content: application/json: schema: type: object title: DeleteHostResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /environments/{environmentId}/tags: parameters: - $ref: '#/components/parameters/environmentIdParam' post: tags: - Environments summary: Create tags for an Environment. operationId: create_environment_tags requestBody: content: application/json: schema: x-body-name: environment_tags $ref: '#/components/schemas/TagsRequest' description: Tags information for Environment. required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/TagsResponse' get: tags: - Environments summary: Get tags for an Environment. operationId: get_tags_environment responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/TagsResponse' /environments/{environmentId}/tags/delete: parameters: - $ref: '#/components/parameters/environmentIdParam' post: tags: - Environments summary: Delete tags for an Environment. operationId: delete_environment_tags requestBody: $ref: '#/components/requestBodies/DeleteTags' responses: '204': description: No Content /environments/{environmentId}: parameters: - $ref: '#/components/parameters/environmentIdParam' get: summary: Returns an environment by ID. operationId: get_environment_by_id tags: - Environments responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Environment' delete: summary: Delete an environment by ID. operationId: delete_environment tags: - Environments responses: '200': description: OK content: application/json: schema: type: object title: DeleteEnvironmentResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. patch: summary: Update an environment by ID. operationId: update_environment tags: - Environments requestBody: $ref: '#/components/requestBodies/UpdateEnvironment' responses: '200': description: OK content: application/json: schema: type: object title: UpdateEnvironmentResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /environments/search: post: summary: Search for environments. operationId: search_environments tags: - Environments x-filterable: fields: id: type: string name: type: string namespace: type: string is_cluster: type: boolean address: type: string cluster_home: type: string cluster_name: type: string scan: type: string remote_listener: type: string is_windows_target: type: boolean staging_environment: type: string enabled: type: boolean encryption_enabled: type: boolean description: type: string namespace_id: type: string namespace_name: type: string is_replica: type: boolean engine_id: type: string engine_name: type: string ase_db_user_name: type: string ase_db_credential_type: type: string ase_enable_tls: type: boolean ase_skip_server_certificate_validation: type: boolean hosts: type: array[object] fields: hostname: type: string os_name: type: string os_version: type: string memory_size: type: integer available: type: boolean available_timestamp: type: string not_available_reason: type: string nfs_addresses: type: array[string] dsp_keystore_alias: type: string dsp_keystore_path: type: string dsp_truststore_path: type: string java_home: type: string ssh_port: type: integer toolkit_path: type: string connector_port: type: integer connector_version: type: string connector_dot_net_framework_version: type: string oracle_tde_keystores_root_path: type: string oracle_tde_okv_home_path: type: string processor_type: type: string timezone: type: string powershell_version: type: string release: type: string is_tde_external_key_manager_password_set: type: boolean distribution: type: string tags: type: array[object] fields: key: type: string value: type: string repositories: type: array[object] fields: id: type: string name: type: string database_type: type: string allow_provisioning: type: boolean is_staging: type: boolean oracle_base: type: string version: type: string bits: type: integer install_group: type: string install_user: type: string rac: type: boolean ports: type: array[integer] port: type: integer dump_history_file: type: string page_size: type: integer owner: type: string installation_path: type: string fulltext_installed: type: boolean internal_version: type: integer mssql_cluster_instances_name: type: array[string] mssql_cluster_instances_version: type: array[string] mssql_cluster_instances_owners: type: array[string] mssql_cluster_instances_ports: type: array[string] mssql_cluster_instances_server_names: type: array[string] mssql_cluster_instances_nodes: type: array[string] installation_home: type: string mssql_listeners: type: array[object] fields: type: type: string name: type: string address: type: string port: type: integer database_username: type: string service_principal_name: type: string isql_path: type: string ase_tls_enabled: type: boolean credential_type: type: string listeners: type: array[object] fields: id: type: string namespace: type: string name: type: string client_endpoints: type: array[string] is_discovered: type: boolean host_id: type: string protocol_addresses: type: array[string] env_users: type: array[object] fields: user_ref: type: string username: type: string auth_type: type: string vault: type: string hashicorp_vault_engine: type: string hashicorp_vault_secret_path: type: string hashicorp_vault_username_key: type: string hashicorp_vault_secret_key: type: string cyberark_vault_query_string: type: string azure_vault_name: type: string azure_vault_username_key: type: string azure_vault_secret_key: type: string parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/envSortParam' requestBody: $ref: '#/components/requestBodies/SearchBody' responses: '200': description: OK content: application/json: schema: type: object title: SearchEnvironmentsResponse properties: items: type: array items: $ref: '#/components/schemas/Environment' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /environments/{environmentId}/enable: parameters: - $ref: '#/components/parameters/environmentIdParam' post: tags: - Environments summary: Enable a disabled environment. operationId: enable_environment responses: '200': description: OK content: application/json: schema: type: object title: EnableEnvironmentResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /environments/{environmentId}/disable: parameters: - $ref: '#/components/parameters/environmentIdParam' post: tags: - Environments summary: Disable environment. operationId: disable_environment responses: '200': description: OK content: application/json: schema: type: object title: DisableEnvironmentResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /environments/{environmentId}/refresh: parameters: - $ref: '#/components/parameters/environmentIdParam' post: tags: - Environments summary: Refresh environment. operationId: refresh_environment responses: '200': description: OK content: application/json: schema: type: object title: RefreshEnvironmentResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /environments/{environmentId}/users: parameters: - $ref: '#/components/parameters/environmentIdParam' post: tags: - Environments summary: Create environment user. operationId: create_environment_user requestBody: $ref: '#/components/requestBodies/CreateEnvironmentUserBody' responses: '201': description: Environment user created content: application/json: schema: type: object title: CreateEnvironmentUserResponse properties: user_ref: type: string description: The reference of the created environment user example: user-reference-1 job: $ref: '#/components/schemas/Job' description: The initiated job. get: tags: - Environments summary: List environment users. operationId: list_environment_users responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListEnvironmentUsers' /environments/{environmentId}/users/{userRef}: parameters: - $ref: '#/components/parameters/environmentIdParam' - $ref: '#/components/parameters/userRefParam' put: tags: - Environments summary: Update environment user. operationId: update_environment_user requestBody: $ref: '#/components/requestBodies/CreateEnvironmentUserBody' responses: '200': description: OK content: application/json: schema: type: object title: UpdateEnvironmentUserResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. delete: tags: - Environments summary: Delete environment user. operationId: delete_environment_user responses: '200': description: OK content: application/json: schema: type: object title: DeleteEnvironmentUserResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /environments/{environmentId}/users/{userRef}/primary: parameters: - $ref: '#/components/parameters/environmentIdParam' - $ref: '#/components/parameters/userRefParam' post: tags: - Environments summary: Set primary environment user. operationId: primary_environment_user responses: '200': description: OK content: application/json: schema: type: object title: PrimaryEnvironmentUserResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /environments/{environmentId}/listeners: parameters: - $ref: '#/components/parameters/environmentIdParam' post: tags: - Environments summary: Create Oracle listener. operationId: create_oracle_listener requestBody: $ref: '#/components/requestBodies/CreateOracleListenerBody' responses: '201': description: Oracle listener created content: application/json: schema: type: object title: CreateOracleListenerResponse properties: listener_ref: type: string description: The reference of the created Oracle listener example: ORACLE_NODE_LISTENER-9 job: $ref: '#/components/schemas/Job' description: The initiated job. /environments/{environmentId}/listeners/{listenerId}: parameters: - $ref: '#/components/parameters/environmentIdParam' - $ref: '#/components/parameters/listenerIdParam' patch: tags: - Environments summary: Update an Oracle listener. operationId: update_oracle_listener requestBody: content: application/json: schema: x-body-name: update_oracle_listener_parameters $ref: '#/components/schemas/UpdateOracleListenerParams' required: true responses: '200': description: OK content: application/json: schema: type: object title: UpdateOracleListenerResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. delete: tags: - Environments summary: Delete an Oracle listener. operationId: delete_oracle_listener responses: '200': description: OK content: application/json: schema: type: object title: DeleteOracleListenerResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /environments/hosts/{hostId}: parameters: - $ref: '#/components/parameters/hostIdParam' get: tags: - Environments summary: Fetch an environment host by host id. operationId: get_host_by_id responses: '200': description: Returns a single environment host. content: application/json: schema: $ref: '#/components/schemas/Host' /environments/hosts/{hostId}/okv-clients: parameters: - $ref: '#/components/parameters/hostIdParam' get: tags: - Environments summary: List OKV clients running on the specified host. operationId: list_okv_clients responses: '200': description: OK content: application/json: schema: type: object title: ListOkvClientsResponse properties: items: type: array items: $ref: '#/components/schemas/OkvClient' post: summary: Create an OKV Client for the specific host. operationId: create_okv_client tags: - Environments requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOkvClientParameters' description: The parameters to create an OKV client. required: true responses: '201': description: OKV Client created content: application/json: schema: type: object title: CreateOkvClientResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. okv_client_id: type: string description: The id of the created OKV client. /environments/hosts/okv-clients/{okvClientId}: parameters: - $ref: '#/components/parameters/okvClientIdParam' get: tags: - Environments summary: Fetch an OKV Client by okvClient id. operationId: get_okv_client_by_id responses: '200': description: Returns a single OKV client content: application/json: schema: $ref: '#/components/schemas/OkvClient' '404': description: OKV client not found delete: tags: - Environments summary: Delete an OKV Client operationId: delete_okv_client responses: '200': description: OK content: application/json: schema: type: object title: DeleteOkvClientResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. patch: tags: - Environments summary: Update an OKV Client. operationId: update_okv_client requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOkvClientParameters' required: true responses: '200': description: OK content: application/json: schema: type: object title: UpdateOkvClientResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. okv_client: $ref: '#/components/schemas/OkvClient' description: The OKV client that was updated. components: parameters: userRefParam: in: path name: userRef schema: type: string minLength: 1 required: true description: Environment user reference. envSortParam: name: sort in: query description: The field to sort results by. A property name with a prepended '-' signifies descending order. example: id required: false schema: type: string enum: - id - -id - name - -name - namespace - -namespace - engine_id - -engine_id - engine_name - -engine_name - enabled - -enabled - is_cluster - -is_cluster - cluster_name - -cluster_name - ase_db_user_name - -ase_db_user_name - ase_db_credential_type - -ase_db_credential_type - ase_enable_tls - -ase_enable_tls - ase_skip_server_certificate_validation - -ase_skip_server_certificate_validation nullable: true example: name okvClientIdParam: in: path name: okvClientId schema: type: string minLength: 1 required: true description: The ID of the OKV client. hostIdParam: in: path name: hostId schema: type: string minLength: 1 maxLength: 256 required: true description: The ID of the host. listenerIdParam: in: path name: listenerId schema: type: string minLength: 1 required: true description: Oracle listener id. limit: name: limit in: query description: Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. example: 50 schema: type: integer minimum: 1 maximum: 1000 default: 100 cursor: name: cursor in: query description: 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. schema: type: string minLength: 1 maxLength: 4096 repositoryIdParam: in: path name: repositoryId schema: type: string minLength: 1 maxLength: 256 required: true description: The ID of the repository. environmentIdParam: in: path name: environmentId schema: type: string minLength: 1 required: true description: The ID of the environment. schemas: Host: description: A physical/virtual server. type: object properties: id: description: The entity ID of this Host. type: string minLength: 1 maxLength: 256 example: 3-UNIX_HOST-5 reference: description: Delphix engine equivalent constant type: string example: UNIX_HOST-5 hostname: description: The hostname or IP address of this host. type: string example: linux.dev.delphix.com os_name: description: The name of the OS on this host. type: string example: Linux os_version: description: The version of the OS on this host. type: string example: Red Hat Enterprise Linux Server release 7.3 (Maipo) distribution: description: The name of the OS distribution on this host. type: string example: RedHat memory_size: description: The total amount of memory on this host in bytes. type: integer format: int64 example: 8382160896 available: description: True if the host is up and a connection can be established from the engine. type: boolean example: false available_timestamp: description: The last time the available property was updated. type: string format: date-time example: '2022-06-02T17:49:11.457Z' not_available_reason: description: The reason why the host is not available. type: string example: Failed to connect to host oracle_cluster_node_reference: description: The reference to the associated OracleClusterNode. type: string example: ORACLE_CLUSTER_NODE-1 oracle_cluster_node_name: description: The name of the associated OracleClusterNode. type: string example: my-favorite-cluster-node oracle_cluster_node_enabled: description: Whether the associated OracleClusterNode is enabled. type: boolean example: true oracle_cluster_node_discovered: description: Whether the associated OracleClusterNode was discovered. type: boolean example: true oracle_cluster_node_virtual_ips: description: The Virtual IP addresses associated with the OracleClusterNode. type: array items: $ref: '#/components/schemas/OracleVirtualIP' oracle_cluster_node_instances: description: The instances associated with the OracleClusterNode. type: array items: $ref: '#/components/schemas/OracleClusterNodeInstance' windows_cluster_node_reference: description: The reference to the associated WindowsClusterNode. type: string example: WINDOWS_CLUSTER_NODE-1 windows_cluster_node_name: description: The name of the associated WindowsClusterNode. type: string example: my-favorite-cluster-node windows_cluster_node_discovered: description: Whether the associated Windows cluster node was discovered. type: boolean example: true nfs_addresses: description: The list of host/IP addresses to use for NFS export. type: array items: type: string uniqueItems: true example: - 192.168.10.2 dsp_keystore_alias: description: The lowercase alias to use inside the user managed DSP keystore. type: string minLength: 1 example: oracle-env dsp_keystore_path: description: The path to the user managed DSP keystore. type: string minLength: 1 example: /tmp/keystore.keystore dsp_truststore_path: description: The path to the user managed DSP truststore. type: string minLength: 1 example: /tmp/truststore.keystore java_home: description: The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used. type: string minLength: 1 example: /Library/Java/JavaVirtualMachines/jdk/Contents/Home ssh_port: description: The port number used to connect to the host via SSH. type: integer example: 22 toolkit_path: description: The path for the toolkit that resides on the host. type: string minLength: 1 example: /work connector_port: description: The port that the Windows Connector connects on. type: integer example: 9100 connector_version: description: The Windows Connector version that is installed on the provided host. type: string example: 1.17.0 connector_dot_net_framework_version: description: The .NET Framework version used for Windows Connector Service. type: string example: '3.5' oracle_tde_keystores_root_path: description: The path to the root of the Oracle TDE keystores artifact directories. type: string minLength: 1 example: /keystore/root/path oracle_tde_okv_home_path: description: The path to the Oracle Key Vault library installation on the database node. type: string minLength: 1 example: /work/okv processor_type: description: The platform for the host machine. type: string example: x86_64 timezone: description: The OS timezone. type: string example: America/New_York,EST-0500 powershell_version: description: The PowerShell version installed on the windows target host. type: string example: 5.1.17763.134 release: description: The OS release. type: string example: '6.3' trace_route_info: description: Traceroute network hops from host to Delphix Engine. type: string example: 1 <1 ms <1 ms <1 ms 10.110.232.122 is_tde_external_key_manager_password_set: description: True if Oracle TDE External key Manager password is set. type: boolean example: true Tag: type: object required: - key - value properties: key: description: Key of the tag type: string minLength: 1 maxLength: 4000 example: key-1 value: description: Value of the tag type: string minLength: 1 maxLength: 4000 example: value-1 EnvironmentUser: type: object properties: user_ref: description: Environment user reference type: string minLength: 1 maxLength: 4000 example: user-ref-1 username: description: Username of environment user. type: string minLength: 1 maxLength: 4000 example: username-1 primary_user: description: This indicates if this user is primary or not type: boolean example: false auth_type: description: Authentication type of this user. PasswordCredential indicates username and password are used, SystemKeyCredential indicates public key based security credential, KeyPairCredential indicates public key based security credential consisting of a user specified key pair, KerberosCredential indicates Kerberos authentication, CyberArkVaultCredential indicates CyberArk Vault is used and HashiCorpVaultCredential indicates that Hashicorp vault is used for authentication type: string enum: - PasswordCredential - SystemKeyCredential - KeyPairCredential - KerberosCredential - CyberArkVaultCredential - HashiCorpVaultCredential - AzureVaultCredential vault: type: string description: The name or reference of the vault from which to read the host credentials. minLength: 1 maxLength: 256 example: my-vault hashicorp_vault_engine: type: string description: Vault engine name where the credential is stored. minLength: 1 maxLength: 256 example: kv hashicorp_vault_secret_path: type: string description: Path in the vault engine where the credential is stored. minLength: 1 maxLength: 256 example: oracle-env hashicorp_vault_username_key: type: string description: Key for the username in the key-value store. minLength: 1 maxLength: 256 example: username-key hashicorp_vault_secret_key: type: string description: Key for the password in the key-value store. minLength: 1 maxLength: 256 example: secret-key cyberark_vault_query_string: type: string description: Query to find a credential in the CyberArk vault. minLength: 1 maxLength: 256 example: Safe=Test;Folder=Test;Object=Test azure_vault_name: type: string description: Azure key vault name. minLength: 1 maxLength: 256 example: azure_vault azure_vault_username_key: type: string description: Azure vault key for the username in the key-value store. minLength: 1 maxLength: 256 example: username-key azure_vault_secret_key: type: string description: Azure vault key for the password in the key-value store. minLength: 1 maxLength: 256 example: secret-key custom_public_key: type: string description: Public key to be used for authentication minLength: 1 maxLength: 6000 MSSQLListenerTypeEnum: type: string enum: - MSSqlAvailabilityGroupListener - MSSqlFailoverClusterListener example: MSSqlAvailabilityGroupListener OkvClient: type: object properties: id: type: string description: The OKV client ID. example: 1-ORACLE_OKV_CLIENT-1 name: type: string description: The name of this OKV client. example: my-okv-client is_replica: type: boolean description: Is this a replicated OKV client. example: false namespace_id: type: string description: The namespace ID of this OKV client. example: 1-NAMESPACE-1 engine_id: type: string description: The ID of the Engine hosting this OKV client. example: 1 host_id: type: string description: The ID of the Host containing this OKV client. example: 1-UNIX_HOST-1 okv_client_path: type: string description: The path of this OKV client. example: /work/blackbox/okv is_password_set: type: boolean description: Indicates whether the OKV client password is set. example: true OracleListenerTypeEnum: type: string enum: - NODE - SCAN example: NODE VirtualizationTaskEvent: deprecated: true properties: message_details: type: string Environment: description: A grouping of a single host or a cluster of hosts. type: object properties: id: description: The Environment object entity ID. type: string example: environment-123 name: description: The name of this environment. type: string example: Linux Test Host namespace_id: description: The namespace id of this environment. type: string example: 1-NAMESPACE-1 namespace_name: description: The namespace name of this environment. type: string example: test-engine-1 is_replica: description: Is this a replicated object. type: boolean example: true namespace: description: The namespace of this environment for replicated and restored objects. type: string nullable: true example: NAMESPACE-1 engine_id: description: A reference to the Engine that this Environment connection is associated with. type: string example: engine-123 engine_name: description: A reference to the Engine that this Environment connection is associated with. type: string example: engine-123 address: description: The address of this environment. For a standalone environment, this is the address of the host itself; for a clustered environment, it is the address used to perform cluster discovery. type: string example: winsrc1201.dlpxdc.co enabled: description: True if this environment is enabled. type: boolean example: true encryption_enabled: type: boolean description: Flag indicating whether the data transfer is encrypted or not. example: false description: type: string description: The environment description. example: Windows source host is_cluster: description: True if this environment is a cluster of hosts. type: boolean example: false cluster_home: description: Cluster home for RAC environment. type: string example: /u01/app/12.2.0.1/grid cluster_name: description: Cluster name for Oracle RAC environment. type: string example: abc-19990src cluster_user: description: Cluster user for Oracle RAC environment. type: string example: HOST_USER-4 scan: description: The Single Client Access Name of the cluster (11.2 and greater clusters only). type: string example: abc-scan.xyz.com remote_listener: description: The default remote_listener parameter to be used for databases on the cluster. type: string example: remote-listener.xyz.com is_windows_target: description: True if this windows environment is a target environment. type: boolean example: false staging_environment: description: ID of the staging environment. type: string example: 1-WINDOWS_HOST-8 hosts: description: The hosts that are part of this environment. type: array items: $ref: '#/components/schemas/Host' tags: description: The tags to be created for this environment. type: array items: $ref: '#/components/schemas/Tag' repositories: description: Repositories associated with this environment. A Repository typically corresponds to a database installation. type: array items: $ref: '#/components/schemas/Repository' listeners: description: Oracle listeners associated with this environment. type: array items: $ref: '#/components/schemas/OracleListener' os_type: description: The operating system type of this environment. type: string enum: - UNIX - WINDOWS env_users: description: Environment users associated with this environment. type: array items: $ref: '#/components/schemas/EnvironmentUser' ase_db_user_name: description: The username of the SAP ASE database user. type: string ase_db_credential_type: description: The credential type used for the SAP ASE database user. type: string enum: - PasswordCredential - SystemKeyCredential - KeyPairCredential - KerberosCredential - CyberArkVaultCredential - HashiCorpVaultCredential - AzureVaultCredential ase_enable_tls: description: True if SAP ASE environment configured with TLS/SSL to discover the SAP ASE instances. type: boolean example: false ase_skip_server_certificate_validation: description: If True, ASE database connection will skip the server certificate validation during the TLS/SSL handshake. type: boolean MSSQLClusterListener: properties: type: description: Type of this listener. $ref: '#/components/schemas/MSSQLListenerTypeEnum' example: MSSqlAvailabilityGroupListener address: description: The address of the listener. type: string example: ag-w16-tgt-agl.qa-ad.delphix.com name: description: The name of the listener. type: string example: ag-w16-tgt-agl port: description: The port for the listener. type: integer example: 1433 Engine: properties: engine_id: type: string minLength: 1 maxLength: 4000 engine_name: type: string minLength: 1 maxLength: 4000 UpdateRepositoryParameters: required: - database_type properties: allow_provisioning: description: Flag indicating whether the repository should be used for provisioning. type: boolean is_staging: description: Flag indicating whether this repository can be used by the Delphix Engine for internal processing. type: boolean version: description: Version of the repository. type: string oracle_base: description: The Oracle base where database binaries are located. type: string bits: description: 32 or 64 bits. type: integer port: description: The network port for connecting to the SAP ASE or SQL Server instance. type: integer format: int64 instance_owner: description: The username of the account the SAP ASE or SQL Server instance is running as. type: string minLength: 1 maxLength: 255 installation_path: type: string description: The SAP ASE instance home. minLength: 1 maxLength: 300 dump_history_file: description: Fully qualified name of the dump history file. type: string database_username: type: string description: The username of the ASE instance database. minLength: 1 maxLength: 256 example: sybase database_password: x-dct-toolkit-credential-field: true type: string description: The credentials of the ASE instance database user. minLength: 1 maxLength: 256 example: sybase service_principal_name: type: string description: The Kerberos Service Principal Name (SPN) of the database. isql_path: type: string description: The path to the isql binary to use for this SAP ASE instance. EnvironmentUserParams: properties: username: type: string description: Username of the OS. minLength: 1 maxLength: 256 example: oracle password: x-dct-toolkit-credential-field: true type: string description: Password of the OS. minLength: 1 maxLength: 256 example: oracle vault: type: string description: The name or reference of the vault from which to read the host credentials. minLength: 1 maxLength: 256 example: my-vault vault_username: type: string description: Delphix display name for the vault user minLength: 1 maxLength: 256 example: my-vault-user hashicorp_vault_engine: type: string description: Vault engine name where the credential is stored. minLength: 1 maxLength: 256 example: kv hashicorp_vault_secret_path: type: string description: Path in the vault engine where the credential is stored. minLength: 1 maxLength: 256 example: oracle-env hashicorp_vault_username_key: type: string description: Key for the username in the key-value store. minLength: 1 maxLength: 256 example: username hashicorp_vault_secret_key: type: string description: Key for the password in the key-value store. minLength: 1 maxLength: 256 example: secret cyberark_vault_query_string: type: string description: Query to find a credential in the CyberArk vault. minLength: 1 maxLength: 256 example: Safe=Test;Folder=Test;Object=Test azure_vault_name: type: string description: Azure key vault name. minLength: 1 maxLength: 256 example: azure_vault azure_vault_username_key: type: string description: Azure vault key for the username in the key-value store. minLength: 1 maxLength: 256 example: username azure_vault_secret_key: type: string description: Azure vault key for the password in the key-value store. minLength: 1 maxLength: 256 example: secret use_kerberos_authentication: type: boolean description: Whether to use kerberos authentication. example: true use_engine_public_key: type: boolean description: Whether to use public key authentication. example: true use_custom_key_pair: type: boolean description: Whether to use custom private and public key pair for authentication. example: true custom_private_key: type: string description: Private key to be used for authentication minLength: 1 maxLength: 6000 custom_public_key: type: string description: Public key to be used for authentication minLength: 1 maxLength: 6000 CreateOracleListenerParams: type: object required: - type properties: type: description: Type of this listener. $ref: '#/components/schemas/OracleListenerTypeEnum' default: NODE name: type: string description: The name of the Oracle listener. protocol_addresses: type: array description: The protocol addresses of the Oracle listener. items: type: string host_id: type: string description: The id of the host on which the Oracle listener runs. PaginatedResponseMetadata: type: object properties: prev_cursor: description: Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page. type: string next_cursor: description: Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page. type: string total: description: The total number of results. This value may not be provided. type: integer format: int_64 UpdateOracleListenerParams: properties: name: type: string description: The name of the Oracle listener. example: my-listener protocol_addresses: type: array description: The protocol addresses of the Oracle listener. items: type: string example: - (ADDRESS=(PROTOCOL=tcp)(HOST=10.110.197.76)(PORT=1527)) - (ADDRESS=(PROTOCOL=tcp)(HOST=10.110.197.76)(PORT=1528)) BookmarkCompatibleRepositoryRequest: type: object required: - bookmark_id properties: bookmark_id: type: string description: The ID of the bookmark from which to execute the operation. The bookmark must contain only one VDB. minLength: 1 maxLength: 256 environment_id: type: string description: The ID or name of the target environment. minLength: 1 maxLength: 256 example: 1-UNIX_HOST_ENVIRONMENT-1 OracleVirtualIP: description: A virtual IP address. type: object properties: domain_name: description: The domain name for the VirtualIP. type: string minLength: 1 example: virtual.domain.com ip: description: The IP address for this VirtualIP. type: string format: ipv4 example: 192.168.0.1 discovered: description: Whether this VirtualIP was discovered. type: boolean example: true EnvironmentCreateParameters: type: object required: - engine_id - os_name - hostname properties: name: type: string description: The name of the environment. minLength: 1 maxLength: 256 example: oracle-environment engine_id: type: string description: The ID of the Engine onto which to create the environment. example: '12' os_name: type: string description: Operating system type of the environment. enum: - UNIX - WINDOWS example: UNIX is_cluster: type: boolean description: Whether the environment to be created is a cluster. default: false example: true cluster_home: type: string description: Absolute path to cluster home drectory. This parameter is mandatory for UNIX cluster environments. minLength: 1 maxLength: 256 example: /u01/app/19.0.0.0/grid hostname: type: string description: host address of the machine. minLength: 1 maxLength: 256 example: db.host.com staging_environment: type: string description: Id of the connector environment which is used to connect to this source environment. This is mandatory parameter when creating Windows source environments. minLength: 1 maxLength: 256 example: 1-WINDOWS_HOST-1 connector_port: type: integer format: int32 description: Specify port on which Delphix connector will run. This is mandatory parameter when creating Windows target environments. minimum: 1 maximum: 65535 example: 9100 connector_authentication_key: type: string description: Unique per Delphix key used to authenticate with the remote Delphix Connector. example: secret is_target: type: boolean description: Whether the environment to be created is a target cluster environment. This property is used only when creating Windows cluster environments. example: true ssh_port: type: integer format: int64 description: ssh port of the host. minimum: 1 maximum: 65535 default: 22 example: 22 toolkit_path: type: string description: The path for the toolkit that resides on the host. minLength: 1 maxLength: 256 example: /work username: type: string description: Username of the OS. minLength: 1 maxLength: 256 example: oracle password: x-dct-toolkit-credential-field: true type: string description: Password of the OS. minLength: 1 maxLength: 256 example: oracle vault: type: string description: The name or reference of the vault from which to read the host credentials. minLength: 1 maxLength: 256 example: my-vault vault_username: type: string description: Delphix display name for the vault user minLength: 1 maxLength: 256 example: my-vault-user hashicorp_vault_engine: type: string description: Vault engine name where the credential is stored. minLength: 1 maxLength: 256 example: kv hashicorp_vault_secret_path: type: string description: Path in the vault engine where the credential is stored. minLength: 1 maxLength: 256 example: oracle-env hashicorp_vault_username_key: type: string description: Key for the username in the key-value store. minLength: 1 maxLength: 256 example: username hashicorp_vault_secret_key: type: string description: Key for the password in the key-value store. minLength: 1 maxLength: 256 example: secret cyberark_vault_query_string: type: string description: Query to find a credential in the CyberArk vault. minLength: 1 maxLength: 256 example: Safe=Test;Folder=Test;Object=Test azure_vault_name: type: string description: Azure key vault name. minLength: 1 maxLength: 256 example: azure_vault azure_vault_username_key: type: string description: Azure vault key for the username in the key-value store. minLength: 1 maxLength: 256 example: username azure_vault_secret_key: type: string description: Azure vault key for the password in the key-value store. minLength: 1 maxLength: 256 example: secret use_kerberos_authentication: type: boolean description: Whether to use kerberos authentication. example: true use_engine_public_key: type: boolean description: Whether to use public key authentication. example: true use_custom_key_pair: type: boolean description: Whether to use custom private and public key pair for authentication. example: true custom_private_key: type: string description: Private key to be used for authentication minLength: 1 maxLength: 6000 custom_public_key: type: string description: Public key to be used for authentication minLength: 1 maxLength: 6000 nfs_addresses: type: array items: type: string minLength: 1 maxLength: 256 description: array of ip address or hostnames example: - 192.168.10.2 ase_db_vault_username: type: string description: Delphix display name for the vault user minLength: 1 maxLength: 256 example: user-123 ase_db_username: type: string description: username of the SAP ASE database. minLength: 1 maxLength: 256 example: user-123 ase_db_password: x-dct-toolkit-credential-field: true type: string description: password of the SAP ASE database. minLength: 1 maxLength: 256 example: test ase_enable_tls: description: True if you want to discover the SAP ASE instances configured with TLS/SSL. type: boolean example: true ase_skip_server_certificate_validation: description: Only valid for SAP ASE. Setting it to true will skip the server certificate validation during the SSL handshake. Only set it if you do not want to add the required certificate into the Delphix Engine truststore but still want to use the TLS/SSL-enabled database connection. This is not recommended for a production environment as it is less secure. type: boolean example: true ase_db_vault: type: string description: The name or reference of the vault from which to read the ASE database credentials. minLength: 1 maxLength: 256 example: my-vault ase_db_hashicorp_vault_engine: type: string description: Vault engine name where the credential is stored. minLength: 1 maxLength: 256 example: kv ase_db_hashicorp_vault_secret_path: type: string description: Path in the vault engine where the credential is stored. minLength: 1 maxLength: 256 example: oracle-env ase_db_hashicorp_vault_username_key: type: string description: Key for the username in the key-value store. minLength: 1 maxLength: 256 example: username ase_db_hashicorp_vault_secret_key: type: string description: Key for the password in the key-value store. minLength: 1 maxLength: 256 example: secret ase_db_cyberark_vault_query_string: type: string description: Query to find a credential in the CyberArk vault. minLength: 1 maxLength: 256 example: Safe=Test;Folder=Test;Object=Test ase_db_use_kerberos_authentication: type: boolean description: Whether to use kerberos authentication for ASE DB discovery. example: true ase_db_azure_vault_name: type: string description: Azure key vault name. minLength: 1 maxLength: 256 example: azure_vault ase_db_azure_vault_username_key: type: string description: Azure vault key for the username in the key-value store. minLength: 1 maxLength: 256 example: username ase_db_azure_vault_secret_key: type: string description: Azure vault key for the password in the key-value store. minLength: 1 maxLength: 256 example: secret java_home: type: string description: The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used. minLength: 1 maxLength: 256 example: /Library/Java/JavaVirtualMachines/jdk/Contents/Home dsp_keystore_path: type: string description: DSP keystore path. minLength: 1 maxLength: 256 example: /tmp/keystore.keystore dsp_keystore_password: x-dct-toolkit-credential-field: true type: string description: DSP keystore password. minLength: 1 maxLength: 256 example: temp123 dsp_keystore_alias: type: string description: DSP keystore alias. minLength: 1 maxLength: 256 example: oracle-src dsp_truststore_path: type: string description: DSP truststore path. minLength: 1 maxLength: 256 example: /tmp/truststore.keystore dsp_truststore_password: x-dct-toolkit-credential-field: true type: string description: DSP truststore password. minLength: 1 maxLength: 256 example: truststore123 description: type: string description: The environment description. minLength: 1 maxLength: 1024 example: Unix Orcale source host tags: type: array maxItems: 1000 description: The tags to be created for this environment. items: $ref: '#/components/schemas/Tag' minItems: 1 make_current_account_owner: type: boolean default: true description: Whether the account creating this environment must be configured as owner of the environment. JobTaskEvent: properties: message_details: type: string LocationCompatibleRepositoryRequest: type: object properties: source_data_id: type: string description: 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. minLength: 1 maxLength: 256 example: source-123 engine_id: type: string description: 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. minLength: 1 maxLength: 256 example: engine-123 location: type: string description: location from where compatible repo to be fetched. minLength: 1 maxLength: 256 timeflow_id: type: string description: ID of the timeflow from which compatible repos need to be fetched. minLength: 1 maxLength: 256 example: timeflow_123 environment_id: type: string description: The ID or name of the target environment. minLength: 1 maxLength: 256 example: 1-UNIX_HOST_ENVIRONMENT-1 DeleteTag: type: object properties: key: description: Key of the tag type: string minLength: 1 maxLength: 4000 example: key-1 value: description: Value of the tag type: string minLength: 1 maxLength: 4000 example: value-1 tags: description: List of tags to be deleted type: array minItems: 1 maxItems: 1000 uniqueItems: true items: $ref: '#/components/schemas/Tag' JobTask: properties: id: type: string parent_job_id: type: string start_time: type: string format: date-time end_time: type: string format: date-time title: type: string percent_complete: type: integer minimum: 0 maximum: 100 events: type: array items: $ref: '#/components/schemas/JobTaskEvent' status: type: string enum: - PENDING - STARTED - TIMEDOUT - RUNNING - CANCELED - FAILED - SUSPENDED - WAITING - COMPLETED - ABANDONED HostUpdateParameters: type: object properties: hostname: type: string description: host address of the machine. minLength: 1 maxLength: 256 example: db.host.com oracle_cluster_node_name: description: The name of the associated OracleClusterNode. type: string minLength: 1 maxLength: 256 example: my-favorite-cluster-node oracle_cluster_node_enabled: description: Whether the associated OracleClusterNode is enabled. type: boolean example: true oracle_cluster_node_virtual_ips: description: The Virtual IP addresses associated with the OracleClusterNode. type: array items: $ref: '#/components/schemas/OracleVirtualIP' nfs_addresses: type: array items: type: string minLength: 1 maxLength: 256 description: array of ip addresses or hostnames example: - 192.168.10.2 ssh_port: type: integer format: int64 description: ssh port of the host. minimum: 1 maximum: 65535 example: 22 toolkit_path: type: string description: The path for the toolkit that resides on the host. minLength: 1 maxLength: 256 example: /work java_home: type: string description: The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used. maxLength: 256 example: /Library/Java/JavaVirtualMachines/jdk/Contents/Home dsp_keystore_path: type: string description: DSP keystore path. minLength: 1 maxLength: 256 example: /tmp/keystore.keystore dsp_keystore_password: x-dct-toolkit-credential-field: true type: string description: DSP keystore password. minLength: 1 maxLength: 256 example: temp123 dsp_keystore_alias: type: string description: DSP keystore alias. minLength: 1 maxLength: 256 example: oracle-src dsp_truststore_path: type: string description: DSP truststore path. minLength: 1 maxLength: 256 example: /tmp/truststore.keystore dsp_truststore_password: x-dct-toolkit-credential-field: true type: string description: DSP truststore password. minLength: 1 maxLength: 256 example: truststore123 connector_port: type: integer format: int32 description: Specify port on which Delphix connector will run. minimum: 1 maximum: 65535 example: 9100 oracle_jdbc_keystore_password: x-dct-toolkit-credential-field: true description: The password for the user managed Oracle JDBC keystore. type: string format: password minLength: 1 oracle_tde_keystores_root_path: description: The path to the root of the Oracle TDE keystores artifact directories. type: string minLength: 1 ssh_verification_strategy: $ref: '#/components/schemas/SSHVerificationStrategy' connector_authentication_key: type: string description: Unique per Delphix key used to authenticate with the remote Delphix Connector. example: secret oracle_tde_okv_home_path: description: The path to the Oracle Key Vault library installation on the database node. type: string minLength: 1 example: /work/okv oracle_tde_external_key_manager_credential: x-dct-toolkit-credential-field: true description: The credential of the tde keystore external keys management system like Oracle Key Vault or Hardware Security Module. type: string minLength: 1 maxLength: 128 example: password TagsRequest: type: object required: - tags properties: tags: description: Array of tags with key value pairs type: array items: $ref: '#/components/schemas/Tag' minItems: 1 maxItems: 1000 uniqueItems: true Error: type: object properties: message: type: string readOnly: true description: Message providing more detail about the error that occurred, if available. object_name: type: string readOnly: true description: Name of the object affected by the error. SnapshotCompatibleRepositoryRequest: type: object properties: source_data_id: type: string description: 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. minLength: 1 maxLength: 256 example: source-123 engine_id: type: string description: 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. minLength: 1 maxLength: 256 example: engine-123 snapshot_id: type: string description: The ID of the snapshot from which to execute the operation. minLength: 1 maxLength: 256 example: snapshot-123 environment_id: type: string description: The ID or name of the target environment. minLength: 1 maxLength: 256 example: 1-UNIX_HOST_ENVIRONMENT-1 OracleListener: properties: id: description: Id of this listener. type: string example: 1-ORACLE_NODE_LISTENER-11 name: description: Name of this listener. type: string example: my-listener type: description: Type of this listener. $ref: '#/components/schemas/OracleListenerTypeEnum' example: NODE protocol_addresses: description: The list of protocol addresses for this listener. type: array items: type: string example: - (ADDRESS=(PROTOCOL=tcp)(HOST=10.75.59.184)(PORT=4567)) - (ADDRESS=(PROTOCOL=ipc)(KEY=LISTENER)) client_endpoints: description: The list of client endpoints for this listener. type: array items: type: string example: - (ADDRESS=(PROTOCOL=tcp)(HOST=10.75.59.184)(PORT=4567)) is_discovered: description: Whether this listener was automatically discovered or not. type: boolean host_id: description: Id to the host this listener is associated with. type: string example: 1-UNIX_HOST-14 CreateRepositoryParams: required: - database_type allOf: - $ref: '#/components/schemas/DbVaultCredentials' - type: object properties: database_type: description: The database type of this repository. type: string enum: - ORACLE - MSSQL - ASE bits: type: integer description: 32 or 64 bits. enum: - 32 - 64 installation_home: type: string description: The Oracle install or SQL Server instance home. minLength: 1 maxLength: 300 version: type: string description: Version of the oracle repository or SQL Server instance. oracle_base: type: string description: The Oracle base where database binaries are located. maxLength: 256 allow_provisioning: description: Flag indicating whether the repository should be used for provisioning. type: boolean default: true is_staging: description: Flag indicating whether this repository can be used by the Delphix Engine for internal processing. type: boolean default: false applied_patches: type: array description: List of Oracle patches that have been applied to this Oracle Home. items: type: integer format: int64 full_text_installed: description: This property determines if the full-text search and semantic search is installed or not (MSSql only). type: boolean server_name: description: The Server Name of the SQL Server instance. type: string maxLength: 128 port: description: The network port for connecting to the SQL Server instance. type: integer format: int64 instance_owner: description: Account the SQL Server instance is running as. type: string minLength: 1 maxLength: 255 instance_name: description: The name of the SQL Server instance. type: string minLength: 1 maxLength: 256 installation_path: type: string description: The SAP ASE instance home. minLength: 1 maxLength: 300 dump_history_file: description: Fully qualified name of the dump history file. type: string database_username: type: string description: The username of the ASE instance database. minLength: 1 maxLength: 256 example: sybase database_password: x-dct-toolkit-credential-field: true type: string description: The credentials of the ASE instance database user. minLength: 1 maxLength: 256 example: sybase service_principal_name: type: string description: The Kerberos Service Principal Name (SPN) of the database. isql_path: type: string description: The path to the isql binary to use for this SAP ASE instance. Errors: description: 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 partial failures which might have occurred during the request. type: array items: $ref: '#/components/schemas/Error' SearchBody: description: Search body. type: object properties: filter_expression: type: string minLength: 5 maxLength: 50000 example: string_field CONTAINS "over" AND numberic_field GT 9000 OR string_field2 EQ "Goku" HostCreateParameters: required: - address properties: name: description: The name to associate with the host. type: string minLength: 1 hostname: description: The hostname or IP address of this host. type: string minLength: 1 example: db1.host.com nfs_addresses: description: The list of host/IP addresses to use for NFS export. type: array items: type: string minLength: 1 example: - 192.168.10.2 ssh_port: description: The port number used to connect to the host via SSH. type: integer default: 22 example: 22 privilege_elevation_profile_reference: description: Reference to a profile for escalating user privileges. type: string minLength: 1 dsp_keystore_alias: description: The lowercase alias to use inside the user managed DSP keystore. type: string minLength: 1 dsp_keystore_password: x-dct-toolkit-credential-field: true description: The password for the user managed DSP keystore. type: string format: password minLength: 1 dsp_keystore_path: description: The path to the user managed DSP keystore. type: string minLength: 1 dsp_truststore_password: x-dct-toolkit-credential-field: true description: The password for the user managed DSP truststore. type: string format: password minLength: 1 dsp_truststore_path: description: The path to the user managed DSP truststore. type: string minLength: 1 java_home: description: The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used. type: string minLength: 1 toolkit_path: description: The path for the toolkit that resides on the host. type: string minLength: 1 oracle_jdbc_keystore_password: x-dct-toolkit-credential-field: true description: The password for the user managed Oracle JDBC keystore. type: string format: password minLength: 1 oracle_tde_keystores_root_path: description: The path to the root of the Oracle TDE keystores artifact directories. type: string minLength: 1 ssh_verification_strategy: $ref: '#/components/schemas/SSHVerificationStrategy' oracle_cluster_node_virtual_ips: description: The Virtual IP addresses associated with the OracleClusterNode. type: array items: $ref: '#/components/schemas/OracleVirtualIP' DbVaultCredentials: type: object properties: db_vault_username: type: string description: Delphix display name for the vault user. minLength: 1 maxLength: 256 example: my-vault db_vault: type: string description: The name or reference of the vault from which to read the database credentials. minLength: 1 maxLength: 256 example: vault1 db_hashicorp_vault_engine: type: string description: Vault engine name where the credential is stored. minLength: 1 maxLength: 256 example: key-vault/vault-secrets db_hashicorp_vault_secret_path: type: string description: Path in the vault engine where the credential is stored. minLength: 1 maxLength: 256 example: ase-db-cred db_hashicorp_vault_username_key: type: string description: Hashicorp vault key for the username in the key-value store. minLength: 1 maxLength: 256 example: user db_hashicorp_vault_secret_key: type: string description: Hashicorp vault key for the password in the key-value store. minLength: 1 maxLength: 256 example: upword db_azure_vault_name: type: string description: Azure key vault name. minLength: 1 maxLength: 256 example: azure-keyvault db_azure_vault_username_key: type: string description: Azure vault key for the username in the key-value store. minLength: 1 maxLength: 256 example: ase-db-cred-sa-user db_azure_vault_secret_key: type: string description: Azure vault key for the password in the key-value store. minLength: 1 maxLength: 256 example: ase-db-cred-sa-password db_cyberark_vault_query_string: type: string description: Query to find a credential in the CyberArk vault. minLength: 1 maxLength: 256 example: Safe=Test;Object=ase-db-cred Repository: properties: id: description: Entity id of the repository. type: string name: description: Name of the repository. type: string database_type: description: The database type of this repository. type: string allow_provisioning: description: Flag indicating whether the repository should be used for provisioning. type: boolean is_staging: description: Flag indicating whether this repository can be used by the Delphix Engine for internal processing. type: boolean oracle_base: description: The Oracle base where database binaries are located. type: string version: description: Version of the repository. type: string bits: description: 32 or 64 bits. type: integer install_group: description: Group name of the user that owns the install. type: string install_user: description: User name of the user that owns the install. type: string rac: description: Flag indicating whether the install supports Oracle RAC. type: boolean ports: description: The network ports for connecting to the database instance. type: array items: type: integer format: int64 port: description: The network port for connecting to the SQL Server instance. type: integer format: int64 dump_history_file: description: Fully qualified name of the dump history file. type: string page_size: description: Database page size for the SAP ASE instance. type: integer format: int64 owner: description: Account the database server instance is running as. type: string installation_path: description: Directory path where the installation is located. type: string fulltext_installed: description: This property determines if the full-text search and semantic search is installed or not. type: boolean internal_version: description: The internal version is tied to the data format of a database and is used to detect compatibility. type: integer format: int64 mssql_cluster_instances_name: description: MSSQL cluster instances name. type: array items: type: string mssql_cluster_instances_version: description: MSSQL cluster instances version. type: array items: type: string mssql_cluster_instances_owners: description: MSSQL cluster instance owners. type: array items: type: string mssql_cluster_instances_ports: description: MSSQL cluster instances ports. type: array items: type: integer format: int64 mssql_cluster_instances_server_names: description: MSSQL cluster instances server names. type: array items: type: string mssql_cluster_instances_nodes: description: MSSQL cluster instances nodes. type: array items: type: string installation_home: description: Directory where the installation home is located. type: string drive_letter: description: MSSQL failover cluster drive letter. type: array items: type: string discovered: description: Flag indicating whether the repository was automatically discovered. readOnly: true type: boolean mssql_listeners: description: The list of listeners belonging to this repository. type: array items: $ref: '#/components/schemas/MSSQLClusterListener' database_username: type: string description: The username of the ASE instance database. service_principal_name: type: string description: The Kerberos Service Principal Name (SPN) of the database. isql_path: type: string description: The path to the isql binary to use for this SAP ASE instance. ase_tls_enabled: description: True if SAP ASE instance is TLS/SSL enabled. type: boolean credential_type: description: The credential type used for this repository. type: string enum: - PasswordCredential - SystemKeyCredential - KeyPairCredential - KerberosCredential - CyberArkVaultCredential - HashiCorpVaultCredential - AzureVaultCredential toolkit_id: description: The ID of the toolkit associated with this repository(AppData only). type: string discriminator: propertyName: class_type ListEnvironmentUsers: type: object properties: users: description: List of users type: array items: $ref: '#/components/schemas/EnvironmentUser' VirtualizationTask: deprecated: true properties: id: type: string parent_job_id: type: string start_time: type: string format: date-time end_time: type: string format: date-time title: type: string percent_complete: type: integer minimum: 0 maximum: 100 events: type: array items: $ref: '#/components/schemas/VirtualizationTaskEvent' status: type: string enum: - PENDING - STARTED - TIMEDOUT - RUNNING - CANCELED - FAILED - SUSPENDED - WAITING - COMPLETED - ABANDONED EnvironmentUpdateParameters: type: object properties: name: type: string description: The name of the environment. minLength: 1 maxLength: 256 example: oracle-environment staging_environment: type: string description: Id of the connector environment which is used to connect to this source environment. minLength: 1 maxLength: 256 example: 1-WINDOWS_HOST-1 cluster_address: type: string description: Address of the cluster. This property can be modified for Windows cluster only. minLength: 1 maxLength: 256 example: db.host.com cluster_home: type: string description: Absolute path to cluster home directory. This parameter is for UNIX cluster environments. minLength: 1 maxLength: 256 example: /u01/app/19.0.0.0/grid cluster_user: type: string description: A reference of the cluster user. minLength: 1 maxLength: 256 example: HOST_USER-4 scan: type: string maxLength: 256 example: abc-scan.xyz.com remote_listener: type: string maxLength: 256 example: remote-listener.xyz.com ase_db_username: type: string description: username of the SAP ASE database. minLength: 1 maxLength: 256 example: user-123 ase_db_password: x-dct-toolkit-credential-field: true type: string description: password of the SAP ASE database. minLength: 1 maxLength: 256 example: test ase_enable_tls: description: True if you want to discover the SAP ASE instances configured with TLS/SSL. type: boolean example: true ase_skip_server_certificate_validation: description: Setting it to true will skip the server certificate validation during the SSL handshake. Only set it if you do not want to add the required certificate into the Delphix Engine truststore but still want to use the TLS/SSL-enabled database connection. This is not recommended for a production environment as it is less secure. type: boolean example: true ase_db_vault: type: string description: The name or reference of the vault from which to read the ASE database credentials. minLength: 1 maxLength: 256 example: my-vault ase_db_vault_username: type: string description: Delphix display name for the vault user minLength: 1 maxLength: 256 example: user-123 ase_db_hashicorp_vault_engine: type: string description: Vault engine name where the credential is stored. minLength: 1 maxLength: 256 example: kv ase_db_hashicorp_vault_secret_path: type: string description: Path in the vault engine where the credential is stored. minLength: 1 maxLength: 256 example: oracle-env ase_db_hashicorp_vault_username_key: type: string description: Key for the username in the key-value store. minLength: 1 maxLength: 256 example: username ase_db_hashicorp_vault_secret_key: type: string description: Key for the password in the key-value store. minLength: 1 maxLength: 256 example: secret ase_db_cyberark_vault_query_string: type: string description: Query to find a credential in the CyberArk vault. minLength: 1 maxLength: 256 example: Safe=Test;Folder=Test;Object=Test ase_db_azure_vault_name: type: string description: Azure key vault name. minLength: 1 maxLength: 256 example: azure_vault ase_db_azure_vault_username_key: type: string description: Azure vault key for the username in the key-value store. minLength: 1 maxLength: 256 example: username ase_db_azure_vault_secret_key: type: string description: Azure vault key for the password in the key-value store. minLength: 1 maxLength: 256 example: secret ase_db_use_kerberos_authentication: type: boolean description: Whether to use kerberos authentication for ASE DB discovery. example: true encryption_enabled: type: boolean description: Flag indicating whether the data transfer is encrypted or not. example: false description: type: string description: The environment description. minLength: 1 maxLength: 1024 example: Unix Orcale source host TagsResponse: type: object properties: tags: description: Array of tags with key value pairs type: array items: $ref: '#/components/schemas/Tag' OracleClusterNodeInstance: description: An oracle cluster node instance. type: object properties: instance_name: description: The name of this instance. type: string instance_number: type: integer description: The number of this instance. source_id: type: string description: The id of Source this instance belongs to. TimestampCompatibleRepositoryRequest: type: object properties: source_data_id: type: string description: 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. minLength: 1 maxLength: 256 example: source-123 engine_id: type: string description: 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. minLength: 1 maxLength: 256 example: engine-123 timestamp: type: string format: date-time description: The point in time from which to execute the operation. If the timestamp is not set, selects the latest point. example: '2021-05-01T08:51:34.148000+00:00' timeflow_id: type: string description: ID of the timeflow from which compatible repos need to be fetched, mutually exclusive with source_data_id. minLength: 1 maxLength: 256 example: timeflow_123 environment_id: type: string description: The ID or name of the target environment. minLength: 1 maxLength: 256 example: 1-UNIX_HOST_ENVIRONMENT-1 UpdateOkvClientParameters: type: object properties: name: type: string description: The name of this OKV client. example: my-okv-client okv_client_path: type: string description: The path of this OKV client. example: /path-to-wallet-root/okv okv_client_password: x-dct-toolkit-credential-field: true type: string description: The password of this OKV client. A blank string will unset the existing password. maxLength: 128 example: mypwd CreateOkvClientParameters: type: object required: - name - okv_client_path properties: name: type: string description: The name of this OKV client. minLength: 1 maxLength: 256 example: my-okv-client okv_client_path: type: string description: The path of this OKV client. minLength: 1 example: /path-to-wallet-root/okv okv_client_password: x-dct-toolkit-credential-field: true type: string description: The password of this OKV client. minLength: 1 maxLength: 128 example: mypwd SSHVerificationStrategy: description: Mechanism to use for ssh host verification. required: - name properties: name: description: The name of the verification strategy. type: string enum: - RAW_KEY - FINGERPRINT - ACCEPT_ALWAYS key_type: description: The type of SSH key. type: string enum: - RSA - DSA - ECDSA - ED25519 raw_key: description: Base64-encoded ssh key of the host for RAW_KEY verification. type: string minLength: 1 fingerprint_type: description: Hash function for the fingerprint for FINGERPRINT verification. type: string enum: - SHA256 - SHA512 fingerprint: description: Base-64 encoded fingerprint of the ssh key of the host for FINGERPRINT verification. type: string minLength: 1 Job: description: An asynchronous task. type: object properties: id: description: The Job entity ID. type: string example: job-123 status: description: The status of the job. type: string enum: - PENDING - STARTED - TIMEDOUT - RUNNING - CANCELED - FAILED - SUSPENDED - WAITING - COMPLETED - ABANDONED example: RUNNING is_waiting_for_telemetry: description: Indicates that the operations performed by this Job have completed successfully, but the object changes are not yet reflected. This is only set when when the JOB is in STARTED status, with the guarantee that the job will not transition to the FAILED status. Note that this flag will likely be replaced with a new status in future API versions and be deprecated. type: boolean type: description: The type of job being done. type: string example: DB_REFRESH localized_type: description: The i18n translated type of job being done. type: string example: DB Refresh error_details: description: Details about the failure for FAILED jobs. type: string example: Unable to connect to the engine. warning_message: description: Warnings for the job. type: string example: 'Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.' target_id: description: A reference to the job's target. type: string example: vdb-123 target_name: description: A reference to the job's target name. type: string example: vdb start_time: description: The time the job started executing. type: string format: date-time example: '2022-01-02T05:11:24.148000+00:00' update_time: description: The time the job was last updated. type: string format: date-time example: '2022-01-02T06:11:24.148000+00:00' trace_id: description: traceId of the request which created this Job type: string engine_ids: description: IDs of the engines this Job is executing on. type: array items: type: string deprecated: true tags: type: array items: $ref: '#/components/schemas/Tag' engines: type: array items: $ref: '#/components/schemas/Engine' account_id: description: The ID of the account who initiated this job. type: integer example: 1 account_name: description: The account name which initiated this job. It can be either firstname and lastname combination or firstname or lastname or username or email address or Account-. type: string example: User 1 compliance_node_id: description: The ID of the associated compliance node, if applicable. type: string nullable: true compliance_node_name: description: The name of the associated compliance node, if applicable. type: string nullable: true percent_complete: description: Completion percentage of the Job. type: integer minimum: 0 maximum: 100 example: '50' virtualization_tasks: deprecated: true type: array items: $ref: '#/components/schemas/VirtualizationTask' tasks: type: array items: $ref: '#/components/schemas/JobTask' execution_id: description: The ID of the associated masking execution, if any. type: string nullable: true result_type: description: The type of the job result. This is the type of the object present in the result. type: string result: description: The result of the job execution. This is JSON serialized string of the result object whose type is specified by result_type property. type: object discriminator: propertyName: class_type requestBodies: UpdateEnvironment: description: the parameters to update an environment content: application/json: schema: x-body-name: environment $ref: '#/components/schemas/EnvironmentUpdateParameters' examples: unix_standalone: description: 'The request example is intended for updating Unix standalone environments. ' summary: Unix - Standalone Environments value: 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 windows_standalone_target: description: 'The request example is intended for updating Windows standalone target environments. ' summary: Windows - Standalone Target Environments value: name: win-target description: Windows MSSql target host encryption_enabled: false windows_standalone_source: description: 'The request example is intended for updating Windows standalone source environments. ' summary: Windows - Standalone Source Environments value: name: win-source staging_environment: 1-WINDOWS_HOST-1 description: Windows MSSql source host unix_cluster: description: 'The request example is intended for updating Unix cluster environments. ' summary: Unix - Cluster Environments value: name: rac-environment cluster_home: /u01/app/19.0.0.0/grid cluster_node_address: db1.host.com description: Unix rac host scan: abc-scan.xyz.com remote_listener: remote-listener.xyz.com windows_cluster: description: 'The request example is intended for updating Windows cluster environments. ' summary: Windows - Cluster Environments value: name: mssql-cluster cluster_address: db-cluster.host.com cluster_node_address: db1.host.com staging_environment: 1-WINDOWS_HOST-1 description: Windows mssql host CreateEnvironmentUserBody: description: The parameters to create an environment user. content: application/json: schema: x-body-name: environment $ref: '#/components/schemas/EnvironmentUserParams' examples: using_username_password: description: This example can be used for creating a user with username and password. summary: Using Username and Password value: username: username-1 password: password-1 using_hashicorp_vault: description: This example can be used for creating a user with HashiCorp vault. summary: Using HashiCorp Vault value: vault: my-vault vault_username: my-vault-user hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: password using_cyberark: description: This example can be used for creating a user with CyberArk vault. summary: Using CyberArk Vault value: vault: my-vault vault_username: my-vault-user cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test using_azure_vault: description: This example can be used for creating a user with Azure vault. summary: Using HashiCorp Vault value: vault: my-vault vault_username: my-vault-user azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret using_kerberos: description: This example can be used for creating a user with Kerberos Authentication. summary: Using Kerberos Authentication value: use_kerberos_authentication: true using_public_ssh: description: Allow the Delphix Engine to sign on to this host as this user, without specifying a password. Copy the key from engine interface and add it on a new line in the "~/.ssh/authorized_keys" file in the user's home directory on that host. summary: Using Username and Public Key value: use_engine_public_key: true username: username CreateEnvironment: description: The parameters to create an environment. content: application/json: schema: x-body-name: environment $ref: '#/components/schemas/EnvironmentCreateParameters' examples: unix_standalone: description: 'The request example is intended for creating Unix standalone environments. ' summary: Unix - Standalone Environments value: 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: - 192.168.10.2 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: - key: key-1 value: value-1 - key: key-2 value: value-2 windows_standalone_target: description: 'The request example is intended for creating Windows standalone target environments. ' summary: Windows - Standalone Target Environments value: name: win-target engine_id: '1' os_name: WINDOWS hostname: db.host.com connector_port: 9100 connector_authentication_key: secret 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 java_home: /Library/Java/JavaVirtualMachines/jdk/Contents/Home dsp_keystore_path: /tmp/keystore.keystore dsp_keystore_password: temp123 dsp_keystore_alias: target-env dsp_truststore_path: /tmp/truststore.keystore dsp_truststore_password: truststore123 description: Windows MSSql target host tags: - key: key-1 value: value-1 - key: key-2 value: value-2 windows_standalone_source: description: 'The request example is intended for creating Windows standalone source environments. ' summary: Windows - Standalone Source Environments value: name: win-source engine_id: '1' os_name: WINDOWS hostname: db.host.com staging_environment: 1-WINDOWS_HOST-1 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 description: Windows MSSql source host tags: - key: key-1 value: value-1 - key: key-2 value: value-2 unix_cluster: description: 'The request example is intended for creating Unix cluster environments. ' summary: Unix - Cluster Environments value: name: oracle-rac engine_id: '1' os_name: UNIX is_cluster: true cluster_home: /u01/app/19.0.0.0/grid 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: - 192.168.10.2 java_home: /Library/Java/JavaVirtualMachines/jdk/Contents/Home dsp_keystore_path: /tmp/keystore.keystore dsp_keystore_password: temp123 dsp_keystore_alias: oracle-rac dsp_truststore_path: /tmp/truststore.keystore dsp_truststore_password: truststore123 description: Unix Oracle cluster host tags: - key: key-1 value: value-1 - key: key-2 value: value-2 windows_cluster_source: description: 'The request example is intended for creating Windows source cluster environments. ' summary: Windows - Source Cluster Environments value: name: win-cluster engine_id: '1' os_name: WINDOWS is_cluster: true hostname: db.host.com staging_environment: 1-WINDOWS_HOST-1 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 is_target: false description: Windows MSSql source cluster environment tags: - key: key-1 value: value-1 - key: key-2 value: value-2 windows_cluster_target: description: 'The request example is intended for creating Windows target cluster environments. ' summary: Windows - Target Cluster Environments value: name: win-cluster engine_id: '1' os_name: WINDOWS is_cluster: true hostname: db.host.com staging_environment: 1-WINDOWS_HOST-1 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 is_target: true description: Windows MSSql target cluster environment tags: - key: key-1 value: value-1 - key: key-2 value: value-2 required: true SearchBody: x-skip-codegen-attr: description description: '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](https://datatracker.ietf.org/doc/html/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. ' content: application/json: schema: $ref: '#/components/schemas/SearchBody' examples: nested: description: 'An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0. ' summary: Nested Object Comparison value: filter_expression: repositories CONTAINS {version eq '19.0.0'} relative: description: 'An example of a relative comparison testing that field1 has a value which is less than 123. ' summary: Relative comparison value: filter_expression: field1 LE 123 nil: description: 'An example of using nil to test for the absence of a value for field2. ' summary: Absence of an attribute value value: filter_expression: field2 EQ NIL non-nil: description: 'An example of using nil to test for the existence of a value for field2. ' summary: Existence of an attribute value value: filter_expression: field2 NE NIL contains: description: 'An example of using the ''CONTAINS'' operator to check if field2 contains the string ''foo''. If field2 is string valued then this is checking if ''foo'' is a substring of field2. If field2 is a list of strings then this is checking if ''foo'' is a member of the list. ' summary: Use of the CONTAINS operator value: filter_expression: field2 CONTAINS 'foo' in: description: 'An example of using the ''IN'' operator to check if field1 is an element of a list literal. ' summary: Use of the IN operator value: filter_expression: field1 IN [1, 2, 3] search: description: 'An example of using the ''SEARCH'' operator to retrieve all elements for which ''foo'' is a substring of a filterable attribute. ' summary: Use of the SEARCH operator value: filter_expression: SEARCH 'foo' parenthesis: description: 'An example of parenthesis being used to group operators & override operator precedence. ' summary: Overriding operator precedence value: filter_expression: field1 LT 1234 AND (field2 CONTAINS 'foo' OR field3 CONTAINS 'bar') DeleteTags: description: The parameters to delete tags content: application/json: schema: x-body-name: environment $ref: '#/components/schemas/DeleteTag' examples: delete_all_tags: description: Delete all tags for given object - No request body required summary: Delete all tags value: {} delete_tags_by_key: description: Delete all tags for given object with matching key summary: Delete tags by key value: key: key-1 delete_tags_by_key_value: description: Delete tag for given object with matching key and value summary: Delete a tag by key & value value: key: key-1 value: value-1 delete_multiple_tags_by_key_value: description: Delete tags for given list of tags with matching key and value summary: Delete multiple tags by key & value value: tags: - key: key-1 value: value-1 - key: key-2 value: value-2 UpdateHost: description: the parameters to update a host. content: application/json: schema: x-body-name: host $ref: '#/components/schemas/HostUpdateParameters' examples: unix_standalone: description: 'The request example is intended for updating Unix standalone hosts. ' summary: Unix - Standalone Hosts value: 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: name: ACCEPT_ALWAYS oracle_tde_okv_home_path: /work/okv oracle_tde_external_key_manager_credential: password windows_standalone_target: description: 'The request example is intended for updating Windows hosts. ' summary: Windows - Standalone Hosts value: hostname: host.company.co connector_port: 9100 java_home: c:\Program Files\Java dsp_keystore_path: c:\temp\keystore.keystore dsp_keystore_password: temp123 dsp_keystore_alias: target-env dsp_truststore_path: c:\temp\truststore.keystore dsp_truststore_password: truststore123 connector_authentication_key: secret unix_cluster: description: 'The request example is intended for updating Unix cluster hosts. ' summary: Unix - Cluster Environments value: hostname: host.company.co ssh_port: 22 toolkit_path: /work nfs_addresses: - 192.168.10.2 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: name: ACCEPT_ALWAYS oracle_tde_okv_home_path: /work/okv oracle_tde_external_key_manager_credential: password required: true CreateOracleListenerBody: description: The parameters to create an Oracle listener. content: application/json: schema: x-body-name: create_oracle_listener_params $ref: '#/components/schemas/CreateOracleListenerParams' examples: OracleNodeListener: description: This example can be used for creating an Oracle node listener. summary: Creating an Oracle Node Listener value: type: NODE name: my-listener protocol_addresses: - (ADDRESS=(PROTOCOL=tcp)(HOST=10.110.197.76)(PORT=1527)) - (ADDRESS=(PROTOCOL=tcp)(HOST=10.110.197.76)(PORT=1528)) host_id: 1-UNIX_HOST-1 OracleScanListener: description: This example can be used for creating an Oracle scan listener. summary: Creating an Oracle Scan Listener value: type: SCAN name: my-listener protocol_addresses: - (ADDRESS=(PROTOCOL=tcp)(HOST=10.110.197.76)(PORT=1527)) - (ADDRESS=(PROTOCOL=tcp)(HOST=10.110.197.76)(PORT=1528)) securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization