Skip to content

Latest commit

 

History

History
1026 lines (976 loc) · 103 KB

DCT_README.md

File metadata and controls

1026 lines (976 loc) · 103 KB
Raw

dct-api

Delphix DCT API

  • API version: 3.10.0
    • Build date: 2024-04-03T12:02:33.321319+05:30[Asia/Kolkata]
    • Generator version: 7.4.0

Delphix DCT API

For more information, please visit https://support.delphix.com

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.delphix</groupId>
  <artifactId>dct-api</artifactId>
  <version>15.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'dct-api' jar has been published to maven central.
    mavenLocal()       // Needed if the 'dct-api' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.delphix:dct-api:15.0.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/dct-api-15.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.delphix.dct.ApiClient;
import com.delphix.dct.ApiException;
import com.delphix.dct.Configuration;
import com.delphix.dct.auth.*;
import com.delphix.dct.models.*;
import com.delphix.dct.api.AccountsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v3");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    AccountsApi apiInstance = new AccountsApi(defaultClient);
    Long id = 56L; // Long | Numeric ID of the Account.
    ChangePasswordParameter changePasswordParameter = new ChangePasswordParameter(); // ChangePasswordParameter | 
    try {
      apiInstance.changeAccountPassword(id, changePasswordParameter);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountsApi#changeAccountPassword");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to /v3

Class Method HTTP request Description
AccountsApi changeAccountPassword POST /management/accounts/{id}/change_password Change Account Password.
AccountsApi createAccount POST /management/accounts Create a new Account
AccountsApi createAccountTags POST /management/accounts/{id}/tags Create tags for an Account.
AccountsApi deleteAccount DELETE /management/accounts/{id} Delete an Account
AccountsApi deleteAccountTags POST /management/accounts/{id}/tags/delete Delete tags for an Account.
AccountsApi disable POST /management/accounts/{id}/disable Disable an Account.
AccountsApi enableAccount POST /management/accounts/{id}/enable Enable an Account.
AccountsApi getAccount GET /management/accounts/{id} Get an Account by id
AccountsApi getAccountTags GET /management/accounts/{id}/tags Get tags for an Account.
AccountsApi getAccounts GET /management/accounts Returns a list of Accounts
AccountsApi getPasswordPolicies GET /management/accounts/password-policies Returns the password policies
AccountsApi resetAccountPassword POST /management/accounts/{id}/reset_password Reset Account Password.
AccountsApi searchAccounts POST /management/accounts/search Search for Accounts.
AccountsApi updateAccount PUT /management/accounts/{id} Update an Account
AccountsApi updatePasswordPolicies PATCH /management/accounts/password-policies Update password policies.
AlgorithmsApi createAlgorithmRevisionTags POST /algorithms/{algorithmId}/revisions/{revisionId}/tags Create tags for an AlgorithmRevision.
AlgorithmsApi createAlgorithmTags POST /algorithms/{algorithmId}/tags Create tags for an Algorithm.
AlgorithmsApi deleteAlgorithmRevisionTags POST /algorithms/{algorithmId}/revisions/{revisionId}/tags/delete Delete tags for an AlgorithmRevision.
AlgorithmsApi deleteAlgorithmTags POST /algorithms/{algorithmId}/tags/delete Delete tags for an Algorithm.
AlgorithmsApi getAlgorithmById GET /algorithms/{algorithmId} Get an algorithm by ID.
AlgorithmsApi getAlgorithmRevisionById GET /algorithms/{algorithmId}/revisions/{revisionId} Retrieve a specific revision of an algorithm.
AlgorithmsApi getAlgorithmRevisionTags GET /algorithms/{algorithmId}/revisions/{revisionId}/tags Get tags for an AlgorithmRevision.
AlgorithmsApi getAlgorithmRevisions GET /algorithms/{algorithmId}/revisions Retrieve the list of algorithm revisions for the algorithm.
AlgorithmsApi getAlgorithmTags GET /algorithms/{algorithmId}/tags Get tags for an Algorithm.
AlgorithmsApi getAlgorithms GET /algorithms Retrieve the list of algorithms.
AlgorithmsApi searchAlgorithmRevisions POST /algorithms/{algorithmId}/revisions/search Search for algorithm revisions.
AlgorithmsApi searchAlgorithms POST /algorithms/search Search for algorithms.
AlgorithmsApi setAlgorithmPrimaryRevision POST /algorithms/{algorithmId}/revisions/{revisionId}/make-primary Set an algorithm revision to be the primary revision for the algorithm.
AlgorithmsApi updateAlgorithmRevision PATCH /algorithms/{algorithmId}/revisions/{revisionId} Update an algorithm revision
AuthorizationApi addAccessGroupAccountIds POST /access-groups/{accessGroupId}/account-ids Add account ids to an Access group
AuthorizationApi addAccessGroupAccountTags POST /access-groups/{accessGroupId}/tags Add account tags to an Access group
AuthorizationApi addAccessGroupScopes POST /access-groups/{accessGroupId}/scopes Add scopes to an Access group
AuthorizationApi addAlwaysAllowedPermissions POST /access-groups/{accessGroupId}/scopes/{scopeId}/always_allowed_permissions Add always allowed permissions for given object type.
AuthorizationApi addObjectsToAccessGroupScope POST /access-groups/{accessGroupId}/scopes/{scopeId}/objects Add objects to the access group scope.
AuthorizationApi addRolePermissions POST /roles/{roleId}/permissions Add permissions to a role.
AuthorizationApi addTagsToScope POST /access-groups/{accessGroupId}/scopes/{scopeId}/object-tags Add object tags to the access group scope.
AuthorizationApi createAccessGroup POST /access-groups Create a new access group.
AuthorizationApi createRole POST /roles Create custom role
AuthorizationApi createRoleTags POST /roles/{roleId}/tags Create tags for a role.
AuthorizationApi deleteAccessGroup DELETE /access-groups/{accessGroupId} Delete an Access group.
AuthorizationApi deleteAccessGroupScopeObjectTags POST /access-groups/{accessGroupId}/scopes/{scopeId}/object-tags/delete Remove tags from the access group scope.
AuthorizationApi deleteAccessGroupScopeObjects POST /access-groups/{accessGroupId}/scopes/{scopeId}/objects/delete Remove objects from the access group scope.
AuthorizationApi deleteRole DELETE /roles/{roleId} Delete role by ID.
AuthorizationApi deleteRoleTag POST /roles/{roleId}/tags/delete Delete tags for a Role.
AuthorizationApi getAccessGroupById GET /access-groups/{accessGroupId} Returns an Access group by ID.
AuthorizationApi getAccessGroupScope GET /access-groups/{accessGroupId}/scopes/{scopeId} Get access group scope.
AuthorizationApi getAccessGroups GET /access-groups List all access groups.
AuthorizationApi getAllObjectPermissions GET /auth/object-permissions Returns all of the possible permissions for all of the objects.
AuthorizationApi getObjectPermissions GET /auth/permissions/objects/{objectType}/{objectId} Returns permissions for given object.
AuthorizationApi getRoleById GET /roles/{roleId} Returns role by ID.
AuthorizationApi getRoleTags GET /roles/{roleId}/tags Get tags for a Role.
AuthorizationApi getRoles GET /roles List all roles
AuthorizationApi removeAccessGroupAccountId DELETE /access-groups/{accessGroupId}/account-ids/{accountId} Remove the account from the access group.
AuthorizationApi removeAccessGroupAccountTags POST /access-groups/{accessGroupId}/tags/delete Remove account tags from an access group.
AuthorizationApi removeAccessGroupScope DELETE /access-groups/{accessGroupId}/scopes/{scopeId} Remove the scope from the Access group.
AuthorizationApi removeAlwaysAllowedPermissions POST /access-groups/{accessGroupId}/scopes/{scopeId}/always_allowed_permissions/delete Remove always allowed permissions for given object type.
AuthorizationApi removeRolePermissions POST /roles/{roleId}/permissions/delete Remove permissions from a role.
AuthorizationApi searchAccessGroups POST /access-groups/search Search for access groups.
AuthorizationApi searchRoles POST /roles/search Search for roles.
AuthorizationApi updateAccessGroup PATCH /access-groups/{accessGroupId} Update an Access group.
AuthorizationApi updateAccessGroupScope PATCH /access-groups/{accessGroupId}/scopes/{scopeId} Update access group scope.
AuthorizationApi updateRole PATCH /roles/{roleId} Update a Role.
BookmarksApi createBookmark POST /bookmarks Create a bookmark at the current time.
BookmarksApi createBookmarkTags POST /bookmarks/{bookmarkId}/tags Create tags for a Bookmark.
BookmarksApi deleteBookmark DELETE /bookmarks/{bookmarkId} Delete a bookmark.
BookmarksApi deleteBookmarkTags POST /bookmarks/{bookmarkId}/tags/delete Delete tags for a Bookmark.
BookmarksApi getBookmarkById GET /bookmarks/{bookmarkId} Get a bookmark by ID.
BookmarksApi getBookmarkTags GET /bookmarks/{bookmarkId}/tags Get tags for a Bookmark.
BookmarksApi getBookmarks GET /bookmarks List all bookmarks.
BookmarksApi getVdbGroupsByBookmark GET /bookmarks/{bookmarkId}/vdb-groups List VDB Groups compatible with this bookmark.
BookmarksApi searchBookmarks POST /bookmarks/search Search for bookmarks.
BookmarksApi searchVdbGroupsByBookmark POST /bookmarks/{bookmarkId}/vdb-groups/search Search for VDB Groups compatible with this bookmark.
BookmarksApi updateBookmark PATCH /bookmarks/{bookmarkId} Update a bookmark
CdbsApi createCdbTags POST /cdbs/{cdbId}/tags Create tags for a CDB.
CdbsApi deleteCdbTags POST /cdbs/{cdbId}/tags/delete Delete tags for a CDB.
CdbsApi getCdbById GET /cdbs/{cdbId} Get a CDB by ID (Oracle only).
CdbsApi getCdbs GET /cdbs List all CDBs (Oracle only).
CdbsApi getTagsCdb GET /cdbs/{cdbId}/tags Get tags for a CDB.
CdbsApi searchCdbs POST /cdbs/search Search for CDBs (Oracle only).
ConnectivityApi commvaultConnectivityCheck POST /commvault/connectivity/check Tests whether the CommServe host is accessible from the given environment and Commvault agent.
ConnectivityApi connectivityCheck POST /connectivity/check Checks connectivity between an engine and a remote host machine on a given port.
ConnectivityApi databaseConnectivityCheck POST /database/connectivity/check Tests the validity of the supplied database credentials, returning an error if unable to connect to the database.
ConnectivityApi netbackupConnectivityCheck POST /netbackup/connectivity/check Checks whether the specified NetBackup master server and client are able to communicate on the given environment.
ConnectorsApi connectorsTest POST /connectors/{connectorId}/test Checks connectivity between a masking engine and a remote data source.
ConnectorsApi createConnectorTags POST /connectors/{connectorId}/tags Create tags for a Connector.
ConnectorsApi deleteConnectorTag POST /connectors/{connectorId}/tags/delete Delete tags for a Connector.
ConnectorsApi getConnectorById GET /connectors/{connectorId} Retrieve a masking Connector by ID.
ConnectorsApi getConnectorTags GET /connectors/{connectorId}/tags Get tags for a Connector.
ConnectorsApi getConnectors GET /connectors Retrieve the list of masking connectors.
ConnectorsApi searchConnectors POST /connectors/search Search for masking Connectors.
ConnectorsApi updateConnectorById PATCH /connectors/{connectorId} Update a masking Connector by ID.
DSourcesApi createTagsDsource POST /dsources/{dsourceId}/tags Create tags for a dSource.
DSourcesApi deleteDsource POST /dsources/delete Delete the specified dSource.
DSourcesApi deleteTagsDsource POST /dsources/{dsourceId}/tags/delete Delete tags for a dSource.
DSourcesApi disableDsource POST /dsources/{dsourceId}/disable Disable a dSource.
DSourcesApi enableDsource POST /dsources/{dsourceId}/enable Enable a dSource.
DSourcesApi getAppdataDsourceLinkingDefaults POST /dsources/appdata/defaults Get defaults for an AppData dSource linking.
DSourcesApi getAseDsourceLinkingDefaults POST /dsources/ase/defaults Get defaults for an ASE dSource linking.
DSourcesApi getDsourceById GET /dsources/{dsourceId} Get a dSource by ID.
DSourcesApi getDsourceSnapshots GET /dsources/{dsourceId}/snapshots List Snapshots for a dSource.
DSourcesApi getDsources GET /dsources List all dSources.
DSourcesApi getMssqlDsourceLinkingDefaults POST /dsources/mssql/defaults Get defaults for a MSSql dSource linking.
DSourcesApi getMssqlStagingPushDsourceLinkingDefaults POST /dsources/mssql/staging-push/defaults Get defaults for a MSSql staging push dSource linking.
DSourcesApi getOracleDsourceLinkingDefaults POST /dsources/oracle/defaults Get defaults for dSource linking.
DSourcesApi getOracleStagingPushDsourceLinkingDefaults POST /dsources/oracle/staging-push/defaults Get defaults for a Oracle staging push dSource linking.
DSourcesApi getTagsDsource GET /dsources/{dsourceId}/tags Get tags for a dSource.
DSourcesApi linkAppdataDatabase POST /dsources/appdata Link an AppData database as dSource.
DSourcesApi linkAseDatabase POST /dsources/ase Link an ASE database as dSource.
DSourcesApi linkMssqlDatabase POST /dsources/mssql Link a MSSql database as dSource.
DSourcesApi linkMssqlStagingPushDatabase POST /dsources/mssql/staging-push Link a MSSql staging push database as dSource.
DSourcesApi linkOracleDatabase POST /dsources/oracle Link Oracle database as dSource.
DSourcesApi linkOracleStagingPushDatabase POST /dsources/oracle/staging-push Link an Oracle staging push database as dSource.
DSourcesApi searchDsources POST /dsources/search Search for dSources.
DSourcesApi snapshotDsource POST /dsources/{dsourceId}/snapshots Snapshot a dSource.
DatabaseTemplatesApi createDatabaseTemplate POST /database-templates Create a database template.
DatabaseTemplatesApi createDatabaseTemplateTags POST /database-templates/{databaseTemplateId}/tags Create tags for a DatabaseTemplate.
DatabaseTemplatesApi deleteDatabaseTemplate DELETE /database-templates/{databaseTemplateId} Delete a DatabaseTemplate by ID.
DatabaseTemplatesApi deleteDatabaseTemplateTag POST /database-templates/{databaseTemplateId}/tags/delete Delete tags for a DatabaseTemplate.
DatabaseTemplatesApi getDatabaseTemplateById GET /database-templates/{databaseTemplateId} Retrieve a DatabaseTemplate by ID.
DatabaseTemplatesApi getDatabaseTemplateTags GET /database-templates/{databaseTemplateId}/tags Get tags for a DatabaseTemplate.
DatabaseTemplatesApi getDatabaseTemplates GET /database-templates Retrieve the list of database templates.
DatabaseTemplatesApi importDatabaseTemplates POST /database-templates/import Imports the database templates from an an engine.
DatabaseTemplatesApi searchDatabaseTemplates POST /database-templates/search Search DatabaseTemplates.
DatabaseTemplatesApi undoImportDatabaseTemplates POST /database-templates/undo-import Undo an import of DatabaseTemplates on an Engine.
DatabaseTemplatesApi updateDatabaseTemplate PATCH /database-templates/{databaseTemplateId} Updates a DatabaseTemplate by ID
EnvironmentsApi compatibleRepositoriesByLocation POST /environments/compatible_repositories_by_location Get compatible repositories corresponding to the location.
EnvironmentsApi compatibleRepositoriesBySnapshot POST /environments/compatible_repositories_by_snapshot Get compatible repositories corresponding to the snapshot.
EnvironmentsApi compatibleRepositoriesByTimestamp POST /environments/compatible_repositories_by_timestamp Get compatible repositories corresponding to the timestamp.
EnvironmentsApi compatibleRepositoriesFromBookmark POST /environments/compatible_repositories_from_bookmark Get compatible repositories corresponding to the bookmark.
EnvironmentsApi createEnvironment POST /environments Create an environment.
EnvironmentsApi createEnvironmentTags POST /environments/{environmentId}/tags Create tags for an Environment.
EnvironmentsApi createEnvironmentUser POST /environments/{environmentId}/users Create environment user.
EnvironmentsApi createHost POST /environments/{environmentId}/hosts Create a new Host.
EnvironmentsApi deleteEnvironment DELETE /environments/{environmentId} Delete an environment by ID.
EnvironmentsApi deleteEnvironmentTags POST /environments/{environmentId}/tags/delete Delete tags for an Environment.
EnvironmentsApi deleteEnvironmentUser DELETE /environments/{environmentId}/users/{userRef} Delete environment user.
EnvironmentsApi deleteHost DELETE /environments/{environmentId}/hosts/{hostId} Delete a Host.
EnvironmentsApi disableEnvironment POST /environments/{environmentId}/disable Disable environment.
EnvironmentsApi enableEnvironment POST /environments/{environmentId}/enable Enable a disabled environment.
EnvironmentsApi getEnvironmentById GET /environments/{environmentId} Returns an environment by ID.
EnvironmentsApi getEnvironments GET /environments List all environments.
EnvironmentsApi getTagsEnvironment GET /environments/{environmentId}/tags Get tags for an Environment.
EnvironmentsApi listEnvironmentUsers GET /environments/{environmentId}/users List environment users.
EnvironmentsApi primaryEnvironmentUser POST /environments/{environmentId}/users/{userRef}/primary Set primary environment user.
EnvironmentsApi refreshEnvironment POST /environments/{environmentId}/refresh Refresh environment.
EnvironmentsApi searchEnvironments POST /environments/search Search for environments.
EnvironmentsApi updateEnvironment PATCH /environments/{environmentId} Update an environment by ID.
EnvironmentsApi updateEnvironmentUser PUT /environments/{environmentId}/users/{userRef} Update environment user.
EnvironmentsApi updateHost PATCH /environments/{environmentId}/hosts/{hostId} Update a Host.
EnvironmentsApi updateRepository PATCH /environments/{environmentId}/repository/{repositoryId} Update a Repository.
ExecutionsApi cancelExecution POST /executions/{executionId}/cancel Cancel an Execution.
ExecutionsApi cleanupExecution POST /executions/{executionId}/cleanup Cleanup an Execution (Hyperscale only).
ExecutionsApi getExecutionById GET /executions/{executionId} Retrieve an Execution by ID.
ExecutionsApi getExecutionEvents GET /executions/{executionId}/events Retrieve the list of events for a masking execution.
ExecutionsApi getExecutionLog GET /executions/{executionId}/log Retrieve the masking execution log.
ExecutionsApi getExecutions GET /executions Retrieve the list of masking executions.
ExecutionsApi restartExecution POST /executions/{executionId}/restart Restart an Execution (Hyperscale only).
ExecutionsApi searchExecutionEvents POST /executions/{executionId}/events/search Search masking executions events.
ExecutionsApi searchExecutions POST /executions/search Search masking executions.
FeatureFlagApi getEnabledFeaturesFlag GET /enabled-features-flag Get enabled feature flags.
GroupsApi getDatasetGroupById GET /groups/{groupId} Get a dataset group by ID or Name.
GroupsApi getDatasetGroups GET /groups List all dataset groups.
GroupsApi searchDatasetGroups POST /groups/search Search for dataset groups.
HyperscaleInstanceApi addEngineToHyperscaleInstance POST /hyperscale-instances/{hyperscaleInstanceId}/add-engine Add an engine to a Hyperscale Instance.
HyperscaleInstanceApi createHyperscaleInstanceTags POST /hyperscale-instances/{hyperscaleInstanceId}/tags Create tags for a Hyperscale Instance.
HyperscaleInstanceApi deleteHyperscaleInstanceTags POST /hyperscale-instances/{hyperscaleInstanceId}/tags/delete Delete tags for a Hyperscale Instance.
HyperscaleInstanceApi getHyperscaleInstanceById GET /hyperscale-instances/{hyperscaleInstanceId} Returns a Hyperscale Instance by ID.
HyperscaleInstanceApi getHyperscaleInstanceTags GET /hyperscale-instances/{hyperscaleInstanceId}/tags Get tags for a Hyperscale Instance.
HyperscaleInstanceApi getHyperscaleInstances GET /hyperscale-instances Returns a list of Hyperscale instances.
HyperscaleInstanceApi registerHyperscaleInstance POST /hyperscale-instances Register a Hyperscale instance
HyperscaleInstanceApi removeEngineFromHyperscaleInstance POST /hyperscale-instances/{hyperscaleInstanceId}/remove-engine Remove an engine from a Hyperscale Instance.
HyperscaleInstanceApi searchHyperscaleInstances POST /hyperscale-instances/search Search for Hyperscale instances.
HyperscaleInstanceApi syncEnginesHyperscaleInstance POST /hyperscale-instances/{hyperscaleInstanceId}/sync-engines Sync the global object from a source engine to engines on a Hyperscale Instance.
HyperscaleInstanceApi unregisterHyperscaleInstance DELETE /hyperscale-instances/{hyperscaleInstanceId} Unregister a Hyperscale Instance.
HyperscaleInstanceApi updateHyperscaleInstance PATCH /hyperscale-instances/{hyperscaleInstanceId} Update an Hyperscale Instance
HyperscaleObjectsApi createHyperscaleConnector POST /hyperscale-connectors Create a Hyperscale Connector.
HyperscaleObjectsApi createHyperscaleConnectorTags POST /hyperscale-connectors/{hyperscaleConnectorId}/tags Create tags for a Hyperscale Connector.
HyperscaleObjectsApi createHyperscaleDatasetTags POST /hyperscale-datasets/{hyperscaleDatasetId}/tags Create tags for a Hyperscale Dataset.
HyperscaleObjectsApi createHyperscaleMountPoint POST /hyperscale-mount-points Create a Hyperscale Mount Point
HyperscaleObjectsApi deleteHyperscaleConnector DELETE /hyperscale-connectors/{hyperscaleConnectorId} Delete a Hyperscale Connector.
HyperscaleObjectsApi deleteHyperscaleConnectorTags POST /hyperscale-connectors/{hyperscaleConnectorId}/tags/delete Delete tags for a Hyperscale Connector.
HyperscaleObjectsApi deleteHyperscaleDatasetTags POST /hyperscale-datasets/{hyperscaleDatasetId}/tags/delete Delete tags for a Hyperscale Dataset.
HyperscaleObjectsApi deleteHyperscaleMountPoint DELETE /hyperscale-mount-points/{hyperscaleMountPointId} Delete a Hyperscale Mount Point.
HyperscaleObjectsApi getHyperscaleConnectorById GET /hyperscale-connectors/{hyperscaleConnectorId} Get a Hyperscale Connector.
HyperscaleObjectsApi getHyperscaleConnectorTags GET /hyperscale-connectors/{hyperscaleConnectorId}/tags Get tags for a Hyperscale Connector.
HyperscaleObjectsApi getHyperscaleConnectors GET /hyperscale-connectors Returns a list of Hyperscale Connectors.
HyperscaleObjectsApi getHyperscaleDatasetById GET /hyperscale-datasets/{hyperscaleDatasetId} Get a Hyperscale Dataset.
HyperscaleObjectsApi getHyperscaleDatasetTableOrFileById GET /hyperscale-datasets/{hyperscaleDatasetId}/tables-or-files/{hyperscaleDatasetTableOrFileId} Get a Hyperscale Dataset table or file by ID.
HyperscaleObjectsApi getHyperscaleDatasetTablesOrFiles GET /hyperscale-datasets/{hyperscaleDatasetId}/tables-or-files Get the tables or files of a hyperscale dataset
HyperscaleObjectsApi getHyperscaleDatasetTags GET /hyperscale-datasets/{hyperscaleDatasetId}/tags Get tags for a Hyperscale Dataset.
HyperscaleObjectsApi getHyperscaleDatasets GET /hyperscale-datasets Returns a list of Hyperscale Datasets.
HyperscaleObjectsApi getHyperscaleMountPointById GET /hyperscale-mount-points/{hyperscaleMountPointId} Get a Hyperscale Mount Points.
HyperscaleObjectsApi getHyperscaleMountPoints GET /hyperscale-mount-points Returns a list of Hyperscale Mount Points.
HyperscaleObjectsApi searchHyperscaleConnectors POST /hyperscale-connectors/search Search for Hyperscale Connectors.
HyperscaleObjectsApi searchHyperscaleDatasetTablesOrFiles POST /hyperscale-datasets/{hyperscaleDatasetId}/tables-or-files/search Search the tables or files of a hyperscale dataset
HyperscaleObjectsApi searchHyperscaleDatasets POST /hyperscale-datasets/search Search for Hyperscale Datasets.
HyperscaleObjectsApi searchHyperscaleMountPoints POST /hyperscale-mount-points/search Search for Hyperscale Mount Points.
HyperscaleObjectsApi updateHyperscaleConnectorById PATCH /hyperscale-connectors/{hyperscaleConnectorId} Update a Hyperscale Connector by ID.
HyperscaleObjectsApi updateHyperscaleDatasetById PATCH /hyperscale-datasets/{hyperscaleDatasetId} Update a Hyperscale Dataset by ID.
HyperscaleObjectsApi updateHyperscaleDatasetTableOrFileById PATCH /hyperscale-datasets/{hyperscaleDatasetId}/tables-or-files/{hyperscaleDatasetTableOrFileId} Update a Hyperscale Dataset table or file by ID.
HyperscaleObjectsApi updateHyperscaleMountPointById PATCH /hyperscale-mount-points/{hyperscaleMountPointId} Update a Hyperscale Mount Point by ID.
JobsApi abandonJob POST /jobs/{jobId}/abandon Abandons a job.
JobsApi createJobTags POST /jobs/{jobId}/tags Create tags for a Job.
JobsApi deleteJobTag POST /jobs/{jobId}/tags/delete Delete tags for a Job.
JobsApi getJobById GET /jobs/{jobId} Returns a job by ID.
JobsApi getJobTags GET /jobs/{jobId}/tags Get tags for a Job.
JobsApi getJobs GET /jobs List all jobs.
JobsApi searchJobs POST /jobs/search Search for jobs.
KerberosConfigApi getKerberosConfigById GET /kerberos-configs/{kerberosConfigId} Get a kerberos config by ID or Name.
KerberosConfigApi listKerberosConfigs GET /kerberos-configs List all kerberos configs.
KerberosConfigApi searchKerberosConfigs POST /kerberos-configs/search Search for Kerberos Configs.
LoginApi accountLogin POST /login Login to Account with Username and Password
LoginApi accountLogout POST /logout Invalidates username/password and SSO login session.
LoginApi tokenInfo POST /token-info Get Token Information
ManagementApi createEngineTags POST /management/engines/{engineId}/tags Create tags for an Engine.
ManagementApi createHashicorpVault POST /management/vaults/hashicorp Configure a new Hashicorp Vault
ManagementApi createHashicorpVaultTags POST /management/vaults/hashicorp/{vaultId}/tags Create tags for a Hashicorp vault.
ManagementApi deleteEngineTags POST /management/engines/{engineId}/tags/delete Delete tags for an Engine.
ManagementApi deleteHashicorpVault DELETE /management/vaults/hashicorp/{vaultId} Delete a Hashicorp vault by id
ManagementApi deleteHashicorpVaultTag POST /management/vaults/hashicorp/{vaultId}/tags/delete Delete tags for a Hashicorp vault.
ManagementApi getApiClassification GET /management/api-classification Get api classification.
ManagementApi getEngineAutoTaggingConfig GET /management/engines/{engineId}/auto-tagging Returns the engine's auto tagging configuration.
ManagementApi getEngineTags GET /management/engines/{engineId}/tags Get tags for a Engine.
ManagementApi getHashicorpVault GET /management/vaults/hashicorp/{vaultId} Get a Hashicorp vault by id
ManagementApi getHashicorpVaultTags GET /management/vaults/hashicorp/{vaultId}/tags Get tags for a Hashicorp vault.
ManagementApi getHashicorpVaults GET /management/vaults/hashicorp Returns a list of configured Hashicorp vaults.
ManagementApi getLdapConfig GET /management/ldap-config Returns the LDAP configuration
ManagementApi getMetadataDatabase GET /management/metadata-database Returns configuration information about the metadata database which stores the product data.
ManagementApi getPhonehomeEvents GET /management/phonehome/events Returns previous bundle upload events
ManagementApi getProductRegistrationDelphixConnectivityCheck GET /management/product-registration-delphix-connectivity-check Returns True if Delphix services are reachable for product registration.
ManagementApi getProductRegistrationKey GET /management/product-registration-offline Generates and returns a public key that can be used to register the product.
ManagementApi getProductRegistrationStatus GET /management/product-registration-status Returns the product registration status.
ManagementApi getProxyConfiguration GET /management/proxy Returns the current web proxy configuration to use to connect to Delphix services.
ManagementApi getRegisteredEngine GET /management/engines/{engineId} Returns a registered engine by ID.
ManagementApi getRegisteredEngines GET /management/engines Returns a list of registered engines.
ManagementApi getSamlConfig GET /management/saml-config Returns the SAML configuration
ManagementApi getSmtpConfig GET /management/smtp Returns the SMTP configuration
ManagementApi listProperties GET /management/properties Get global properties.
ManagementApi registerEngine POST /management/engines Register an engine.
ManagementApi registerProductOffline POST /management/product-registration-offline Registers the product using a manually generated payload.
ManagementApi registerProductOnline POST /management/product-registration-online Registers the product using the provided credentials.
ManagementApi searchEngines POST /management/engines/search Search for engines.
ManagementApi searchHashicorpVaults POST /management/vaults/hashicorp/search Search for configured Hashicorp vaults.
ManagementApi unregisterEngine DELETE /management/engines/{engineId} Unregister an engine.
ManagementApi updateApiClassification PUT /management/api-classification Update the api classification to new version.
ManagementApi updateEngineAutoTaggingConfig PATCH /management/engines/{engineId}/auto-tagging Update the engine's auto tagging configuration.
ManagementApi updateLdapConfig PUT /management/ldap-config Update LDAP Config.
ManagementApi updateProperties PATCH /management/properties Update value of predefined properties.
ManagementApi updateProxyConfiguration PUT /management/proxy Update the web proxy configuration to use to connect to Delphix services.
ManagementApi updateRegisteredEngine PUT /management/engines/{engineId} Update a registered engine.
ManagementApi updateRegisteredEnginePartial PATCH /management/engines/{engineId} Update a registered engine.
ManagementApi updateSamlConfig PUT /management/saml-config Update SAML Config.
ManagementApi updateSmtpConfig PUT /management/smtp Update SMTP Config.
ManagementApi validateJavaPath POST /management/engines/{engineId}/validate/java-path Validate java path for the remote host machine.
ManagementApi validateLdapConfig POST /management/ldap-config/validate Validate LDAP Config. Without username/password, DCT performs an anonymous bind against the LDAP server. If credentials are provided DCT validates that authentication and mapping of optional properties are actually working with provided credentials. LDAP search is only validated if search attributes are set.
ManagementApi validateSmtpConfig POST /management/smtp/validate Validate SMTP Config.
MaskingEnvironmentsApi getMaskingEnvironmentById GET /masking-environments/{maskingEnvironmentId} Retrieve a MaskingEnvironment by ID.
MaskingEnvironmentsApi getMaskingEnvironments GET /masking-environments Retrieve the list of masking environments.
MaskingEnvironmentsApi searchMaskingEnvironments POST /masking-environments/search Search masking environments.
MaskingFilesApi uploadMaskingFile POST /masking-file-uploads Upload a file for masking.
MaskingJobsApi addEngineToMaskingJob POST /masking-jobs/{maskingJobId}/add-engine Add an engine to a Masking Job (Hyperscale Job only).
MaskingJobsApi copyMaskingJob POST /masking-jobs/{maskingJobId}/copy Copies the masking job to another engine.
MaskingJobsApi createMaskingJob POST /masking-jobs Create a Masking Job.
MaskingJobsApi createMaskingJobTag POST /masking-jobs/{maskingJobId}/tags Create tags for a Masking Job.
MaskingJobsApi deleteMaskingJob DELETE /masking-jobs/{maskingJobId} Delete a masking job.
MaskingJobsApi deleteMaskingJobTag POST /masking-jobs/{maskingJobId}/tags/delete Delete tags for a Masking Job.
MaskingJobsApi executeMaskingJob POST /masking-jobs/{maskingJobId}/execute Execute a MaskingJob.
MaskingJobsApi getMaskingJobById GET /masking-jobs/{maskingJobId} Retrieve a MaskingJob by ID.
MaskingJobsApi getMaskingJobConnectors GET /masking-jobs/{maskingJobId}/connectors Get connectors for a Masking Job by ID.
MaskingJobsApi getMaskingJobSourceEngines GET /masking-jobs/source-engines Retrieve the list of masking jobs along with their source engine.
MaskingJobsApi getMaskingJobTag GET /masking-jobs/{maskingJobId}/tags Get tags for a Masking Job.
MaskingJobsApi getMaskingJobs GET /masking-jobs Retrieve the list of masking jobs.
MaskingJobsApi migrateMaskingJob POST /masking-jobs/{maskingJobId}/migrate Migrates the masking job from its current source engine to another engine.
MaskingJobsApi reImportMaskingJob POST /masking-jobs/{maskingJobId}/re-import Re-import the dataset from the source MaskingJob (Hyperscale Job only).
MaskingJobsApi removeEngineFromMaskingJob POST /masking-jobs/{maskingJobId}/remove-engine Remove an engine from a Masking Job (Hyperscale Job only).
MaskingJobsApi searchMaskingJobSourceEngines POST /masking-jobs/source-engines/search Search the list of masking jobs along with their source engine.
MaskingJobsApi searchMaskingJobs POST /masking-jobs/search Search masking jobs.
MaskingJobsApi updateMaskingJobById PATCH /masking-jobs/{maskingJobId} Update values of a MaskingJob.
MaskingPluginsApi createMaskingPluginTags POST /masking-plugins/{maskingPluginId}/tags Create tags for a masking plugin.
MaskingPluginsApi deleteMaskingPlugin DELETE /masking-plugins/{maskingPluginId} Delete a custom masking plugin.
MaskingPluginsApi deleteMaskingPluginTags POST /masking-plugins/{maskingPluginId}/tags/delete Delete tags for a masking plugin.
MaskingPluginsApi getMaskingPluginById GET /masking-plugins/{maskingPluginId} Get a masking plugin by ID or name.
MaskingPluginsApi getMaskingPluginTags GET /masking-plugins/{maskingPluginId}/tags Get tags for a masking plugin.
MaskingPluginsApi getMaskingPlugins GET /masking-plugins Retrieve the list of masking plugins.
MaskingPluginsApi installMaskingPlugin POST /masking-plugins Install a custom masking plugin.
MaskingPluginsApi searchMaskingPlugins POST /masking-plugins/search Search for masking plugins.
PasswordVaultsApi getPasswordVaultById GET /password_vaults/{passwordVaultId} Get a password vault by ID or Name.
PasswordVaultsApi getPasswordVaults GET /password_vaults List all password vaults.
PasswordVaultsApi searchPasswordVaults POST /password_vaults/search Search for Password Vaults.
ReplicationApi createReplicationProfileTags POST /replication-profiles/{replicationProfileId}/tags Create tags for a ReplicationProfile.
ReplicationApi deleteRepliationProfileTags POST /replication-profiles/{replicationProfileId}/tags/delete Delete tags for a ReplicationProfile.
ReplicationApi deleteReplicationProfile DELETE /replication-profiles/{replicationProfileId} Delete a ReplicationProfile.
ReplicationApi disableTagReplication POST /replication-profiles/{replicationProfileId}/disable-tag-replication Disable tag replication for given ReplicationProfile.
ReplicationApi enableTagReplication POST /replication-profiles/{replicationProfileId}/enable-tag-replication Enable tag replication for given ReplicationProfile.
ReplicationApi executeReplicationProfile POST /replication-profiles/{replicationProfileId}/execute Execute a ReplicationProfile.
ReplicationApi getReplicationProfileById GET /replication-profiles/{replicationProfileId} Get a ReplicationProfile by ID.
ReplicationApi getReplicationProfileTags GET /replication-profiles/{replicationProfileId}/tags Get tags for a ReplicationProfile.
ReplicationApi getReplicationProfiles GET /replication-profiles List all ReplicationProfiles.
ReplicationApi searchReplicationProfiles POST /replication-profiles/search Search for ReplicationProfiles.
ReportingApi createReportingSchedule POST /reporting/schedule Create a new report schedule.
ReportingApi createReportingScheduleTags POST /reporting/schedule/{reportId}/tags Create tags for a report schedule.
ReportingApi deleteReportingSchedule DELETE /reporting/schedule/{reportId} Delete report schedule by ID.
ReportingApi deleteReportingScheduleTag POST /reporting/schedule/{reportId}/tags/delete Delete tags for a report schedule.
ReportingApi getApiUsageReport GET /reporting/api-usage-report Gets the report of API usage metrics over a given time period. This API returns at the most 10000 results in the response to protect against the server running out of memory. Users might not hit this limit with the default report without any 'apiUsageReportGroupByParam' param but can hit this limit if the groupBy is by too granular like by 'client_name' or 'user_agent' only. Hence it is advisable to use startDate and endDate to 'limit' the scope of the report.
ReportingApi getAuditLogsSummaryReport GET /reporting/audit-logs-summary-report Gets the audit log summary report.
ReportingApi getDsourceConsumptionReport GET /reporting/dsource-consumption-report Gets the consumption report for virtualization engine dSources.
ReportingApi getDsourceUsageReport GET /reporting/dsource-usage-report Gets the usage report for virtualization engine dSources.
ReportingApi getEngineGlobalObjectStateReport GET /reporting/engine-global-object-state-report Get the masking engine global object state report.
ReportingApi getEnginePerformanceAnalyticsReport GET /reporting/engine-performance-analytic-report Gets the performance analytics report for engines.
ReportingApi getMaskingExecutionMetricsReport GET /reporting/masking-execution-metrics Get the masking execution metrics report.
ReportingApi getProductInfo GET /reporting/product_info Returns the DCT Product Information.
ReportingApi getReportingScheduleById GET /reporting/schedule/{reportId} Returns a report schedule by ID.
ReportingApi getReportingScheduleTags GET /reporting/schedule/{reportId}/tags Get tags for a report schedule.
ReportingApi getReportingSchedules GET /reporting/schedule List all report schedules.
ReportingApi getVdbInventoryReport GET /reporting/vdb-inventory-report Gets the inventory report for virtualization engine VDBs.
ReportingApi getVirtualizationStorageSummaryReport GET /reporting/virtualization-storage-summary-report Gets the storage summary report for virtualization engines.
ReportingApi searchDsourceConsumptionReport POST /reporting/dsource-consumption-report/search Search the consumption report for virtualization engine DSources.
ReportingApi searchDsourceUsageReport POST /reporting/dsource-usage-report/search Search the usage report for virtualization engine dSources.
ReportingApi searchEngineGlobalObjectStateReport POST /reporting/engine-global-object-state-report/search Search the masking engine global object state report.
ReportingApi searchEnginePerformanceAnalyticTrends POST /reporting/engine-performance-analytic-trends/search Search the performance analytic trend data for engines.
ReportingApi searchEnginePerformanceAnalyticsReport POST /reporting/engine-performance-analytic-report/search Search the performance analytic report for engines.
ReportingApi searchMaskingExecutionMetricsReport POST /reporting/masking-execution-metrics/search Search the Masking execution metrics report.
ReportingApi searchReportingSchedules POST /reporting/schedule/search Search for report schedules.
ReportingApi searchStorageSavingsSummaryReport POST /reporting/storage-savings-report/search Search the saving storage summary report for virtualization engines.
ReportingApi searchVdbInventoryReport POST /reporting/vdb-inventory-report/search Search the inventory report for virtualization engine VDBs.
ReportingApi searchVirtualizationStorageSummaryReport POST /reporting/virtualization-storage-summary-report/search Search the storage summary report for virtualization engines.
ReportingApi updateReportingSchedule PUT /reporting/schedule/{reportId} Update a reporting schedule by ID.
SamlLoginApi checkSaml GET /is-saml-enabled Check if SAML is enabled
SnapshotsApi createSnapshotTags POST /snapshots/{snapshotId}/tags Create tags for a Snapshot.
SnapshotsApi deleteSnapshot DELETE /snapshots/{snapshotId} Delete a Snapshot.
SnapshotsApi deleteSnapshotTags POST /snapshots/{snapshotId}/tags/delete Delete tags for a Snapshot.
SnapshotsApi findByLocation GET /snapshots/find_by_location Get the snapshots at this location for a dataset.
SnapshotsApi findByTimestamp GET /snapshots/find_by_timestamp Get the snapshots at this timestamp for a dataset.
SnapshotsApi getSnapshotById GET /snapshots/{snapshotId} Get a Snapshot by ID.
SnapshotsApi getSnapshotTags GET /snapshots/{snapshotId}/tags Get tags for a Snapshot.
SnapshotsApi getSnapshotTimeflowRange GET /snapshots/{snapshotId}/timeflow_range Return the provisionable timeflow range based on a specific snapshot.
SnapshotsApi getSnapshots GET /snapshots Retrieve the list of snapshots.
SnapshotsApi searchSnapshots POST /snapshots/search Search snapshots.
SnapshotsApi unsetSnapshotRetention POST /snapshots/{snapshotId}/unset_expiration Unset a Snapshot's expiration, removing expiration and retain_forever values for the snapshot.
SnapshotsApi updateSnapshot PATCH /snapshots/{snapshotId} Update values of a Snapshot.
SourcesApi createPostgresSource POST /sources/postgres Create a PostgreSQL source.
SourcesApi createSourceTags POST /sources/{sourceId}/tags Create tags for a Source.
SourcesApi deleteSource DELETE /sources/{sourceId} Delete a source by ID.
SourcesApi deleteSourceTags POST /sources/{sourceId}/tags/delete Delete tags for a Source.
SourcesApi getSourceById GET /sources/{sourceId} Get a source by ID.
SourcesApi getSourceCompatibleRepo GET /sources/{sourceId}/staging_compatible_repositories Returns a list of repositories that match the specified source.
SourcesApi getSourceTags GET /sources/{sourceId}/tags Get tags for a Source.
SourcesApi getSources GET /sources List all sources.
SourcesApi searchSources POST /sources/search Search for Sources.
SourcesApi updatePostgresSourceById PATCH /sources/postgres/{sourceId} Update a PostgreSQL source by ID.
StagingSourcesApi createStagingSourceTags POST /staging-sources/{stagingSourceId}/tags Create tags for a Staging Source.
StagingSourcesApi deleteStagingSourceTags POST /staging-sources/{stagingSourceId}/tags/delete Delete tags for a Staging Source.
StagingSourcesApi getStagingSourceById GET /staging-sources/{stagingSourceId} Get a staging source by ID.
StagingSourcesApi getStagingSourceTags GET /staging-sources/{stagingSourceId}/tags Get tags for a Staging Source.
StagingSourcesApi getStagingSources GET /staging-sources List all staging sources.
StagingSourcesApi searchStagingSources POST /staging-sources/search Search for Staging Sources.
TestApi enableScaleTesting POST /enable-scale-testing This is used for performance testing to enable engine and object duplication.
TimeflowsApi createTimeflowTags POST /timeflows/{timeflowId}/tags Create tags for a Timeflow.
TimeflowsApi deleteTimeflow DELETE /timeflows/{timeflowId} Delete a timeflow.
TimeflowsApi deleteTimeflowTags POST /timeflows/{timeflowId}/tags/delete Delete tags for a Timeflow.
TimeflowsApi getTimeflowById GET /timeflows/{timeflowId} Get a Timeflow by ID.
TimeflowsApi getTimeflowSnapshotDayRange GET /timeflows/{timeflowId}/timeflowSnapshotDayRange Returns the count of TimeFlow snapshots of the Timeflow aggregated by day.
TimeflowsApi getTimeflowTags GET /timeflows/{timeflowId}/tags Get tags for a Timeflow.
TimeflowsApi getTimeflows GET /timeflows Retrieve the list of timeflows.
TimeflowsApi searchTimeflows POST /timeflows/search Search timeflows.
TimeflowsApi updateTimeflow PATCH /timeflows/{timeflowId} Update values of a timeflow.
ToolkitsApi createToolkitTags POST /toolkits/{toolkitId}/tags Create tags for a toolkit.
ToolkitsApi deleteToolkitTags POST /toolkits/{toolkitId}/tags/delete Delete tags for a Toolkit.
ToolkitsApi getToolkitById GET /toolkits/{toolkitId} Get Toolkit by ID.
ToolkitsApi getToolkitTags GET /toolkits/{toolkitId}/tags Get tags for a Toolkit.
ToolkitsApi getToolkits GET /toolkits List all toolkits.
ToolkitsApi searchToolkits POST /toolkits/search Search for toolkits.
VcdbsApi createVcdbTags POST /vcdbs/{vcdbId}/tags Create tags for a vCDB.
VcdbsApi deleteVcdbTags POST /vcdbs/{vcdbId}/tags/delete Delete tags for a vCDB.
VcdbsApi getTagsVcdb GET /vcdbs/{vcdbId}/tags Get tags for a vCDB.
VcdbsApi getVcdbById GET /vcdbs/{vcdbId} Get a CDB by ID (Oracle only).
VcdbsApi getVcdbs GET /vcdbs List all vCDBs (Oracle only).
VcdbsApi searchVcdbs POST /vcdbs/search Search for vCDBs (Oracle only).
VdbGroupsApi createVdbGroup POST /vdb-groups Create a new VDBGroup.
VdbGroupsApi createVdbGroupsTags POST /vdb-groups/{vdbGroupId}/tags Create tags for a VDB Group.
VdbGroupsApi deleteVdbGroup DELETE /vdb-groups/{vdbGroupId} Delete a VDBGoup.
VdbGroupsApi deleteVdbGroupTags POST /vdb-groups/{vdbGroupId}/tags/delete Delete tags for a VDB Group.
VdbGroupsApi getBookmarksByVdbGroup GET /vdb-groups/{vdbGroupId}/bookmarks List bookmarks compatible with this VDB Group.
VdbGroupsApi getVdbGroup GET /vdb-groups/{vdbGroupId} Get a VDBGroup by name.
VdbGroupsApi getVdbGroupTags GET /vdb-groups/{vdbGroupId}/tags Get tags for a VDB Group.
VdbGroupsApi getVdbGroups GET /vdb-groups List all VDBGroups.
VdbGroupsApi lockVdbGroup POST /vdb-groups/{vdbGroupId}/lock Lock a VDB Group.
VdbGroupsApi provisionVdbGroupFromBookmark POST /vdb-groups/provision_from_bookmark Provision a new VDB Group from a Bookmark.
VdbGroupsApi refreshVdbGroup POST /vdb-groups/{vdbGroupId}/refresh Refresh a VDBGroup.
VdbGroupsApi rollbackVdbGroup POST /vdb-groups/{vdbGroupId}/rollback Rollback a VDBGroup.
VdbGroupsApi searchBookmarksByVdbGroup POST /vdb-groups/{vdbGroupId}/bookmarks/search Search for bookmarks compatible with this VDB Group.
VdbGroupsApi searchVdbGroups POST /vdb-groups/search Search for VDB Groups.
VdbGroupsApi unlockVdbGroup POST /vdb-groups/{vdbGroupId}/unlock Unlock a VDB Group.
VdbGroupsApi updateVdbGroupById PATCH /vdb-groups/{vdbGroupId} Update values of a VDB group.
VdbsApi createVdbTags POST /vdbs/{vdbId}/tags Create tags for a VDB.
VdbsApi deleteVdb POST /vdbs/{vdbId}/delete Delete a VDB.
VdbsApi deleteVdbTags POST /vdbs/{vdbId}/tags/delete Delete tags for a VDB.
VdbsApi disableVdb POST /vdbs/{vdbId}/disable Disable a VDB.
VdbsApi enableVdb POST /vdbs/{vdbId}/enable Enable a VDB.
VdbsApi getBookmarksByVdb GET /vdbs/{vdbId}/bookmarks List Bookmarks compatible with this VDB.
VdbsApi getTagsVdb GET /vdbs/{vdbId}/tags Get tags for a VDB.
VdbsApi getVdbById GET /vdbs/{vdbId} Get a VDB by ID.
VdbsApi getVdbSnapshots GET /vdbs/{vdbId}/snapshots List Snapshots for a VDB.
VdbsApi getVdbs GET /vdbs List all vdbs.
VdbsApi lockVdb POST /vdbs/{vdbId}/lock Lock a VDB.
VdbsApi provisionVdbByLocation POST /vdbs/provision_by_location Provision a new VDB by location.
VdbsApi provisionVdbByLocationDefaults POST /vdbs/provision_by_location/defaults Get default provision parameters for provisioning a new VDB by location.
VdbsApi provisionVdbBySnapshot POST /vdbs/provision_by_snapshot Provision a new VDB by snapshot.
VdbsApi provisionVdbBySnapshotDefaults POST /vdbs/provision_by_snapshot/defaults Get default provision parameters for provisioning a new VDB by snapshot.
VdbsApi provisionVdbByTimestamp POST /vdbs/provision_by_timestamp Provision a new VDB by timestamp.
VdbsApi provisionVdbByTimestampDefaults POST /vdbs/provision_by_timestamp/defaults Get default provision parameters for provisioning a new VDB by timestamp.
VdbsApi provisionVdbFromBookmark POST /vdbs/provision_from_bookmark Provision a new VDB from a bookmark with a single VDB.
VdbsApi provisionVdbFromBookmarkDefaults POST /vdbs/provision_from_bookmark/defaults Get default provision parameters for provisioning a new VDB from a bookmark.
VdbsApi refreshVdbByLocation POST /vdbs/{vdbId}/refresh_by_location Refresh a VDB by location.
VdbsApi refreshVdbBySnapshot POST /vdbs/{vdbId}/refresh_by_snapshot Refresh a VDB by snapshot.
VdbsApi refreshVdbByTimestamp POST /vdbs/{vdbId}/refresh_by_timestamp Refresh a VDB by timestamp.
VdbsApi refreshVdbFromBookmark POST /vdbs/{vdbId}/refresh_from_bookmark Refresh a VDB from bookmark with a single VDB.
VdbsApi rollbackVdbBySnapshot POST /vdbs/{vdbId}/rollback_by_snapshot Rollback a VDB by snapshot.
VdbsApi rollbackVdbByTimestamp POST /vdbs/{vdbId}/rollback_by_timestamp Rollback a VDB by timestamp.
VdbsApi rollbackVdbFromBookmark POST /vdbs/{vdbId}/rollback_from_bookmark Rollback a VDB from a bookmark with only the same VDB.
VdbsApi searchBookmarksByVdb POST /vdbs/{vdbId}/bookmarks/search Search Bookmarks compatible with this VDB.
VdbsApi searchVdbs POST /vdbs/search Search for VDBs.
VdbsApi snapshotVdb POST /vdbs/{vdbId}/snapshots Snapshot a VDB.
VdbsApi startVdb POST /vdbs/{vdbId}/start Start a VDB.
VdbsApi stopVdb POST /vdbs/{vdbId}/stop Stop a VDB.
VdbsApi switchTimeflow POST /vdbs/{vdbId}/switch_timeflow Switches the current timeflow of a VDB.
VdbsApi unlockVdb POST /vdbs/{vdbId}/unlock Unlock a VDB.
VdbsApi updateVdbById PATCH /vdbs/{vdbId} Update values of a VDB
VirtualizationPoliciesApi getVirtualizationPolicyById GET /virtualization-policies/{policyId} Fetch a virtualization policy by Id.
VirtualizationPoliciesApi listVirtualizationPolicies GET /virtualization-policies Fetch a list of all virtualization policies
VirtualizationPoliciesApi searchVirtualizationPolicies POST /virtualization-policies/search Search Virtualization Policies.

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

support@delphix.com