All URIs are relative to http://localhost/v3
| Method | HTTP request | Description |
|---|---|---|
| createEngineTags | POST /management/engines/{engineId}/tags | Create tags for an Engine. |
| createHashicorpVault | POST /management/vaults/hashicorp | Configure a new Hashicorp Vault |
| createHashicorpVaultTags | POST /management/vaults/hashicorp/{vaultId}/tags | Create tags for a Hashicorp vault. |
| deleteEngineTags | POST /management/engines/{engineId}/tags/delete | Delete tags for an Engine. |
| deleteHashicorpVault | DELETE /management/vaults/hashicorp/{vaultId} | Delete a Hashicorp vault by id |
| deleteHashicorpVaultTag | POST /management/vaults/hashicorp/{vaultId}/tags/delete | Delete tags for a Hashicorp vault. |
| getApiClassification | GET /management/api-classification | Get api classification. |
| getEngineAutoTaggingConfig | GET /management/engines/{engineId}/auto-tagging | Returns the engine's auto tagging configuration. |
| getEngineTags | GET /management/engines/{engineId}/tags | Get tags for a Engine. |
| getHashicorpVault | GET /management/vaults/hashicorp/{vaultId} | Get a Hashicorp vault by id |
| getHashicorpVaultTags | GET /management/vaults/hashicorp/{vaultId}/tags | Get tags for a Hashicorp vault. |
| getHashicorpVaults | GET /management/vaults/hashicorp | Returns a list of configured Hashicorp vaults. |
| getLdapConfig | GET /management/ldap-config | Returns the LDAP configuration |
| getMetadataDatabase | GET /management/metadata-database | Returns configuration information about the metadata database which stores the product data. |
| getPhonehomeEvents | GET /management/phonehome/events | Returns previous bundle upload events |
| getProductRegistrationDelphixConnectivityCheck | GET /management/product-registration-delphix-connectivity-check | Returns True if Delphix services are reachable for product registration. |
| getProductRegistrationKey | GET /management/product-registration-offline | Generates and returns a public key that can be used to register the product. |
| getProductRegistrationStatus | GET /management/product-registration-status | Returns the product registration status. |
| getProxyConfiguration | GET /management/proxy | Returns the current web proxy configuration to use to connect to Delphix services. |
| getRegisteredEngine | GET /management/engines/{engineId} | Returns a registered engine by ID. |
| getRegisteredEngines | GET /management/engines | Returns a list of registered engines. |
| getSamlConfig | GET /management/saml-config | Returns the SAML configuration |
| getSmtpConfig | GET /management/smtp | Returns the SMTP configuration |
| listProperties | GET /management/properties | Get global properties. |
| registerEngine | POST /management/engines | Register an engine. |
| registerProductOffline | POST /management/product-registration-offline | Registers the product using a manually generated payload. |
| registerProductOnline | POST /management/product-registration-online | Registers the product using the provided credentials. |
| searchEngines | POST /management/engines/search | Search for engines. |
| searchHashicorpVaults | POST /management/vaults/hashicorp/search | Search for configured Hashicorp vaults. |
| unregisterEngine | DELETE /management/engines/{engineId} | Unregister an engine. |
| updateApiClassification | PUT /management/api-classification | Update the api classification to new version. |
| updateEngineAutoTaggingConfig | PATCH /management/engines/{engineId}/auto-tagging | Update the engine's auto tagging configuration. |
| updateLdapConfig | PUT /management/ldap-config | Update LDAP Config. |
| updateProperties | PATCH /management/properties | Update value of predefined properties. |
| updateProxyConfiguration | PUT /management/proxy | Update the web proxy configuration to use to connect to Delphix services. |
| updateRegisteredEngine | PUT /management/engines/{engineId} | Update a registered engine. |
| updateRegisteredEnginePartial | PATCH /management/engines/{engineId} | Update a registered engine. |
| updateSamlConfig | PUT /management/saml-config | Update SAML Config. |
| updateSmtpConfig | PUT /management/smtp | Update SMTP Config. |
| 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. |
| validateSmtpConfig | POST /management/smtp/validate | Validate SMTP Config. |
TagsResponse createEngineTags(engineId, tagsRequest)
Create tags for an Engine.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
String engineId = "engineId_example"; // String | The ID of the registered engine.
TagsRequest tagsRequest = new TagsRequest(); // TagsRequest | Tags information for Engine.
try {
TagsResponse result = apiInstance.createEngineTags(engineId, tagsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#createEngineTags");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| engineId | String | The ID of the registered engine. | |
| tagsRequest | TagsRequest | Tags information for Engine. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Created | - |
HashicorpVault createHashicorpVault(hashicorpVault)
Configure a new Hashicorp Vault
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
HashicorpVault hashicorpVault = new HashicorpVault(); // HashicorpVault |
try {
HashicorpVault result = apiInstance.createHashicorpVault(hashicorpVault);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#createHashicorpVault");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| hashicorpVault | HashicorpVault |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Created | - |
TagsResponse createHashicorpVaultTags(vaultId, tagsRequest)
Create tags for a Hashicorp vault.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long vaultId = 56L; // Long | Numeric ID of the Hashicorp vault
TagsRequest tagsRequest = new TagsRequest(); // TagsRequest | Tags information for Hashicorp vault.
try {
TagsResponse result = apiInstance.createHashicorpVaultTags(vaultId, tagsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#createHashicorpVaultTags");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| vaultId | Long | Numeric ID of the Hashicorp vault | |
| tagsRequest | TagsRequest | Tags information for Hashicorp vault. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Created | - |
deleteEngineTags(engineId, deleteTag)
Delete tags for an Engine.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
String engineId = "engineId_example"; // String | The ID of the registered engine.
DeleteTag deleteTag = new DeleteTag(); // DeleteTag | The parameters to delete tags
try {
apiInstance.deleteEngineTags(engineId, deleteTag);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#deleteEngineTags");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| engineId | String | The ID of the registered engine. | |
| deleteTag | DeleteTag | The parameters to delete tags | [optional] |
null (empty response body)
- Content-Type: application/json
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
deleteHashicorpVault(vaultId)
Delete a Hashicorp vault by id
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long vaultId = 56L; // Long | Numeric ID of the Hashicorp vault
try {
apiInstance.deleteHashicorpVault(vaultId);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#deleteHashicorpVault");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| vaultId | Long | Numeric ID of the Hashicorp vault |
null (empty response body)
- Content-Type: Not defined
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
deleteHashicorpVaultTag(vaultId, deleteTag)
Delete tags for a Hashicorp vault.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long vaultId = 56L; // Long | Numeric ID of the Hashicorp vault
DeleteTag deleteTag = new DeleteTag(); // DeleteTag | The parameters to delete tags
try {
apiInstance.deleteHashicorpVaultTag(vaultId, deleteTag);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#deleteHashicorpVaultTag");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| vaultId | Long | Numeric ID of the Hashicorp vault | |
| deleteTag | DeleteTag | The parameters to delete tags | [optional] |
null (empty response body)
- Content-Type: application/json
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
APIClassificationConfig getApiClassification()
Get api classification.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
try {
APIClassificationConfig result = apiInstance.getApiClassification();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getApiClassification");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
AutoTaggingConfig getEngineAutoTaggingConfig(engineId)
Returns the engine's auto tagging configuration.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
String engineId = "engineId_example"; // String | The ID of the registered engine.
try {
AutoTaggingConfig result = apiInstance.getEngineAutoTaggingConfig(engineId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getEngineAutoTaggingConfig");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| engineId | String | The ID of the registered engine. |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
TagsResponse getEngineTags(engineId)
Get tags for a Engine.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
String engineId = "engineId_example"; // String | The ID of the registered engine.
try {
TagsResponse result = apiInstance.getEngineTags(engineId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getEngineTags");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| engineId | String | The ID of the registered engine. |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Ok | - |
HashicorpVault getHashicorpVault(vaultId)
Get a Hashicorp vault by id
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long vaultId = 56L; // Long | Numeric ID of the Hashicorp vault
try {
HashicorpVault result = apiInstance.getHashicorpVault(vaultId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getHashicorpVault");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| vaultId | Long | Numeric ID of the Hashicorp vault |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
TagsResponse getHashicorpVaultTags(vaultId)
Get tags for a Hashicorp vault.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
Long vaultId = 56L; // Long | Numeric ID of the Hashicorp vault
try {
TagsResponse result = apiInstance.getHashicorpVaultTags(vaultId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getHashicorpVaultTags");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| vaultId | Long | Numeric ID of the Hashicorp vault |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Ok | - |
ListHashicorpVaultsResponse getHashicorpVaults(limit, cursor, sort)
Returns a list of configured Hashicorp vaults.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer limit = 100; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.
String cursor = "cursor_example"; // String | 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.
String sort = "name"; // String | The field to sort results by. A property name with a prepended '-' signifies descending order.
try {
ListHashicorpVaultsResponse result = apiInstance.getHashicorpVaults(limit, cursor, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getHashicorpVaults");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. | [optional] [default to 100] |
| cursor | String | 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. | [optional] |
| sort | String | The field to sort results by. A property name with a prepended '-' signifies descending order. | [optional] [enum: id, -id] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
LDAPConfigParams getLdapConfig()
Returns the LDAP configuration
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
try {
LDAPConfigParams result = apiInstance.getLdapConfig();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getLdapConfig");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
MetadataDbInfo getMetadataDatabase()
Returns configuration information about the metadata database which stores the product data.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
try {
MetadataDbInfo result = apiInstance.getMetadataDatabase();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getMetadataDatabase");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
List<BundleUploadEvent> getPhonehomeEvents(limit)
Returns previous bundle upload events
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer limit = 56; // Integer | The maximum number of items to return.
try {
List<BundleUploadEvent> result = apiInstance.getPhonehomeEvents(limit);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getPhonehomeEvents");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | The maximum number of items to return. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
Boolean getProductRegistrationDelphixConnectivityCheck()
Returns True if Delphix services are reachable for product registration.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
try {
Boolean result = apiInstance.getProductRegistrationDelphixConnectivityCheck();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getProductRegistrationDelphixConnectivityCheck");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}This endpoint does not need any parameter.
Boolean
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
String getProductRegistrationKey()
Generates and returns a public key that can be used to register the product.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
try {
String result = apiInstance.getProductRegistrationKey();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getProductRegistrationKey");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}This endpoint does not need any parameter.
String
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
Boolean getProductRegistrationStatus()
Returns the product registration status.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
try {
Boolean result = apiInstance.getProductRegistrationStatus();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getProductRegistrationStatus");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}This endpoint does not need any parameter.
Boolean
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
ProxyConfiguration getProxyConfiguration()
Returns the current web proxy configuration to use to connect to Delphix services.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
try {
ProxyConfiguration result = apiInstance.getProxyConfiguration();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getProxyConfiguration");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
RegisteredEngine getRegisteredEngine(engineId)
Returns a registered engine by ID.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
String engineId = "engineId_example"; // String | The ID of the registered engine.
try {
RegisteredEngine result = apiInstance.getRegisteredEngine(engineId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getRegisteredEngine");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| engineId | String | The ID of the registered engine. |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
ListRegisteredEnginesResponse getRegisteredEngines(limit, cursor, sort)
Returns a list of registered engines.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer limit = 100; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.
String cursor = "cursor_example"; // String | 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.
String sort = "name"; // String | The field to sort results by. A property name with a prepended '-' signifies descending order.
try {
ListRegisteredEnginesResponse result = apiInstance.getRegisteredEngines(limit, cursor, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getRegisteredEngines");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. | [optional] [default to 100] |
| cursor | String | 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. | [optional] |
| sort | String | The field to sort results by. A property name with a prepended '-' signifies descending order. | [optional] [enum: id, -id, uuid, -uuid, type, -type, version, -version, name, -name, hostname, -hostname, cpu_core_count, -cpu_core_count, memory_size, -memory_size, data_storage_capacity, -data_storage_capacity, data_storage_used, -data_storage_used, username, -username, hashicorp_vault_id, -hashicorp_vault_id, connection_status, -connection_status, connection_status_details, -connection_status_details, engine_connection_status, -engine_connection_status, engine_connection_status_details, -engine_connection_status_details, masking_memory_used, -masking_memory_used, masking_allocated_memory, -masking_allocated_memory, masking_jobs_running, -masking_jobs_running, masking_max_concurrent_jobs, -masking_max_concurrent_jobs, masking_available_cores, -masking_available_cores] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
SAMLConfigParams getSamlConfig()
Returns the SAML configuration
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
try {
SAMLConfigParams result = apiInstance.getSamlConfig();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getSamlConfig");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
SMTPConfigParams getSmtpConfig()
Returns the SMTP configuration
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
try {
SMTPConfigParams result = apiInstance.getSmtpConfig();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#getSmtpConfig");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
GlobalProperties listProperties()
Get global properties.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
try {
GlobalProperties result = apiInstance.listProperties();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#listProperties");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
RegisteredEngine registerEngine(engineRegistrationParameter)
Register an engine.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
EngineRegistrationParameter engineRegistrationParameter = new EngineRegistrationParameter(); // EngineRegistrationParameter | The parameters to register an engine.
try {
RegisteredEngine result = apiInstance.registerEngine(engineRegistrationParameter);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#registerEngine");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| engineRegistrationParameter | EngineRegistrationParameter | The parameters to register an engine. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Created | - |
registerProductOffline(productRegistrationOfflinePayload)
Registers the product using a manually generated payload.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
ProductRegistrationOfflinePayload productRegistrationOfflinePayload = new ProductRegistrationOfflinePayload(); // ProductRegistrationOfflinePayload |
try {
apiInstance.registerProductOffline(productRegistrationOfflinePayload);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#registerProductOffline");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| productRegistrationOfflinePayload | ProductRegistrationOfflinePayload |
null (empty response body)
- Content-Type: application/json
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
registerProductOnline(productRegistrationOnlinePayload)
Registers the product using the provided credentials.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
ProductRegistrationOnlinePayload productRegistrationOnlinePayload = new ProductRegistrationOnlinePayload(); // ProductRegistrationOnlinePayload |
try {
apiInstance.registerProductOnline(productRegistrationOnlinePayload);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#registerProductOnline");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| productRegistrationOnlinePayload | ProductRegistrationOnlinePayload |
null (empty response body)
- Content-Type: application/json
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
SearchEnginesResponse searchEngines(limit, cursor, sort, searchBody)
Search for engines.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer limit = 100; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.
String cursor = "cursor_example"; // String | 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.
String sort = "name"; // String | The field to sort results by. A property name with a prepended '-' signifies descending order.
SearchBody searchBody = new SearchBody(); // SearchBody | 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.
try {
SearchEnginesResponse result = apiInstance.searchEngines(limit, cursor, sort, searchBody);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#searchEngines");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. | [optional] [default to 100] |
| cursor | String | 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. | [optional] |
| sort | String | The field to sort results by. A property name with a prepended '-' signifies descending order. | [optional] [enum: id, -id, uuid, -uuid, type, -type, version, -version, name, -name, hostname, -hostname, cpu_core_count, -cpu_core_count, memory_size, -memory_size, data_storage_capacity, -data_storage_capacity, data_storage_used, -data_storage_used, username, -username, hashicorp_vault_id, -hashicorp_vault_id, connection_status, -connection_status, connection_status_details, -connection_status_details, engine_connection_status, -engine_connection_status, engine_connection_status_details, -engine_connection_status_details, masking_memory_used, -masking_memory_used, masking_allocated_memory, -masking_allocated_memory, masking_jobs_running, -masking_jobs_running, masking_max_concurrent_jobs, -masking_max_concurrent_jobs, masking_available_cores, -masking_available_cores] |
| searchBody | SearchBody | 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 |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
SearchHashicorpVaultsResponse searchHashicorpVaults(limit, cursor, sort, searchBody)
Search for configured Hashicorp vaults.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
Integer limit = 100; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.
String cursor = "cursor_example"; // String | 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.
String sort = "name"; // String | The field to sort results by. A property name with a prepended '-' signifies descending order.
SearchBody searchBody = new SearchBody(); // SearchBody | 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.
try {
SearchHashicorpVaultsResponse result = apiInstance.searchHashicorpVaults(limit, cursor, sort, searchBody);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#searchHashicorpVaults");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. | [optional] [default to 100] |
| cursor | String | 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. | [optional] |
| sort | String | The field to sort results by. A property name with a prepended '-' signifies descending order. | [optional] [enum: id, -id] |
| searchBody | SearchBody | 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 |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
DeleteEngineResponse unregisterEngine(engineId)
Unregister an engine.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
String engineId = "engineId_example"; // String | The ID of the registered engine.
try {
DeleteEngineResponse result = apiInstance.unregisterEngine(engineId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#unregisterEngine");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| engineId | String | The ID of the registered engine. |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
APIClassificationConfig updateApiClassification(apIClassificationConfig)
Update the api classification to new version.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
APIClassificationConfig apIClassificationConfig = new APIClassificationConfig(); // APIClassificationConfig | Request to update api classification config.
try {
APIClassificationConfig result = apiInstance.updateApiClassification(apIClassificationConfig);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#updateApiClassification");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| apIClassificationConfig | APIClassificationConfig | Request to update api classification config. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
UpdateEngineAutoTaggingConfigResponse updateEngineAutoTaggingConfig(engineId, autoTaggingConfig)
Update the engine's auto tagging configuration.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
String engineId = "engineId_example"; // String | The ID of the registered engine.
AutoTaggingConfig autoTaggingConfig = new AutoTaggingConfig(); // AutoTaggingConfig | The auto tagging configuration.
try {
UpdateEngineAutoTaggingConfigResponse result = apiInstance.updateEngineAutoTaggingConfig(engineId, autoTaggingConfig);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#updateEngineAutoTaggingConfig");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| engineId | String | The ID of the registered engine. | |
| autoTaggingConfig | AutoTaggingConfig | The auto tagging configuration. |
UpdateEngineAutoTaggingConfigResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
LDAPConfigParams updateLdapConfig(ldAPConfigParams)
Update LDAP Config.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
LDAPConfigParams ldAPConfigParams = new LDAPConfigParams(); // LDAPConfigParams | The parameters to update the LDAP config.
try {
LDAPConfigParams result = apiInstance.updateLdapConfig(ldAPConfigParams);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#updateLdapConfig");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ldAPConfigParams | LDAPConfigParams | The parameters to update the LDAP config. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
GlobalProperties updateProperties(globalProperties)
Update value of predefined properties.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
GlobalProperties globalProperties = new GlobalProperties(); // GlobalProperties | The parameters to update property value.
try {
GlobalProperties result = apiInstance.updateProperties(globalProperties);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#updateProperties");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| globalProperties | GlobalProperties | The parameters to update property value. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
ProxyConfiguration updateProxyConfiguration(proxyConfiguration)
Update the web proxy configuration to use to connect to Delphix services.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
ProxyConfiguration proxyConfiguration = new ProxyConfiguration(); // ProxyConfiguration |
try {
ProxyConfiguration result = apiInstance.updateProxyConfiguration(proxyConfiguration);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#updateProxyConfiguration");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| proxyConfiguration | ProxyConfiguration |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Update the web proxy configuration to use to connect to Delphix services | - |
RegisteredEngine updateRegisteredEngine(engineId, registeredEngine)
Update a registered engine.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
String engineId = "engineId_example"; // String | The ID of the registered engine.
RegisteredEngine registeredEngine = new RegisteredEngine(); // RegisteredEngine | The updated registration engine information.
try {
RegisteredEngine result = apiInstance.updateRegisteredEngine(engineId, registeredEngine);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#updateRegisteredEngine");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| engineId | String | The ID of the registered engine. | |
| registeredEngine | RegisteredEngine | The updated registration engine information. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
RegisteredEngine updateRegisteredEnginePartial(engineId, registeredEngine)
Update a registered engine.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
String engineId = "engineId_example"; // String | The ID of the registered engine.
RegisteredEngine registeredEngine = new RegisteredEngine(); // RegisteredEngine | The updated registration engine information.
try {
RegisteredEngine result = apiInstance.updateRegisteredEnginePartial(engineId, registeredEngine);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#updateRegisteredEnginePartial");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| engineId | String | The ID of the registered engine. | |
| registeredEngine | RegisteredEngine | The updated registration engine information. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
SAMLConfigParams updateSamlConfig(saMLConfigParams)
Update SAML Config.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
SAMLConfigParams saMLConfigParams = new SAMLConfigParams(); // SAMLConfigParams | The parameters to update the SAML config.
try {
SAMLConfigParams result = apiInstance.updateSamlConfig(saMLConfigParams);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#updateSamlConfig");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| saMLConfigParams | SAMLConfigParams | The parameters to update the SAML config. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
SMTPConfigParams updateSmtpConfig(smTPConfigParams)
Update SMTP Config.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
SMTPConfigParams smTPConfigParams = new SMTPConfigParams(); // SMTPConfigParams | The parameters to update the SMTP config.
try {
SMTPConfigParams result = apiInstance.updateSmtpConfig(smTPConfigParams);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#updateSmtpConfig");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| smTPConfigParams | SMTPConfigParams | The parameters to update the SMTP config. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
LdapValidateResponse validateLdapConfig(ldapConfigValidateParameter)
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.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
LdapConfigValidateParameter ldapConfigValidateParameter = new LdapConfigValidateParameter(); // LdapConfigValidateParameter |
try {
LdapValidateResponse result = apiInstance.validateLdapConfig(ldapConfigValidateParameter);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#validateLdapConfig");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ldapConfigValidateParameter | LdapConfigValidateParameter | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
validateSmtpConfig(smTPConfigValidate)
Validate SMTP Config.
// 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.ManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ManagementApi apiInstance = new ManagementApi(defaultClient);
SMTPConfigValidate smTPConfigValidate = new SMTPConfigValidate(); // SMTPConfigValidate | The parameters to validate the SMTP config.
try {
apiInstance.validateSmtpConfig(smTPConfigValidate);
} catch (ApiException e) {
System.err.println("Exception when calling ManagementApi#validateSmtpConfig");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| smTPConfigValidate | SMTPConfigValidate | The parameters to validate the SMTP config. |
null (empty response body)
- Content-Type: application/json
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |