Delphix DCT API

Delphix DCT API
More information: https://support.delphix.com
Contact Info: support@delphix.com
Version: 3.1.0
BasePath:/v3
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true

Methods

[ Jump to Models ]

Table of Contents

Accounts

Authorization

Bookmarks

CDBs

Connectivity

Connectors

DSources

DatabaseTemplates

Environments

Executions

Jobs

Login

Management

MaskingJobs

Reporting

SamlLogin

Snapshots

Sources

VCDBs

VDBGroups

VDBs

Accounts

Up 
post /management/accounts/{id}/change_password
Change Account Password. (changeAccountPassword)

Path parameters

id (required)
Path Parameter — Numeric ID of the Account. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ChangePasswordParameter ChangePasswordParameter (required)
Body Parameter —

Responses

204

Password changed.
Up 
post /management/accounts
Create a new Account (createAccount)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AccountCreateParameter AccountCreateParameter (required)
Body Parameter —

Return type

AccountCreateResponse

Example data

Content-Type: application/json
{
  "last_name" : "last_name",
  "ldap_principal" : "ldap_principal",
  "id" : 0,
  "first_name" : "first_name",
  "email" : "email",
  "token" : "token",
  "username" : "username",
  "tags" : [ {
    "key" : "key-1",
    "value" : "value-1"
  }, {
    "key" : "key-2",
    "value" : "value-2"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

The created Account id and if requested the generated API key token. AccountCreateResponse
Up 
post /management/accounts/{id}/tags
Create tags for an Account. (createAccountTags)

Path parameters

id (required)
Path Parameter — Numeric ID of the Account. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TagsRequest TagsRequest (required)
Body Parameter —

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created TagsResponse
Up 
delete /management/accounts/{id}
Delete an Account (deleteAccount)

Path parameters

id (required)
Path Parameter — Numeric ID of the Account. default: null format: int64

Responses

204

No Content
Up 
post /management/accounts/{id}/tags/delete
Delete tags for an Account. (deleteAccountTags)

Path parameters

id (required)
Path Parameter — Numeric ID of the Account. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteTag DeleteTag (optional)
Body Parameter —

Responses

204

No Content
Up 
get /management/accounts/{id}
Get an Account by id (getAccount)

Path parameters

id (required)
Path Parameter — Numeric ID of the Account. default: null format: int64

Return type

Account

Example data

Content-Type: application/json
{
  "api_client_id" : "api_client_id",
  "effective_scopes" : [ {
    "name" : "name",
    "id" : "id"
  }, {
    "name" : "name",
    "id" : "id"
  } ],
  "last_name" : "last_name",
  "ldap_principal" : "ldap_principal",
  "id" : 0,
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username",
  "tags" : [ {
    "key" : "key-1",
    "value" : "value-1"
  }, {
    "key" : "key-2",
    "value" : "value-2"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Account
Up 
get /management/accounts/{id}/tags
Get tags for an Account. (getAccountTags)

Path parameters

id (required)
Path Parameter — Numeric ID of the Account. default: null format: int64

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ok TagsResponse
Up 
get /management/accounts
Returns a list of Accounts (getAccounts)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListAccountsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "api_client_id" : "api_client_id",
    "effective_scopes" : [ {
      "name" : "name",
      "id" : "id"
    }, {
      "name" : "name",
      "id" : "id"
    } ],
    "last_name" : "last_name",
    "ldap_principal" : "ldap_principal",
    "id" : 0,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "tags" : [ {
      "key" : "key-1",
      "value" : "value-1"
    }, {
      "key" : "key-2",
      "value" : "value-2"
    } ]
  }, {
    "api_client_id" : "api_client_id",
    "effective_scopes" : [ {
      "name" : "name",
      "id" : "id"
    }, {
      "name" : "name",
      "id" : "id"
    } ],
    "last_name" : "last_name",
    "ldap_principal" : "ldap_principal",
    "id" : 0,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "tags" : [ {
      "key" : "key-1",
      "value" : "value-1"
    }, {
      "key" : "key-2",
      "value" : "value-2"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListAccountsResponse
Up 
get /management/accounts/password-policies
Returns the password policies (getPasswordPolicies)

Return type

PasswordPoliciesParams

Example data

Content-Type: application/json
{
  "disallow_username_as_password" : false,
  "min_length" : 8,
  "reuse_disallow_limit" : 3,
  "special_character" : false,
  "lowercase_letter" : false,
  "uppercase_letter" : false,
  "enabled" : false,
  "maximum_password_attempts" : 3,
  "digit" : false
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PasswordPoliciesParams
Up 
post /management/accounts/{id}/reset_password
Reset Account Password. (resetAccountPassword)

Path parameters

id (required)
Path Parameter — Numeric ID of the Account. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ResetPasswordParameter ResetPasswordParameter (required)
Body Parameter —

Responses

204

Password reset.
Up 
post /management/accounts/search
Search for Accounts. (searchAccounts)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

SearchAccountsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "api_client_id" : "api_client_id",
    "effective_scopes" : [ {
      "name" : "name",
      "id" : "id"
    }, {
      "name" : "name",
      "id" : "id"
    } ],
    "last_name" : "last_name",
    "ldap_principal" : "ldap_principal",
    "id" : 0,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "tags" : [ {
      "key" : "key-1",
      "value" : "value-1"
    }, {
      "key" : "key-2",
      "value" : "value-2"
    } ]
  }, {
    "api_client_id" : "api_client_id",
    "effective_scopes" : [ {
      "name" : "name",
      "id" : "id"
    }, {
      "name" : "name",
      "id" : "id"
    } ],
    "last_name" : "last_name",
    "ldap_principal" : "ldap_principal",
    "id" : 0,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "tags" : [ {
      "key" : "key-1",
      "value" : "value-1"
    }, {
      "key" : "key-2",
      "value" : "value-2"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchAccountsResponse
Up 
put /management/accounts/{id}
Update an Account (updateAccount)

Path parameters

id (required)
Path Parameter — Numeric ID of the Account. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AccountUpdateParameter AccountUpdateParameter (required)
Body Parameter —

Return type

Account

Example data

Content-Type: application/json
{
  "api_client_id" : "api_client_id",
  "effective_scopes" : [ {
    "name" : "name",
    "id" : "id"
  }, {
    "name" : "name",
    "id" : "id"
  } ],
  "last_name" : "last_name",
  "ldap_principal" : "ldap_principal",
  "id" : 0,
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username",
  "tags" : [ {
    "key" : "key-1",
    "value" : "value-1"
  }, {
    "key" : "key-2",
    "value" : "value-2"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Returns the updated Account. Account
Up 
patch /management/accounts/password-policies
Update password policies. (updatePasswordPolicies)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PasswordPoliciesParams PasswordPoliciesParams (required)
Body Parameter —

Return type

PasswordPoliciesParams

Example data

Content-Type: application/json
{
  "disallow_username_as_password" : false,
  "min_length" : 8,
  "reuse_disallow_limit" : 3,
  "special_character" : false,
  "lowercase_letter" : false,
  "uppercase_letter" : false,
  "enabled" : false,
  "maximum_password_attempts" : 3,
  "digit" : false
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PasswordPoliciesParams

Authorization

Up 
post /access-groups/{accessGroupId}/account-ids
Add account ids to an Access group (addAccessGroupAccountIds)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AccessGroupAccountIdsRequest AccessGroupAccountIdsRequest (required)
Body Parameter —

Return type

AccessGroup

Example data

Content-Type: application/json
{
  "single_account" : true,
  "account_ids" : [ 0, 0 ],
  "tagged_account_ids" : [ 6, 6 ],
  "account_tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ],
  "name" : "name",
  "id" : "id",
  "scopes" : [ {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  }, {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The updated Access group. AccessGroup
Up 
post /access-groups/{accessGroupId}/tags
Add account tags to an Access group (addAccessGroupAccountTags)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TagsRequest TagsRequest (required)
Body Parameter —

Return type

AccessGroup

Example data

Content-Type: application/json
{
  "single_account" : true,
  "account_ids" : [ 0, 0 ],
  "tagged_account_ids" : [ 6, 6 ],
  "account_tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ],
  "name" : "name",
  "id" : "id",
  "scopes" : [ {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  }, {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The updated Access group. AccessGroup
Up 
post /access-groups/{accessGroupId}/scopes
Add scopes to an Access group (addAccessGroupScopes)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AccessGroupScopesRequest AccessGroupScopesRequest (required)
Body Parameter —

Return type

AccessGroup

Example data

Content-Type: application/json
{
  "single_account" : true,
  "account_ids" : [ 0, 0 ],
  "tagged_account_ids" : [ 6, 6 ],
  "account_tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ],
  "name" : "name",
  "id" : "id",
  "scopes" : [ {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  }, {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The updated Access group. AccessGroup
Up 
post /access-groups/{accessGroupId}/scopes/{scopeId}/always_allowed_permissions
Add always allowed permissions for given object type. (addAlwaysAllowedPermissions)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null
scopeId (required)
Path Parameter — The ID of the Access group scope. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AlwaysAllowedPermissionRequest AlwaysAllowedPermissionRequest (required)
Body Parameter —

Return type

AccessGroupScope

Example data

Content-Type: application/json
{
  "role_id" : "role_id",
  "object_tags" : [ {
    "object_type" : "VDB",
    "permission" : "READ",
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "object_type" : "VDB",
    "permission" : "READ",
    "value" : "value-1",
    "key" : "key-1"
  } ],
  "objects" : [ {
    "object_type" : "VDB",
    "permission" : "READ",
    "object_id" : "1-VDB-OBJECT-ID"
  }, {
    "object_type" : "VDB",
    "permission" : "READ",
    "object_id" : "1-VDB-OBJECT-ID"
  } ],
  "name" : "name",
  "always_allowed_permissions" : [ {
    "object_type" : "VDB",
    "permission" : "READ"
  }, {
    "object_type" : "VDB",
    "permission" : "READ"
  } ],
  "id" : "id",
  "scope_type" : "SCOPED"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The access group scope. AccessGroupScope
Up 
post /access-groups/{accessGroupId}/scopes/{scopeId}/objects
Add objects to the access group scope. (addObjectsToAccessGroupScope)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null
scopeId (required)
Path Parameter — The ID of the Access group scope. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ScopedObjectsRequest ScopedObjectsRequest (required)
Body Parameter —

Return type

ScopedObjectItemsResponse

Example data

Content-Type: application/json
{
  "objects" : [ {
    "object_type" : "VDB",
    "permission" : "READ",
    "object_id" : "1-VDB-OBJECT-ID"
  }, {
    "object_type" : "VDB",
    "permission" : "READ",
    "object_id" : "1-VDB-OBJECT-ID"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created ScopedObjectItemsResponse
Up 
post /roles/{roleId}/permissions
Add permissions to a role. (addRolePermissions)

Path parameters

roleId (required)
Path Parameter — The ID of the role. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PermissionsRequest PermissionsRequest (required)
Body Parameter —

Return type

Role

Example data

Content-Type: application/json
null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The updated role. Role
Up 
post /access-groups/{accessGroupId}/scopes/{scopeId}/object-tags
Add object tags to the access group scope. (addTagsToScope)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null
scopeId (required)
Path Parameter — The ID of the Access group scope. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ScopeTagsRequest ScopeTagsRequest (required)
Body Parameter —

Return type

ScopeTagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "object_type" : "VDB",
    "permission" : "READ",
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "object_type" : "VDB",
    "permission" : "READ",
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created ScopeTagsResponse
Up 
post /access-groups
Create a new access group. (createAccessGroup)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AccessGroup AccessGroup (required)
Body Parameter —

Return type

AccessGroup

Example data

Content-Type: application/json
{
  "single_account" : true,
  "account_ids" : [ 0, 0 ],
  "tagged_account_ids" : [ 6, 6 ],
  "account_tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ],
  "name" : "name",
  "id" : "id",
  "scopes" : [ {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  }, {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Returns the newly created access group. AccessGroup
Up 
post /roles
Create custom role (createRole)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateRole CreateRole (optional)
Body Parameter —

Return type

Role

Example data

Content-Type: application/json
null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Returns the newly created role. Role
Up 
delete /access-groups/{accessGroupId}
Delete an Access group. (deleteAccessGroup)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null

Responses

204

No Content
Up 
post /access-groups/{accessGroupId}/scopes/{scopeId}/object-tags/delete
Remove tags from the access group scope. (deleteAccessGroupScopeObjectTags)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null
scopeId (required)
Path Parameter — The ID of the Access group scope. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteScopeObjectTags DeleteScopeObjectTags (optional)
Body Parameter —

Return type

ScopeTagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "object_type" : "VDB",
    "permission" : "READ",
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "object_type" : "VDB",
    "permission" : "READ",
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created ScopeTagsResponse
Up 
post /access-groups/{accessGroupId}/scopes/{scopeId}/objects/delete
Remove objects from the access group scope. (deleteAccessGroupScopeObjects)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null
scopeId (required)
Path Parameter — The ID of the Access group scope. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteScopedObjectItem DeleteScopedObjectItem (optional)
Body Parameter —

Return type

ScopedObjectItemsResponse

Example data

Content-Type: application/json
{
  "objects" : [ {
    "object_type" : "VDB",
    "permission" : "READ",
    "object_id" : "1-VDB-OBJECT-ID"
  }, {
    "object_type" : "VDB",
    "permission" : "READ",
    "object_id" : "1-VDB-OBJECT-ID"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created ScopedObjectItemsResponse
Up 
delete /roles/{roleId}
Delete role by ID. (deleteRole)

Path parameters

roleId (required)
Path Parameter — The ID of the role. default: null

Responses

204

No Content
Up 
get /access-groups/{accessGroupId}
Returns an Access group by ID. (getAccessGroupById)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null

Return type

AccessGroup

Example data

Content-Type: application/json
{
  "single_account" : true,
  "account_ids" : [ 0, 0 ],
  "tagged_account_ids" : [ 6, 6 ],
  "account_tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ],
  "name" : "name",
  "id" : "id",
  "scopes" : [ {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  }, {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AccessGroup
Up 
get /access-groups/{accessGroupId}/scopes/{scopeId}
Get access group scope. (getAccessGroupScope)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null
scopeId (required)
Path Parameter — The ID of the Access group scope. default: null

Return type

AccessGroupScope

Example data

Content-Type: application/json
{
  "role_id" : "role_id",
  "object_tags" : [ {
    "object_type" : "VDB",
    "permission" : "READ",
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "object_type" : "VDB",
    "permission" : "READ",
    "value" : "value-1",
    "key" : "key-1"
  } ],
  "objects" : [ {
    "object_type" : "VDB",
    "permission" : "READ",
    "object_id" : "1-VDB-OBJECT-ID"
  }, {
    "object_type" : "VDB",
    "permission" : "READ",
    "object_id" : "1-VDB-OBJECT-ID"
  } ],
  "name" : "name",
  "always_allowed_permissions" : [ {
    "object_type" : "VDB",
    "permission" : "READ"
  }, {
    "object_type" : "VDB",
    "permission" : "READ"
  } ],
  "id" : "id",
  "scope_type" : "SCOPED"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The access group scope. AccessGroupScope
Up 
get /access-groups
List all access groups. (getAccessGroups)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListAccessGroupsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "single_account" : true,
    "account_ids" : [ 0, 0 ],
    "tagged_account_ids" : [ 6, 6 ],
    "account_tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "name" : "name",
    "id" : "id",
    "scopes" : [ {
      "role_id" : "role_id",
      "object_tags" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      } ],
      "objects" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      } ],
      "name" : "name",
      "always_allowed_permissions" : [ {
        "object_type" : "VDB",
        "permission" : "READ"
      }, {
        "object_type" : "VDB",
        "permission" : "READ"
      } ],
      "id" : "id",
      "scope_type" : "SCOPED"
    }, {
      "role_id" : "role_id",
      "object_tags" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      } ],
      "objects" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      } ],
      "name" : "name",
      "always_allowed_permissions" : [ {
        "object_type" : "VDB",
        "permission" : "READ"
      }, {
        "object_type" : "VDB",
        "permission" : "READ"
      } ],
      "id" : "id",
      "scope_type" : "SCOPED"
    } ]
  }, {
    "single_account" : true,
    "account_ids" : [ 0, 0 ],
    "tagged_account_ids" : [ 6, 6 ],
    "account_tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "name" : "name",
    "id" : "id",
    "scopes" : [ {
      "role_id" : "role_id",
      "object_tags" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      } ],
      "objects" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      } ],
      "name" : "name",
      "always_allowed_permissions" : [ {
        "object_type" : "VDB",
        "permission" : "READ"
      }, {
        "object_type" : "VDB",
        "permission" : "READ"
      } ],
      "id" : "id",
      "scope_type" : "SCOPED"
    }, {
      "role_id" : "role_id",
      "object_tags" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      } ],
      "objects" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      } ],
      "name" : "name",
      "always_allowed_permissions" : [ {
        "object_type" : "VDB",
        "permission" : "READ"
      }, {
        "object_type" : "VDB",
        "permission" : "READ"
      } ],
      "id" : "id",
      "scope_type" : "SCOPED"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListAccessGroupsResponse
Up 
get /auth/object-permissions
Returns all of the possible permissions for all of the objects. (getAllObjectPermissions)

Return type

AllObjectPermissionsResponse

Example data

Content-Type: application/json
{
  "object_permissions" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AllObjectPermissionsResponse
Up 
get /auth/permissions/objects/{objectType}/{objectId}
Returns permissions for given object. (getObjectPermissions)

Path parameters

objectType (required)
Path Parameter — The type of the DCT object. default: null
objectId (required)
Path Parameter — The ID of the DCT Object. default: null

Return type

ObjectPermissionsResponse

Example data

Content-Type: application/json
{
  "accounts" : [ {
    "last_name" : "last_name",
    "access_groups" : [ {
      "permissions" : [ "permissions", "permissions" ],
      "name" : "name",
      "id" : "id"
    }, {
      "permissions" : [ "permissions", "permissions" ],
      "name" : "name",
      "id" : "id"
    } ],
    "id" : 0,
    "first_name" : "first_name",
    "email" : "email"
  }, {
    "last_name" : "last_name",
    "access_groups" : [ {
      "permissions" : [ "permissions", "permissions" ],
      "name" : "name",
      "id" : "id"
    }, {
      "permissions" : [ "permissions", "permissions" ],
      "name" : "name",
      "id" : "id"
    } ],
    "id" : 0,
    "first_name" : "first_name",
    "email" : "email"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ObjectPermissionsResponse
Up 
get /roles/{roleId}
Returns role by ID. (getRoleById)

Path parameters

roleId (required)
Path Parameter — The ID of the role. default: null

Return type

Role

Example data

Content-Type: application/json
null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Role
Up 
get /roles
List all roles (getRoles)

Return type

ListRolesResponse

Example data

Content-Type: application/json
{
  "items" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListRolesResponse
Up 
delete /access-groups/{accessGroupId}/account-ids/{accountId}
Remove the account from the access group. (removeAccessGroupAccountId)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null
accountId (required)
Path Parameter — The ID of the account. default: null format: int64

Return type

AccessGroup

Example data

Content-Type: application/json
{
  "single_account" : true,
  "account_ids" : [ 0, 0 ],
  "tagged_account_ids" : [ 6, 6 ],
  "account_tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ],
  "name" : "name",
  "id" : "id",
  "scopes" : [ {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  }, {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The updated Access group. AccessGroup
Up 
post /access-groups/{accessGroupId}/tags/delete
Remove account tags from an access group. (removeAccessGroupAccountTags)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteTag DeleteTag (optional)
Body Parameter —

Return type

AccessGroup

Example data

Content-Type: application/json
{
  "single_account" : true,
  "account_ids" : [ 0, 0 ],
  "tagged_account_ids" : [ 6, 6 ],
  "account_tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ],
  "name" : "name",
  "id" : "id",
  "scopes" : [ {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  }, {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The updated Access group. AccessGroup
Up 
delete /access-groups/{accessGroupId}/scopes/{scopeId}
Remove the scope from the Access group. (removeAccessGroupScope)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null
scopeId (required)
Path Parameter — The ID of the Access group scope. default: null

Return type

AccessGroup

Example data

Content-Type: application/json
{
  "single_account" : true,
  "account_ids" : [ 0, 0 ],
  "tagged_account_ids" : [ 6, 6 ],
  "account_tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ],
  "name" : "name",
  "id" : "id",
  "scopes" : [ {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  }, {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The updated Access group. AccessGroup
Up 
post /access-groups/{accessGroupId}/scopes/{scopeId}/always_allowed_permissions/delete
Remove always allowed permissions for given object type. (removeAlwaysAllowedPermissions)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null
scopeId (required)
Path Parameter — The ID of the Access group scope. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AlwaysAllowedPermissionRequest AlwaysAllowedPermissionRequest (required)
Body Parameter —

Return type

AccessGroupScope

Example data

Content-Type: application/json
{
  "role_id" : "role_id",
  "object_tags" : [ {
    "object_type" : "VDB",
    "permission" : "READ",
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "object_type" : "VDB",
    "permission" : "READ",
    "value" : "value-1",
    "key" : "key-1"
  } ],
  "objects" : [ {
    "object_type" : "VDB",
    "permission" : "READ",
    "object_id" : "1-VDB-OBJECT-ID"
  }, {
    "object_type" : "VDB",
    "permission" : "READ",
    "object_id" : "1-VDB-OBJECT-ID"
  } ],
  "name" : "name",
  "always_allowed_permissions" : [ {
    "object_type" : "VDB",
    "permission" : "READ"
  }, {
    "object_type" : "VDB",
    "permission" : "READ"
  } ],
  "id" : "id",
  "scope_type" : "SCOPED"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The access group scope. AccessGroupScope
Up 
post /roles/{roleId}/permissions/delete
Remove permissions from a role. (removeRolePermissions)

Path parameters

roleId (required)
Path Parameter — The ID of the role. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PermissionsRequest PermissionsRequest (required)
Body Parameter —

Return type

Role

Example data

Content-Type: application/json
null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The updated role. Role
Up 
post /access-groups/search
Search for access groups. (searchAccessGroups)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

SearchAccessGroupsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "single_account" : true,
    "account_ids" : [ 0, 0 ],
    "tagged_account_ids" : [ 6, 6 ],
    "account_tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "name" : "name",
    "id" : "id",
    "scopes" : [ {
      "role_id" : "role_id",
      "object_tags" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      } ],
      "objects" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      } ],
      "name" : "name",
      "always_allowed_permissions" : [ {
        "object_type" : "VDB",
        "permission" : "READ"
      }, {
        "object_type" : "VDB",
        "permission" : "READ"
      } ],
      "id" : "id",
      "scope_type" : "SCOPED"
    }, {
      "role_id" : "role_id",
      "object_tags" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      } ],
      "objects" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      } ],
      "name" : "name",
      "always_allowed_permissions" : [ {
        "object_type" : "VDB",
        "permission" : "READ"
      }, {
        "object_type" : "VDB",
        "permission" : "READ"
      } ],
      "id" : "id",
      "scope_type" : "SCOPED"
    } ]
  }, {
    "single_account" : true,
    "account_ids" : [ 0, 0 ],
    "tagged_account_ids" : [ 6, 6 ],
    "account_tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "name" : "name",
    "id" : "id",
    "scopes" : [ {
      "role_id" : "role_id",
      "object_tags" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      } ],
      "objects" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      } ],
      "name" : "name",
      "always_allowed_permissions" : [ {
        "object_type" : "VDB",
        "permission" : "READ"
      }, {
        "object_type" : "VDB",
        "permission" : "READ"
      } ],
      "id" : "id",
      "scope_type" : "SCOPED"
    }, {
      "role_id" : "role_id",
      "object_tags" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "value" : "value-1",
        "key" : "key-1"
      } ],
      "objects" : [ {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      }, {
        "object_type" : "VDB",
        "permission" : "READ",
        "object_id" : "1-VDB-OBJECT-ID"
      } ],
      "name" : "name",
      "always_allowed_permissions" : [ {
        "object_type" : "VDB",
        "permission" : "READ"
      }, {
        "object_type" : "VDB",
        "permission" : "READ"
      } ],
      "id" : "id",
      "scope_type" : "SCOPED"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchAccessGroupsResponse
Up 
post /roles/search
Search for roles. (searchRoles)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

SearchRolesResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchRolesResponse
Up 
patch /access-groups/{accessGroupId}
Update an Access group. (updateAccessGroup)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AccessGroupUpdateParameters AccessGroupUpdateParameters (optional)
Body Parameter —

Return type

AccessGroup

Example data

Content-Type: application/json
{
  "single_account" : true,
  "account_ids" : [ 0, 0 ],
  "tagged_account_ids" : [ 6, 6 ],
  "account_tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ],
  "name" : "name",
  "id" : "id",
  "scopes" : [ {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  }, {
    "role_id" : "role_id",
    "object_tags" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "value" : "value-1",
      "key" : "key-1"
    } ],
    "objects" : [ {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    }, {
      "object_type" : "VDB",
      "permission" : "READ",
      "object_id" : "1-VDB-OBJECT-ID"
    } ],
    "name" : "name",
    "always_allowed_permissions" : [ {
      "object_type" : "VDB",
      "permission" : "READ"
    }, {
      "object_type" : "VDB",
      "permission" : "READ"
    } ],
    "id" : "id",
    "scope_type" : "SCOPED"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AccessGroup
Up 
patch /access-groups/{accessGroupId}/scopes/{scopeId}
Update access group scope. (updateAccessGroupScope)

Path parameters

accessGroupId (required)
Path Parameter — The ID of the Access group. default: null
scopeId (required)
Path Parameter — The ID of the Access group scope. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateAccessGroupScope UpdateAccessGroupScope (required)
Body Parameter —

Return type

AccessGroupScope

Example data

Content-Type: application/json
{
  "role_id" : "role_id",
  "object_tags" : [ {
    "object_type" : "VDB",
    "permission" : "READ",
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "object_type" : "VDB",
    "permission" : "READ",
    "value" : "value-1",
    "key" : "key-1"
  } ],
  "objects" : [ {
    "object_type" : "VDB",
    "permission" : "READ",
    "object_id" : "1-VDB-OBJECT-ID"
  }, {
    "object_type" : "VDB",
    "permission" : "READ",
    "object_id" : "1-VDB-OBJECT-ID"
  } ],
  "name" : "name",
  "always_allowed_permissions" : [ {
    "object_type" : "VDB",
    "permission" : "READ"
  }, {
    "object_type" : "VDB",
    "permission" : "READ"
  } ],
  "id" : "id",
  "scope_type" : "SCOPED"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The updated access group scope. AccessGroupScope
Up 
patch /roles/{roleId}
Update a Role. (updateRole)

Path parameters

roleId (required)
Path Parameter — The ID of the role. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

RoleUpdateParameters RoleUpdateParameters (optional)
Body Parameter —

Return type

Role

Example data

Content-Type: application/json
null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Role

Bookmarks

Up 
post /bookmarks
Create a bookmark at the current time. (createBookmark)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

BookmarkCreateParameters BookmarkCreateParameters (required)
Body Parameter —

Return type

CreateBookmarkResponse

Example data

Content-Type: application/json
{
  "bookmark" : {
    "name" : "my-bookmark-123",
    "vdb_ids" : [ "vdb-123", "vdb-456" ],
    "id" : "bookmark-123",
    "creation_date" : "2021-07-04T08:51:34.148Z",
    "retention" : 365,
    "status" : "RESTORED",
    "tags" : [ {
      "key" : "key-1",
      "value" : "value-1"
    }, {
      "key" : "key-2",
      "value" : "value-2"
    } ]
  },
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

OK CreateBookmarkResponse
Up 
post /bookmarks/{bookmarkId}/tags
Create tags for a Bookmark. (createBookmarkTags)

Path parameters

bookmarkId (required)
Path Parameter — The ID of the Bookmark. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TagsRequest TagsRequest (required)
Body Parameter —

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created TagsResponse
Up 
delete /bookmarks/{bookmarkId}
Delete a bookmark. (deleteBookmark)

Path parameters

bookmarkId (required)
Path Parameter — The ID of the Bookmark. default: null

Responses

204

No Content
Up 
post /bookmarks/{bookmarkId}/tags/delete
Delete tags for a Bookmark. (deleteBookmarkTags)

Path parameters

bookmarkId (required)
Path Parameter — The ID of the Bookmark. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteTag DeleteTag (optional)
Body Parameter —

Responses

204

No Content
Up 
get /bookmarks/{bookmarkId}
Get a bookmark by ID. (getBookmarkById)

Path parameters

bookmarkId (required)
Path Parameter — The ID of the Bookmark. default: null

Return type

Bookmark

Example data

Content-Type: application/json
{
  "name" : "my-bookmark-123",
  "vdb_ids" : [ "vdb-123", "vdb-456" ],
  "id" : "bookmark-123",
  "creation_date" : "2021-07-04T08:51:34.148Z",
  "retention" : 365,
  "status" : "RESTORED",
  "tags" : [ {
    "key" : "key-1",
    "value" : "value-1"
  }, {
    "key" : "key-2",
    "value" : "value-2"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Bookmark
Up 
get /bookmarks/{bookmarkId}/tags
Get tags for a Bookmark. (getBookmarkTags)

Path parameters

bookmarkId (required)
Path Parameter — The ID of the Bookmark. default: null

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ok TagsResponse
Up 
get /bookmarks
List all bookmarks. (getBookmarks)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListBookmarksResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "name" : "my-bookmark-123",
    "vdb_ids" : [ "vdb-123", "vdb-456" ],
    "id" : "bookmark-123",
    "creation_date" : "2021-07-04T08:51:34.148Z",
    "retention" : 365,
    "status" : "RESTORED",
    "tags" : [ {
      "key" : "key-1",
      "value" : "value-1"
    }, {
      "key" : "key-2",
      "value" : "value-2"
    } ]
  }, {
    "name" : "my-bookmark-123",
    "vdb_ids" : [ "vdb-123", "vdb-456" ],
    "id" : "bookmark-123",
    "creation_date" : "2021-07-04T08:51:34.148Z",
    "retention" : 365,
    "status" : "RESTORED",
    "tags" : [ {
      "key" : "key-1",
      "value" : "value-1"
    }, {
      "key" : "key-2",
      "value" : "value-2"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListBookmarksResponse
Up 
get /bookmarks/{bookmarkId}/vdb-groups
List VDB Groups compatible with this bookmark. (getVdbGroupsByBookmark)

Path parameters

bookmarkId (required)
Path Parameter — The ID of the Bookmark. default: null

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListVDBGroupsByBookmarkResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "name" : "my-first-vdb-group",
    "vdb_ids" : [ "vdb-123", "vdb-456" ],
    "id" : "123",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  }, {
    "name" : "my-first-vdb-group",
    "vdb_ids" : [ "vdb-123", "vdb-456" ],
    "id" : "123",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListVDBGroupsByBookmarkResponse
Up 
post /bookmarks/search
Search for bookmarks. (searchBookmarks)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

SearchBookmarksResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "name" : "my-bookmark-123",
    "vdb_ids" : [ "vdb-123", "vdb-456" ],
    "id" : "bookmark-123",
    "creation_date" : "2021-07-04T08:51:34.148Z",
    "retention" : 365,
    "status" : "RESTORED",
    "tags" : [ {
      "key" : "key-1",
      "value" : "value-1"
    }, {
      "key" : "key-2",
      "value" : "value-2"
    } ]
  }, {
    "name" : "my-bookmark-123",
    "vdb_ids" : [ "vdb-123", "vdb-456" ],
    "id" : "bookmark-123",
    "creation_date" : "2021-07-04T08:51:34.148Z",
    "retention" : 365,
    "status" : "RESTORED",
    "tags" : [ {
      "key" : "key-1",
      "value" : "value-1"
    }, {
      "key" : "key-2",
      "value" : "value-2"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchBookmarksResponse

CDBs

Up 
post /cdbs/{cdbId}/tags
Create tags for a CDB. (createCdbTags)

Path parameters

cdbId (required)
Path Parameter — The ID of the CDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TagsRequest TagsRequest (required)
Body Parameter —

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created TagsResponse
Up 
post /cdbs/{cdbId}/tags/delete
Delete tags for a CDB. (deleteCdbTags)

Path parameters

cdbId (required)
Path Parameter — The ID of the CDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteTag DeleteTag (optional)
Body Parameter —

Responses

204

No Content
Up 
get /cdbs/{cdbId}
Get a CDB by ID (Oracle only). (getCdbById)

Path parameters

cdbId (required)
Path Parameter — The ID of the CDB. default: null

Return type

CDB

Example data

Content-Type: application/json
{
  "environment_id" : "1-ENVIRONMENT-1",
  "size" : 339292672,
  "engine_id" : "engine-12",
  "name" : "Oracle CDB",
  "database_version" : "10.2.0.5.0",
  "id" : "1-CDB-1",
  "jdbc_connection_string" : "jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))",
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK CDB
Up 
get /cdbs
List all CDBs (Oracle only). (getCdbs)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListCDBsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "environment_id" : "1-ENVIRONMENT-1",
    "size" : 339292672,
    "engine_id" : "engine-12",
    "name" : "Oracle CDB",
    "database_version" : "10.2.0.5.0",
    "id" : "1-CDB-1",
    "jdbc_connection_string" : "jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  }, {
    "environment_id" : "1-ENVIRONMENT-1",
    "size" : 339292672,
    "engine_id" : "engine-12",
    "name" : "Oracle CDB",
    "database_version" : "10.2.0.5.0",
    "id" : "1-CDB-1",
    "jdbc_connection_string" : "jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListCDBsResponse
Up 
get /cdbs/{cdbId}/tags
Get tags for a CDB. (getTagsCdb)

Path parameters

cdbId (required)
Path Parameter — The ID of the CDB. default: null

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ok TagsResponse
Up 
post /cdbs/search
Search for CDBs (Oracle only). (searchCdbs)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

SearchCDBsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "environment_id" : "1-ENVIRONMENT-1",
    "size" : 339292672,
    "engine_id" : "engine-12",
    "name" : "Oracle CDB",
    "database_version" : "10.2.0.5.0",
    "id" : "1-CDB-1",
    "jdbc_connection_string" : "jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  }, {
    "environment_id" : "1-ENVIRONMENT-1",
    "size" : 339292672,
    "engine_id" : "engine-12",
    "name" : "Oracle CDB",
    "database_version" : "10.2.0.5.0",
    "id" : "1-CDB-1",
    "jdbc_connection_string" : "jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchCDBsResponse

Connectivity

Up 
post /connectivity/check
Checks connectivity between an engine and a remote host machine on a given port. (connectivityCheck)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConnectivityCheckParameters ConnectivityCheckParameters (required)
Body Parameter —

Return type

ConnectivityCheckResponse

Example data

Content-Type: application/json
{
  "message" : "Success!"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success ConnectivityCheckResponse

Connectors

Up 
post /connectors/{connectorId}/test
Checks connectivity between a masking engine and a remote data source. (connectorsTest)

Path parameters

connectorId (required)
Path Parameter — The ID of the Connector. default: null

Return type

ConnectorTestResponse

Example data

Content-Type: application/json
{
  "message" : "Connection Succeeded",
  "status" : "SUCCEEDED"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success ConnectorTestResponse
Up 
get /connectors/{connectorId}
Retrieve a masking Connector by ID. (getConnectorById)

Path parameters

connectorId (required)
Path Parameter — The ID of the Connector. default: null

Return type

Connector

Example data

Content-Type: application/json
{
  "id" : "1-database-123",
  "name" : "connector-name",
  "engine_id" : 123,
  "type" : "DATABASE",
  "hostname" : "database_server.mycompany.co",
  "port" : 4322,
  "username" : "user-123"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Connector
Up 
get /connectors
Retrieve the list of masking connectors. (getConnectors)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies a descending order. default: null

Return type

ListConnectorsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "id" : "1-database-123",
    "name" : "connector-name",
    "engine_id" : 123,
    "type" : "DATABASE",
    "hostname" : "database_server.mycompany.co",
    "port" : 4322,
    "username" : "user-123"
  }, {
    "id" : "1-database-123",
    "name" : "connector-name",
    "engine_id" : 123,
    "type" : "DATABASE",
    "hostname" : "database_server.mycompany.co",
    "port" : 4322,
    "username" : "user-123"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListConnectorsResponse
Up 
post /connectors/search
Search for masking Connectors. (searchConnectors)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies a descending order. default: null

Return type

SearchConnectorsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "id" : "1-database-123",
    "name" : "connector-name",
    "engine_id" : 123,
    "type" : "DATABASE",
    "hostname" : "database_server.mycompany.co",
    "port" : 4322,
    "username" : "user-123"
  }, {
    "id" : "1-database-123",
    "name" : "connector-name",
    "engine_id" : 123,
    "type" : "DATABASE",
    "hostname" : "database_server.mycompany.co",
    "port" : 4322,
    "username" : "user-123"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchConnectorsResponse
Up 
patch /connectors/{connectorId}
Update a masking Connector by ID. (updateConnectorById)

Path parameters

connectorId (required)
Path Parameter — The ID of the Connector. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConnectorUpdateParameters ConnectorUpdateParameters (optional)
Body Parameter —

Return type

UpdateConnectorResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK UpdateConnectorResponse

DSources

Up 
post /dsources/{dsourceId}/tags
Create tags for a dSource. (createTagsDsource)

Path parameters

dsourceId (required)
Path Parameter — The ID of the dSource. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TagsRequest TagsRequest (required)
Body Parameter —

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Ok TagsResponse
Up 
post /dsources/{dsourceId}/tags/delete
Delete tags for a dSource. (deleteTagsDsource)

Path parameters

dsourceId (required)
Path Parameter — The ID of the dSource. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteTag DeleteTag (optional)
Body Parameter —

Responses

204

No Content
Up 
get /dsources/{dsourceId}
Get a dSource by ID. (getDsourceById)

Path parameters

dsourceId (required)
Path Parameter — The ID of the dSource. default: null

Return type

DSource

Example data

Content-Type: application/json
{
  "id" : "dsource-123",
  "database_type" : "Oracle",
  "name" : "prod01-main",
  "database_version" : "10.2.0.5.0",
  "data_uuid" : "1734315df891991101eb96963535afa0",
  "storage_size" : 339292672,
  "plugin_version" : "1.0",
  "creation_date" : "2021-05-01T08:51:34.148000+00:00",
  "group_name" : "DSources",
  "enabled" : true,
  "engine_id" : "engine-123",
  "source_id" : "source-123",
  "status" : "RUNNING",
  "engine_name" : "engine-123-name",
  "cdb_id" : "cdb-123",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DSource
Up 
get /dsources/{dsourceId}/snapshots
List Snapshots for a dSource. (getDsourceSnapshots)

Path parameters

dsourceId (required)
Path Parameter — The ID of the dSource. default: null

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null

Return type

ListSnapshotsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "creation_time" : "2023-02-02T19:30:00.589Z",
    "temporary" : false,
    "ase_db_encryption_key" : "keyname",
    "start_timestamp" : "2021-05-01T08:51:34.148Z",
    "mssql_internal_version" : 706,
    "timezone" : "America/New_York,EST-0500",
    "mssql_empty_snapshot" : true,
    "timeflow_id" : "1-ORACLE_TIMEFLOW-1",
    "missing_non_logged_data" : false,
    "consistency" : "CONSISTENT",
    "start_location" : "1178883",
    "appdata_toolkit" : "APPDATA_TOOLKIT-1",
    "mssql_backup_set_uuid" : "54290b71-58cd-463d-bd62-7219d4c4d2d5",
    "id" : "snapshot-123",
    "retention" : -1,
    "timestamp" : "2021-05-01T08:51:34.148Z",
    "dataset_id" : "dataset-123",
    "mssql_backup_software_type" : "NATIVE",
    "oracle_from_physical_standby_vdb" : false,
    "oracle_redo_log_size_in_bytes" : 314572800,
    "version" : "11.2.0.4.0",
    "mssql_backup_location_type" : "BACKUP_SERVER",
    "appdata_metadata" : {
      "oracleHome" : "apps/tech_st/10.1.3"
    },
    "engine_id" : "1",
    "namespace" : "NAMESPACE-1",
    "name" : "@2023-02-02T14:30:00.589",
    "location" : "1178883"
  }, {
    "creation_time" : "2023-02-02T19:30:00.589Z",
    "temporary" : false,
    "ase_db_encryption_key" : "keyname",
    "start_timestamp" : "2021-05-01T08:51:34.148Z",
    "mssql_internal_version" : 706,
    "timezone" : "America/New_York,EST-0500",
    "mssql_empty_snapshot" : true,
    "timeflow_id" : "1-ORACLE_TIMEFLOW-1",
    "missing_non_logged_data" : false,
    "consistency" : "CONSISTENT",
    "start_location" : "1178883",
    "appdata_toolkit" : "APPDATA_TOOLKIT-1",
    "mssql_backup_set_uuid" : "54290b71-58cd-463d-bd62-7219d4c4d2d5",
    "id" : "snapshot-123",
    "retention" : -1,
    "timestamp" : "2021-05-01T08:51:34.148Z",
    "dataset_id" : "dataset-123",
    "mssql_backup_software_type" : "NATIVE",
    "oracle_from_physical_standby_vdb" : false,
    "oracle_redo_log_size_in_bytes" : 314572800,
    "version" : "11.2.0.4.0",
    "mssql_backup_location_type" : "BACKUP_SERVER",
    "appdata_metadata" : {
      "oracleHome" : "apps/tech_st/10.1.3"
    },
    "engine_id" : "1",
    "namespace" : "NAMESPACE-1",
    "name" : "@2023-02-02T14:30:00.589",
    "location" : "1178883"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListSnapshotsResponse
Up 
get /dsources
List all dSources. (getDsources)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListDSourcesResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "id" : "dsource-123",
    "database_type" : "Oracle",
    "name" : "prod01-main",
    "database_version" : "10.2.0.5.0",
    "data_uuid" : "1734315df891991101eb96963535afa0",
    "storage_size" : 339292672,
    "plugin_version" : "1.0",
    "creation_date" : "2021-05-01T08:51:34.148000+00:00",
    "group_name" : "DSources",
    "enabled" : true,
    "engine_id" : "engine-123",
    "source_id" : "source-123",
    "status" : "RUNNING",
    "engine_name" : "engine-123-name",
    "cdb_id" : "cdb-123",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ]
  }, {
    "id" : "dsource-123",
    "database_type" : "Oracle",
    "name" : "prod01-main",
    "database_version" : "10.2.0.5.0",
    "data_uuid" : "1734315df891991101eb96963535afa0",
    "storage_size" : 339292672,
    "plugin_version" : "1.0",
    "creation_date" : "2021-05-01T08:51:34.148000+00:00",
    "group_name" : "DSources",
    "enabled" : true,
    "engine_id" : "engine-123",
    "source_id" : "source-123",
    "status" : "RUNNING",
    "engine_name" : "engine-123-name",
    "cdb_id" : "cdb-123",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ]
  } ],
  "errors" : [ {
    "object_name" : "object_name",
    "message" : "message"
  }, {
    "object_name" : "object_name",
    "message" : "message"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListDSourcesResponse
Up 
get /dsources/{dsourceId}/tags
Get tags for a dSource. (getTagsDsource)

Path parameters

dsourceId (required)
Path Parameter — The ID of the dSource. default: null

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Created TagsResponse
Up 
post /dsources/search
Search for DSources. (searchDsources)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

SearchDSourcesResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "id" : "dsource-123",
    "database_type" : "Oracle",
    "name" : "prod01-main",
    "database_version" : "10.2.0.5.0",
    "data_uuid" : "1734315df891991101eb96963535afa0",
    "storage_size" : 339292672,
    "plugin_version" : "1.0",
    "creation_date" : "2021-05-01T08:51:34.148000+00:00",
    "group_name" : "DSources",
    "enabled" : true,
    "engine_id" : "engine-123",
    "source_id" : "source-123",
    "status" : "RUNNING",
    "engine_name" : "engine-123-name",
    "cdb_id" : "cdb-123",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ]
  }, {
    "id" : "dsource-123",
    "database_type" : "Oracle",
    "name" : "prod01-main",
    "database_version" : "10.2.0.5.0",
    "data_uuid" : "1734315df891991101eb96963535afa0",
    "storage_size" : 339292672,
    "plugin_version" : "1.0",
    "creation_date" : "2021-05-01T08:51:34.148000+00:00",
    "group_name" : "DSources",
    "enabled" : true,
    "engine_id" : "engine-123",
    "source_id" : "source-123",
    "status" : "RUNNING",
    "engine_name" : "engine-123-name",
    "cdb_id" : "cdb-123",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchDSourcesResponse
Up 
post /dsources/{dsourceId}/snapshots
Snapshot a DSource. (snapshotDsource)

Path parameters

dsourceId (required)
Path Parameter — The ID of the dSource. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DSourceSnapshotParameters DSourceSnapshotParameters (optional)
Body Parameter —

Return type

SnapshotDSourceResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

DSource snapshot initiated. SnapshotDSourceResponse

DatabaseTemplates

Up 
post /database-templates
Create a database template. (createDatabaseTemplate)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DatabaseTemplateCreateParameters DatabaseTemplateCreateParameters (required)
Body Parameter —

Return type

CreateDatabaseTemplateResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  },
  "database_template" : {
    "name" : "template-name",
    "description" : "Config params for prod01",
    "source_type" : "OracleVirtualSource",
    "id" : "1-database-template-123",
    "parameters" : {
      "confgName1" : "configValue1",
      "configName2" : "configValue2"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK CreateDatabaseTemplateResponse
Up 
delete /database-templates/{databaseTemplateId}
Delete a DatabaseTemplate by ID. (deleteDatabaseTemplate)

Path parameters

databaseTemplateId (required)
Path Parameter — The ID of the Database Template. default: null

Return type

DeleteDatabaseTemplateResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

DatabaseTemplate delete initiated. DeleteDatabaseTemplateResponse
Up 
get /database-templates/{databaseTemplateId}
Retrieve a DatabaseTemplate by ID. (getDatabaseTemplateById)

Path parameters

databaseTemplateId (required)
Path Parameter — The ID of the Database Template. default: null

Return type

DatabaseTemplate

Example data

Content-Type: application/json
{
  "name" : "template-name",
  "description" : "Config params for prod01",
  "source_type" : "OracleVirtualSource",
  "id" : "1-database-template-123",
  "parameters" : {
    "confgName1" : "configValue1",
    "configName2" : "configValue2"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DatabaseTemplate
Up 
get /database-templates
Retrieve the list of database templates. (getDatabaseTemplates)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListDatabaseTemplatesResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "name" : "template-name",
    "description" : "Config params for prod01",
    "source_type" : "OracleVirtualSource",
    "id" : "1-database-template-123",
    "parameters" : {
      "confgName1" : "configValue1",
      "configName2" : "configValue2"
    }
  }, {
    "name" : "template-name",
    "description" : "Config params for prod01",
    "source_type" : "OracleVirtualSource",
    "id" : "1-database-template-123",
    "parameters" : {
      "confgName1" : "configValue1",
      "configName2" : "configValue2"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListDatabaseTemplatesResponse
Up 
post /database-templates/import
Imports the database templates from an an engine. (importDatabaseTemplates)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

EngineIdBody EngineIdBody (required)
Body Parameter —

Responses

200

OK
Up 
post /database-templates/search
Search DatabaseTemplates. (searchDatabaseTemplates)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

SearchDatabaseTemplatesResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "name" : "template-name",
    "description" : "Config params for prod01",
    "source_type" : "OracleVirtualSource",
    "id" : "1-database-template-123",
    "parameters" : {
      "confgName1" : "configValue1",
      "configName2" : "configValue2"
    }
  }, {
    "name" : "template-name",
    "description" : "Config params for prod01",
    "source_type" : "OracleVirtualSource",
    "id" : "1-database-template-123",
    "parameters" : {
      "confgName1" : "configValue1",
      "configName2" : "configValue2"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchDatabaseTemplatesResponse
Up 
post /database-templates/undo-import
Undo an import of DatabaseTemplates on a engine. (undoImportDatabaseTemplates)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

EngineIdBody EngineIdBody (required)
Body Parameter —

Responses

200

OK
Up 
patch /database-templates/{databaseTemplateId}
Updates a DatabaseTemplate by ID (updateDatabaseTemplate)

Path parameters

databaseTemplateId (required)
Path Parameter — The ID of the Database Template. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateDatabaseTemplateParameters UpdateDatabaseTemplateParameters (optional)
Body Parameter —

Return type

UpdateDatabaseTemplateResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK UpdateDatabaseTemplateResponse

Environments

Up 
post /environments
Create an environment. (createEnvironment)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

EnvironmentCreateParameters EnvironmentCreateParameters (required)
Body Parameter —

Return type

CreateEnvironmentResponse

Example data

Content-Type: application/json
{
  "environment_id" : "host-environment-1",
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Environment creation initiated CreateEnvironmentResponse
Up 
post /environments/{environmentId}/tags
Create tags for an Environment. (createEnvironmentTags)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TagsRequest TagsRequest (required)
Body Parameter —

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created TagsResponse
Up 
post /environments/{environmentId}/users
Create environment user. (createEnvironmentUser)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

EnvironmentUserParams EnvironmentUserParams (optional)
Body Parameter —

Return type

CreateEnvironmentUserResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  },
  "user_ref" : "user-reference-1"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Environment user created CreateEnvironmentUserResponse
Up 
post /environments/{environmentId}/hosts
Create a new Host. (createHost)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

HostCreateParameters HostCreateParameters (required)
Body Parameter —

Return type

CreateHostResponse

Example data

Content-Type: application/json
{
  "cluster_node_id" : "ORACLE_CLUSTER_NODE-7",
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Host Creation initiated CreateHostResponse
Up 
delete /environments/{environmentId}
Delete an environment by ID. (deleteEnvironment)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null

Return type

DeleteEnvironmentResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DeleteEnvironmentResponse
Up 
post /environments/{environmentId}/tags/delete
Delete tags for an Environment. (deleteEnvironmentTags)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteTag DeleteTag (optional)
Body Parameter —

Responses

204

No Content
Up 
delete /environments/{environmentId}/users/{userRef}
Delete environment user. (deleteEnvironmentUser)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null
userRef (required)
Path Parameter — Environment user reference. default: null

Return type

DeleteEnvironmentUserResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DeleteEnvironmentUserResponse
Up 
delete /environments/{environmentId}/hosts/{hostId}
Delete a Host. (deleteHost)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null
hostId (required)
Path Parameter — The ID of the host. default: null

Return type

DeleteHostResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

OK DeleteHostResponse
Up 
post /environments/{environmentId}/disable
Disable environment. (disableEnvironment)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null

Return type

DisableEnvironmentResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DisableEnvironmentResponse
Up 
post /environments/{environmentId}/enable
Enable a disabled environment. (enableEnvironment)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null

Return type

EnableEnvironmentResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK EnableEnvironmentResponse
Up 
get /environments/{environmentId}
Returns an environment by ID. (getEnvironmentById)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null

Return type

Environment

Example data

Content-Type: application/json
{
  "is_cluster" : false,
  "engine_id" : "engine-123",
  "repositories" : [ {
    "owner" : "owner",
    "fulltext_installed" : true,
    "bits" : 0,
    "ports" : [ 6, 6 ],
    "version" : "version",
    "dump_history_file" : "dump_history_file",
    "allow_provisioning" : true,
    "installation_path" : "installation_path",
    "database_type" : "database_type",
    "oracle_base" : "oracle_base",
    "internal_version" : 5,
    "is_staging" : true,
    "rac" : true,
    "name" : "name",
    "install_group" : "install_group",
    "id" : "id",
    "install_user" : "install_user",
    "page_size" : 1
  }, {
    "owner" : "owner",
    "fulltext_installed" : true,
    "bits" : 0,
    "ports" : [ 6, 6 ],
    "version" : "version",
    "dump_history_file" : "dump_history_file",
    "allow_provisioning" : true,
    "installation_path" : "installation_path",
    "database_type" : "database_type",
    "oracle_base" : "oracle_base",
    "internal_version" : 5,
    "is_staging" : true,
    "rac" : true,
    "name" : "name",
    "install_group" : "install_group",
    "id" : "id",
    "install_user" : "install_user",
    "page_size" : 1
  } ],
  "hosts" : [ {
    "os_version" : "Red Hat Enterprise Linux Server release 7.3 (Maipo)",
    "available" : false,
    "oracle_cluster_node_name" : "my-favorite-cluster-node",
    "windows_cluster_node_reference" : "WINDOWS_CLUSTER_NODE-1",
    "oracle_cluster_node_reference" : "ORACLE_CLUSTER_NODE-1",
    "oracle_cluster_node_virtual_ips" : [ {
      "domain_name" : "virtual.domain.com",
      "discovered" : true,
      "ip" : "192.168.0.1"
    }, {
      "domain_name" : "virtual.domain.com",
      "discovered" : true,
      "ip" : "192.168.0.1"
    } ],
    "memory_size" : 8382160896,
    "hostname" : "linux.dev.delphix.com",
    "oracle_cluster_node_discovered" : true,
    "windows_cluster_node_discovered" : true,
    "available_timestamp" : "2022-06-02T17:49:11.457Z",
    "windows_cluster_node_name" : "my-favorite-cluster-node",
    "os_name" : "Linux",
    "not_available_reason" : "Failed to connect to host",
    "oracle_cluster_node_enabled" : true,
    "id" : "3-UNIX_HOST-5"
  }, {
    "os_version" : "Red Hat Enterprise Linux Server release 7.3 (Maipo)",
    "available" : false,
    "oracle_cluster_node_name" : "my-favorite-cluster-node",
    "windows_cluster_node_reference" : "WINDOWS_CLUSTER_NODE-1",
    "oracle_cluster_node_reference" : "ORACLE_CLUSTER_NODE-1",
    "oracle_cluster_node_virtual_ips" : [ {
      "domain_name" : "virtual.domain.com",
      "discovered" : true,
      "ip" : "192.168.0.1"
    }, {
      "domain_name" : "virtual.domain.com",
      "discovered" : true,
      "ip" : "192.168.0.1"
    } ],
    "memory_size" : 8382160896,
    "hostname" : "linux.dev.delphix.com",
    "oracle_cluster_node_discovered" : true,
    "windows_cluster_node_discovered" : true,
    "available_timestamp" : "2022-06-02T17:49:11.457Z",
    "windows_cluster_node_name" : "my-favorite-cluster-node",
    "os_name" : "Linux",
    "not_available_reason" : "Failed to connect to host",
    "oracle_cluster_node_enabled" : true,
    "id" : "3-UNIX_HOST-5"
  } ],
  "name" : "Linux Test Host",
  "namespace" : "NAMESPACE-1",
  "id" : "environment-123",
  "enabled" : true,
  "is_windows_target" : false,
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Environment
Up 
get /environments
List all environments. (getEnvironments)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListEnvironmentsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "is_cluster" : false,
    "engine_id" : "engine-123",
    "repositories" : [ {
      "owner" : "owner",
      "fulltext_installed" : true,
      "bits" : 0,
      "ports" : [ 6, 6 ],
      "version" : "version",
      "dump_history_file" : "dump_history_file",
      "allow_provisioning" : true,
      "installation_path" : "installation_path",
      "database_type" : "database_type",
      "oracle_base" : "oracle_base",
      "internal_version" : 5,
      "is_staging" : true,
      "rac" : true,
      "name" : "name",
      "install_group" : "install_group",
      "id" : "id",
      "install_user" : "install_user",
      "page_size" : 1
    }, {
      "owner" : "owner",
      "fulltext_installed" : true,
      "bits" : 0,
      "ports" : [ 6, 6 ],
      "version" : "version",
      "dump_history_file" : "dump_history_file",
      "allow_provisioning" : true,
      "installation_path" : "installation_path",
      "database_type" : "database_type",
      "oracle_base" : "oracle_base",
      "internal_version" : 5,
      "is_staging" : true,
      "rac" : true,
      "name" : "name",
      "install_group" : "install_group",
      "id" : "id",
      "install_user" : "install_user",
      "page_size" : 1
    } ],
    "hosts" : [ {
      "os_version" : "Red Hat Enterprise Linux Server release 7.3 (Maipo)",
      "available" : false,
      "oracle_cluster_node_name" : "my-favorite-cluster-node",
      "windows_cluster_node_reference" : "WINDOWS_CLUSTER_NODE-1",
      "oracle_cluster_node_reference" : "ORACLE_CLUSTER_NODE-1",
      "oracle_cluster_node_virtual_ips" : [ {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      }, {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      } ],
      "memory_size" : 8382160896,
      "hostname" : "linux.dev.delphix.com",
      "oracle_cluster_node_discovered" : true,
      "windows_cluster_node_discovered" : true,
      "available_timestamp" : "2022-06-02T17:49:11.457Z",
      "windows_cluster_node_name" : "my-favorite-cluster-node",
      "os_name" : "Linux",
      "not_available_reason" : "Failed to connect to host",
      "oracle_cluster_node_enabled" : true,
      "id" : "3-UNIX_HOST-5"
    }, {
      "os_version" : "Red Hat Enterprise Linux Server release 7.3 (Maipo)",
      "available" : false,
      "oracle_cluster_node_name" : "my-favorite-cluster-node",
      "windows_cluster_node_reference" : "WINDOWS_CLUSTER_NODE-1",
      "oracle_cluster_node_reference" : "ORACLE_CLUSTER_NODE-1",
      "oracle_cluster_node_virtual_ips" : [ {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      }, {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      } ],
      "memory_size" : 8382160896,
      "hostname" : "linux.dev.delphix.com",
      "oracle_cluster_node_discovered" : true,
      "windows_cluster_node_discovered" : true,
      "available_timestamp" : "2022-06-02T17:49:11.457Z",
      "windows_cluster_node_name" : "my-favorite-cluster-node",
      "os_name" : "Linux",
      "not_available_reason" : "Failed to connect to host",
      "oracle_cluster_node_enabled" : true,
      "id" : "3-UNIX_HOST-5"
    } ],
    "name" : "Linux Test Host",
    "namespace" : "NAMESPACE-1",
    "id" : "environment-123",
    "enabled" : true,
    "is_windows_target" : false,
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  }, {
    "is_cluster" : false,
    "engine_id" : "engine-123",
    "repositories" : [ {
      "owner" : "owner",
      "fulltext_installed" : true,
      "bits" : 0,
      "ports" : [ 6, 6 ],
      "version" : "version",
      "dump_history_file" : "dump_history_file",
      "allow_provisioning" : true,
      "installation_path" : "installation_path",
      "database_type" : "database_type",
      "oracle_base" : "oracle_base",
      "internal_version" : 5,
      "is_staging" : true,
      "rac" : true,
      "name" : "name",
      "install_group" : "install_group",
      "id" : "id",
      "install_user" : "install_user",
      "page_size" : 1
    }, {
      "owner" : "owner",
      "fulltext_installed" : true,
      "bits" : 0,
      "ports" : [ 6, 6 ],
      "version" : "version",
      "dump_history_file" : "dump_history_file",
      "allow_provisioning" : true,
      "installation_path" : "installation_path",
      "database_type" : "database_type",
      "oracle_base" : "oracle_base",
      "internal_version" : 5,
      "is_staging" : true,
      "rac" : true,
      "name" : "name",
      "install_group" : "install_group",
      "id" : "id",
      "install_user" : "install_user",
      "page_size" : 1
    } ],
    "hosts" : [ {
      "os_version" : "Red Hat Enterprise Linux Server release 7.3 (Maipo)",
      "available" : false,
      "oracle_cluster_node_name" : "my-favorite-cluster-node",
      "windows_cluster_node_reference" : "WINDOWS_CLUSTER_NODE-1",
      "oracle_cluster_node_reference" : "ORACLE_CLUSTER_NODE-1",
      "oracle_cluster_node_virtual_ips" : [ {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      }, {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      } ],
      "memory_size" : 8382160896,
      "hostname" : "linux.dev.delphix.com",
      "oracle_cluster_node_discovered" : true,
      "windows_cluster_node_discovered" : true,
      "available_timestamp" : "2022-06-02T17:49:11.457Z",
      "windows_cluster_node_name" : "my-favorite-cluster-node",
      "os_name" : "Linux",
      "not_available_reason" : "Failed to connect to host",
      "oracle_cluster_node_enabled" : true,
      "id" : "3-UNIX_HOST-5"
    }, {
      "os_version" : "Red Hat Enterprise Linux Server release 7.3 (Maipo)",
      "available" : false,
      "oracle_cluster_node_name" : "my-favorite-cluster-node",
      "windows_cluster_node_reference" : "WINDOWS_CLUSTER_NODE-1",
      "oracle_cluster_node_reference" : "ORACLE_CLUSTER_NODE-1",
      "oracle_cluster_node_virtual_ips" : [ {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      }, {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      } ],
      "memory_size" : 8382160896,
      "hostname" : "linux.dev.delphix.com",
      "oracle_cluster_node_discovered" : true,
      "windows_cluster_node_discovered" : true,
      "available_timestamp" : "2022-06-02T17:49:11.457Z",
      "windows_cluster_node_name" : "my-favorite-cluster-node",
      "os_name" : "Linux",
      "not_available_reason" : "Failed to connect to host",
      "oracle_cluster_node_enabled" : true,
      "id" : "3-UNIX_HOST-5"
    } ],
    "name" : "Linux Test Host",
    "namespace" : "NAMESPACE-1",
    "id" : "environment-123",
    "enabled" : true,
    "is_windows_target" : false,
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  } ],
  "errors" : [ {
    "object_name" : "object_name",
    "message" : "message"
  }, {
    "object_name" : "object_name",
    "message" : "message"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListEnvironmentsResponse
Up 
get /environments/{environmentId}/tags
Get tags for an Environment. (getTagsEnvironment)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ok TagsResponse
Up 
get /environments/{environmentId}/users
List environment users. (listEnvironmentUsers)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null

Return type

ListEnvironmentUsers

Example data

Content-Type: application/json
{
  "users" : [ {
    "auth_type" : "PasswordCredential",
    "user_ref" : "user-ref-1",
    "username" : "username-1",
    "primary_user" : false
  }, {
    "auth_type" : "PasswordCredential",
    "user_ref" : "user-ref-1",
    "username" : "username-1",
    "primary_user" : false
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListEnvironmentUsers
Up 
post /environments/{environmentId}/users/{userRef}/primary
Set primary environment user. (primaryEnvironmentUser)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null
userRef (required)
Path Parameter — Environment user reference. default: null

Return type

PrimaryEnvironmentUserResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PrimaryEnvironmentUserResponse
Up 
post /environments/{environmentId}/refresh
Refresh environment. (refreshEnvironment)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null

Return type

RefreshEnvironmentResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RefreshEnvironmentResponse
Up 
post /environments/search
Search for environments. (searchEnvironments)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

SearchEnvironmentsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "is_cluster" : false,
    "engine_id" : "engine-123",
    "repositories" : [ {
      "owner" : "owner",
      "fulltext_installed" : true,
      "bits" : 0,
      "ports" : [ 6, 6 ],
      "version" : "version",
      "dump_history_file" : "dump_history_file",
      "allow_provisioning" : true,
      "installation_path" : "installation_path",
      "database_type" : "database_type",
      "oracle_base" : "oracle_base",
      "internal_version" : 5,
      "is_staging" : true,
      "rac" : true,
      "name" : "name",
      "install_group" : "install_group",
      "id" : "id",
      "install_user" : "install_user",
      "page_size" : 1
    }, {
      "owner" : "owner",
      "fulltext_installed" : true,
      "bits" : 0,
      "ports" : [ 6, 6 ],
      "version" : "version",
      "dump_history_file" : "dump_history_file",
      "allow_provisioning" : true,
      "installation_path" : "installation_path",
      "database_type" : "database_type",
      "oracle_base" : "oracle_base",
      "internal_version" : 5,
      "is_staging" : true,
      "rac" : true,
      "name" : "name",
      "install_group" : "install_group",
      "id" : "id",
      "install_user" : "install_user",
      "page_size" : 1
    } ],
    "hosts" : [ {
      "os_version" : "Red Hat Enterprise Linux Server release 7.3 (Maipo)",
      "available" : false,
      "oracle_cluster_node_name" : "my-favorite-cluster-node",
      "windows_cluster_node_reference" : "WINDOWS_CLUSTER_NODE-1",
      "oracle_cluster_node_reference" : "ORACLE_CLUSTER_NODE-1",
      "oracle_cluster_node_virtual_ips" : [ {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      }, {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      } ],
      "memory_size" : 8382160896,
      "hostname" : "linux.dev.delphix.com",
      "oracle_cluster_node_discovered" : true,
      "windows_cluster_node_discovered" : true,
      "available_timestamp" : "2022-06-02T17:49:11.457Z",
      "windows_cluster_node_name" : "my-favorite-cluster-node",
      "os_name" : "Linux",
      "not_available_reason" : "Failed to connect to host",
      "oracle_cluster_node_enabled" : true,
      "id" : "3-UNIX_HOST-5"
    }, {
      "os_version" : "Red Hat Enterprise Linux Server release 7.3 (Maipo)",
      "available" : false,
      "oracle_cluster_node_name" : "my-favorite-cluster-node",
      "windows_cluster_node_reference" : "WINDOWS_CLUSTER_NODE-1",
      "oracle_cluster_node_reference" : "ORACLE_CLUSTER_NODE-1",
      "oracle_cluster_node_virtual_ips" : [ {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      }, {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      } ],
      "memory_size" : 8382160896,
      "hostname" : "linux.dev.delphix.com",
      "oracle_cluster_node_discovered" : true,
      "windows_cluster_node_discovered" : true,
      "available_timestamp" : "2022-06-02T17:49:11.457Z",
      "windows_cluster_node_name" : "my-favorite-cluster-node",
      "os_name" : "Linux",
      "not_available_reason" : "Failed to connect to host",
      "oracle_cluster_node_enabled" : true,
      "id" : "3-UNIX_HOST-5"
    } ],
    "name" : "Linux Test Host",
    "namespace" : "NAMESPACE-1",
    "id" : "environment-123",
    "enabled" : true,
    "is_windows_target" : false,
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  }, {
    "is_cluster" : false,
    "engine_id" : "engine-123",
    "repositories" : [ {
      "owner" : "owner",
      "fulltext_installed" : true,
      "bits" : 0,
      "ports" : [ 6, 6 ],
      "version" : "version",
      "dump_history_file" : "dump_history_file",
      "allow_provisioning" : true,
      "installation_path" : "installation_path",
      "database_type" : "database_type",
      "oracle_base" : "oracle_base",
      "internal_version" : 5,
      "is_staging" : true,
      "rac" : true,
      "name" : "name",
      "install_group" : "install_group",
      "id" : "id",
      "install_user" : "install_user",
      "page_size" : 1
    }, {
      "owner" : "owner",
      "fulltext_installed" : true,
      "bits" : 0,
      "ports" : [ 6, 6 ],
      "version" : "version",
      "dump_history_file" : "dump_history_file",
      "allow_provisioning" : true,
      "installation_path" : "installation_path",
      "database_type" : "database_type",
      "oracle_base" : "oracle_base",
      "internal_version" : 5,
      "is_staging" : true,
      "rac" : true,
      "name" : "name",
      "install_group" : "install_group",
      "id" : "id",
      "install_user" : "install_user",
      "page_size" : 1
    } ],
    "hosts" : [ {
      "os_version" : "Red Hat Enterprise Linux Server release 7.3 (Maipo)",
      "available" : false,
      "oracle_cluster_node_name" : "my-favorite-cluster-node",
      "windows_cluster_node_reference" : "WINDOWS_CLUSTER_NODE-1",
      "oracle_cluster_node_reference" : "ORACLE_CLUSTER_NODE-1",
      "oracle_cluster_node_virtual_ips" : [ {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      }, {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      } ],
      "memory_size" : 8382160896,
      "hostname" : "linux.dev.delphix.com",
      "oracle_cluster_node_discovered" : true,
      "windows_cluster_node_discovered" : true,
      "available_timestamp" : "2022-06-02T17:49:11.457Z",
      "windows_cluster_node_name" : "my-favorite-cluster-node",
      "os_name" : "Linux",
      "not_available_reason" : "Failed to connect to host",
      "oracle_cluster_node_enabled" : true,
      "id" : "3-UNIX_HOST-5"
    }, {
      "os_version" : "Red Hat Enterprise Linux Server release 7.3 (Maipo)",
      "available" : false,
      "oracle_cluster_node_name" : "my-favorite-cluster-node",
      "windows_cluster_node_reference" : "WINDOWS_CLUSTER_NODE-1",
      "oracle_cluster_node_reference" : "ORACLE_CLUSTER_NODE-1",
      "oracle_cluster_node_virtual_ips" : [ {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      }, {
        "domain_name" : "virtual.domain.com",
        "discovered" : true,
        "ip" : "192.168.0.1"
      } ],
      "memory_size" : 8382160896,
      "hostname" : "linux.dev.delphix.com",
      "oracle_cluster_node_discovered" : true,
      "windows_cluster_node_discovered" : true,
      "available_timestamp" : "2022-06-02T17:49:11.457Z",
      "windows_cluster_node_name" : "my-favorite-cluster-node",
      "os_name" : "Linux",
      "not_available_reason" : "Failed to connect to host",
      "oracle_cluster_node_enabled" : true,
      "id" : "3-UNIX_HOST-5"
    } ],
    "name" : "Linux Test Host",
    "namespace" : "NAMESPACE-1",
    "id" : "environment-123",
    "enabled" : true,
    "is_windows_target" : false,
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchEnvironmentsResponse
Up 
patch /environments/{environmentId}
Update an environment by ID. (updateEnvironment)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

EnvironmentUpdateParameters EnvironmentUpdateParameters (optional)
Body Parameter —

Return type

UpdateEnvironmentResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK UpdateEnvironmentResponse
Up 
put /environments/{environmentId}/users/{userRef}
Update environment user. (updateEnvironmentUser)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null
userRef (required)
Path Parameter — Environment user reference. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

EnvironmentUserParams EnvironmentUserParams (optional)
Body Parameter —

Return type

UpdateEnvironmentUserResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK UpdateEnvironmentUserResponse
Up 
patch /environments/{environmentId}/hosts/{hostId}
Update a Host. (updateHost)

Path parameters

environmentId (required)
Path Parameter — The ID of the environment. default: null
hostId (required)
Path Parameter — The ID of the host. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

HostUpdateParameters HostUpdateParameters (required)
Body Parameter —

Return type

UpdateHostResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

OK UpdateHostResponse

Executions

Up 
post /executions/{executionId}/cancel
Cancel an Execution. (cancelExecution)

Path parameters

executionId (required)
Path Parameter — The ID of the Execution. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ExecutionCancelParameters ExecutionCancelParameters (optional)
Body Parameter —

Responses

200

OK
Up 
get /executions/{executionId}
Retrieve an Execution by ID. (getExecutionById)

Path parameters

executionId (required)
Path Parameter — The ID of the Execution. default: null

Return type

Execution

Example data

Content-Type: application/json
{
  "source_connector_id" : "1-DATABASE-2",
  "submit_time" : "2021-05-01T08:51:34.148Z",
  "end_time" : "2021-05-01T11:51:34.148Z",
  "bytes_total" : 5000000,
  "target_connector_id" : "1-DATABASE-3",
  "start_time" : "2021-05-01T09:51:34.148Z",
  "masking_job_id" : "2",
  "rows_masked" : 1000,
  "rows_total" : 5000,
  "engine_id" : "1",
  "id" : "414ed52c-fa89-455d-9fb9-9c2fa5115f80",
  "task_events" : [ {
    "event" : "Initializing",
    "status" : "SUCCEEDED"
  }, {
    "event" : "Job Completed",
    "status" : "FAILED"
  } ],
  "bytes_processed" : 500,
  "status" : "RUNNING"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Execution
Up 
get /executions
Retrieve the list of masking executions. (getExecutions)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies a descending order. default: null

Return type

ListExecutionsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "source_connector_id" : "1-DATABASE-2",
    "submit_time" : "2021-05-01T08:51:34.148Z",
    "end_time" : "2021-05-01T11:51:34.148Z",
    "bytes_total" : 5000000,
    "target_connector_id" : "1-DATABASE-3",
    "start_time" : "2021-05-01T09:51:34.148Z",
    "masking_job_id" : "2",
    "rows_masked" : 1000,
    "rows_total" : 5000,
    "engine_id" : "1",
    "id" : "414ed52c-fa89-455d-9fb9-9c2fa5115f80",
    "task_events" : [ {
      "event" : "Initializing",
      "status" : "SUCCEEDED"
    }, {
      "event" : "Job Completed",
      "status" : "FAILED"
    } ],
    "bytes_processed" : 500,
    "status" : "RUNNING"
  }, {
    "source_connector_id" : "1-DATABASE-2",
    "submit_time" : "2021-05-01T08:51:34.148Z",
    "end_time" : "2021-05-01T11:51:34.148Z",
    "bytes_total" : 5000000,
    "target_connector_id" : "1-DATABASE-3",
    "start_time" : "2021-05-01T09:51:34.148Z",
    "masking_job_id" : "2",
    "rows_masked" : 1000,
    "rows_total" : 5000,
    "engine_id" : "1",
    "id" : "414ed52c-fa89-455d-9fb9-9c2fa5115f80",
    "task_events" : [ {
      "event" : "Initializing",
      "status" : "SUCCEEDED"
    }, {
      "event" : "Job Completed",
      "status" : "FAILED"
    } ],
    "bytes_processed" : 500,
    "status" : "RUNNING"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListExecutionsResponse
Up 
post /executions/search
Search masking executions. (searchExecutions)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies a descending order. default: null

Return type

SearchExecutionsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "source_connector_id" : "1-DATABASE-2",
    "submit_time" : "2021-05-01T08:51:34.148Z",
    "end_time" : "2021-05-01T11:51:34.148Z",
    "bytes_total" : 5000000,
    "target_connector_id" : "1-DATABASE-3",
    "start_time" : "2021-05-01T09:51:34.148Z",
    "masking_job_id" : "2",
    "rows_masked" : 1000,
    "rows_total" : 5000,
    "engine_id" : "1",
    "id" : "414ed52c-fa89-455d-9fb9-9c2fa5115f80",
    "task_events" : [ {
      "event" : "Initializing",
      "status" : "SUCCEEDED"
    }, {
      "event" : "Job Completed",
      "status" : "FAILED"
    } ],
    "bytes_processed" : 500,
    "status" : "RUNNING"
  }, {
    "source_connector_id" : "1-DATABASE-2",
    "submit_time" : "2021-05-01T08:51:34.148Z",
    "end_time" : "2021-05-01T11:51:34.148Z",
    "bytes_total" : 5000000,
    "target_connector_id" : "1-DATABASE-3",
    "start_time" : "2021-05-01T09:51:34.148Z",
    "masking_job_id" : "2",
    "rows_masked" : 1000,
    "rows_total" : 5000,
    "engine_id" : "1",
    "id" : "414ed52c-fa89-455d-9fb9-9c2fa5115f80",
    "task_events" : [ {
      "event" : "Initializing",
      "status" : "SUCCEEDED"
    }, {
      "event" : "Job Completed",
      "status" : "FAILED"
    } ],
    "bytes_processed" : 500,
    "status" : "RUNNING"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchExecutionsResponse

Jobs

Up 
post /jobs/{jobId}/abandon
Abandons a job. (abandonJob)
Abandoning a job means that the system will no longer track ongoing progress. The system will not attempt to stop the process in any way. The job will be moved to the ABANDONED terminal state.

Path parameters

jobId (required)
Path Parameter — The ID of the job. default: null

Responses

204

No Content
Up 
get /jobs/{jobId}
Returns a job by ID. (getJobById)

Path parameters

jobId (required)
Path Parameter — The ID of the job. default: null

Return type

Job

Example data

Content-Type: application/json
{
  "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
  "start_time" : "2022-01-02T05:11:24.148Z",
  "update_time" : "2022-01-02T06:11:24.148Z",
  "trace_id" : "trace_id",
  "error_details" : "Unable to connect to the engine.",
  "target_id" : "vdb-123",
  "id" : "job-123",
  "type" : "DB_REFRESH",
  "status" : "RUNNING"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Job
Up 
get /jobs
List all jobs. (getJobs)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: -start_time

Return type

ListJobsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }, {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  } ],
  "errors" : [ {
    "object_name" : "object_name",
    "message" : "message"
  }, {
    "object_name" : "object_name",
    "message" : "message"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListJobsResponse
Up 
post /jobs/search
Search for jobs. (searchJobs)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: -start_time

Return type

SearchJobsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }, {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchJobsResponse

Login

Up 
post /login
Login to Account with Username and Password (accountLogin)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AccountLoginParameter AccountLoginParameter (required)
Body Parameter —

Return type

LoginToken

Example data

Content-Type: application/json
{
  "access_token" : "access_token",
  "token_type" : "token_type",
  "expires_in" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Account Login Successful LoginToken

401

Unauthorized ErrorResponse
Up 
post /token-info
Get Token Information (tokenInfo)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TokenInfoRequest TokenInfoRequest (optional)
Body Parameter —

Return type

TokenInfoResponse

Example data

Content-Type: application/json
{
  "account_id" : 0,
  "active" : true,
  "last_name" : "last_name",
  "ldap_principal" : "ldap_principal",
  "token_type" : "token_type",
  "exp" : 6,
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK TokenInfoResponse

401

Unauthorized ErrorResponse

Management

Up 
post /management/engines/{engineId}/tags
Create tags for a engine. (createEngineTags)

Path parameters

engineId (required)
Path Parameter — The ID of the registered engine. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TagsRequest TagsRequest (required)
Body Parameter —

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created TagsResponse
Up 
post /management/vaults/hashicorp
Configure a new Hashicorp Vault (createHashicorpVault)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

HashicorpVault HashicorpVault (required)
Body Parameter —

Return type

HashicorpVault

Example data

Content-Type: application/json
{
  "env_variables" : {
    "VAULT_ADDR" : "https://vault.company.co:8200",
    "VAULT_TOKEN" : "token-to-retrieve-secrets"
  },
  "login_command_args" : [ "login", "-method=cert", "-client-cert=/etc/config/cert.pem", "-client-key=/etc/config/key.pem", "write", "auth/approle/login", "role_id=123", "secret_id=456" ],
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created HashicorpVault
Up 
post /management/engines/{engineId}/tags/delete
Delete tags for an Engine. (deleteEngineTags)

Path parameters

engineId (required)
Path Parameter — The ID of the registered engine. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteTag DeleteTag (optional)
Body Parameter —

Responses

204

No Content
Up 
delete /management/vaults/hashicorp/{vaultId}
Delete a Hashicorp vault by id (deleteHashicorpVault)

Path parameters

vaultId (required)
Path Parameter — Numeric ID of the Hashicorp vault default: null format: int64

Responses

204

No Content
Up 
get /management/api-classification
Get api classification. (getApiClassification)

Return type

APIClassificationConfig

Example data

Content-Type: application/json
{
  "api_classification" : [ {
    "end_date" : "2000-01-23T04:56:07.000+00:00",
    "path" : "/vdb-groups",
    "is_automation" : true,
    "api_method" : "POST",
    "start_date" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "end_date" : "2000-01-23T04:56:07.000+00:00",
    "path" : "/vdb-groups",
    "is_automation" : true,
    "api_method" : "POST",
    "start_date" : "2000-01-23T04:56:07.000+00:00"
  } ],
  "version" : "1.0.0"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK APIClassificationConfig
Up 
get /management/engines/{engineId}/tags
Get tags for a Engine. (getEngineTags)

Path parameters

engineId (required)
Path Parameter — The ID of the registered engine. default: null

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ok TagsResponse
Up 
get /management/vaults/hashicorp/{vaultId}
Get a Hashicorp vault by id (getHashicorpVault)

Path parameters

vaultId (required)
Path Parameter — Numeric ID of the Hashicorp vault default: null format: int64

Return type

HashicorpVault

Example data

Content-Type: application/json
{
  "env_variables" : {
    "VAULT_ADDR" : "https://vault.company.co:8200",
    "VAULT_TOKEN" : "token-to-retrieve-secrets"
  },
  "login_command_args" : [ "login", "-method=cert", "-client-cert=/etc/config/cert.pem", "-client-key=/etc/config/key.pem", "write", "auth/approle/login", "role_id=123", "secret_id=456" ],
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HashicorpVault
Up 
get /management/vaults/hashicorp
Returns a list of configured Hashicorp vaults. (getHashicorpVaults)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListHashicorpVaultsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "env_variables" : {
      "VAULT_ADDR" : "https://vault.company.co:8200",
      "VAULT_TOKEN" : "token-to-retrieve-secrets"
    },
    "login_command_args" : [ "login", "-method=cert", "-client-cert=/etc/config/cert.pem", "-client-key=/etc/config/key.pem", "write", "auth/approle/login", "role_id=123", "secret_id=456" ],
    "id" : 0
  }, {
    "env_variables" : {
      "VAULT_ADDR" : "https://vault.company.co:8200",
      "VAULT_TOKEN" : "token-to-retrieve-secrets"
    },
    "login_command_args" : [ "login", "-method=cert", "-client-cert=/etc/config/cert.pem", "-client-key=/etc/config/key.pem", "write", "auth/approle/login", "role_id=123", "secret_id=456" ],
    "id" : 0
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListHashicorpVaultsResponse
Up 
get /management/ldap-config
Returns the LDAP configuration (getLdapConfig)

Return type

LDAPConfigParams

Example data

Content-Type: application/json
{
  "hostname" : "ldap.server.com",
  "auto_create_users" : true,
  "port" : 389,
  "truststore_password" : "truststore_password",
  "unsafe_ssl_hostname_check" : false,
  "insecure_ssl" : false,
  "domains" : [ {
    "object_class_attr" : "person",
    "last_name_attr" : "sn",
    "msad_domain_name" : "msad.domain.com",
    "email_attr" : "mail",
    "username_pattern" : "uid={0},ou=Users",
    "group_attr" : "gidNumber",
    "first_name_attr" : "cn",
    "search_base" : "DC=test,DC=delphix,DC=com",
    "search_attr" : "uid"
  }, {
    "object_class_attr" : "person",
    "last_name_attr" : "sn",
    "msad_domain_name" : "msad.domain.com",
    "email_attr" : "mail",
    "username_pattern" : "uid={0},ou=Users",
    "group_attr" : "gidNumber",
    "first_name_attr" : "cn",
    "search_base" : "DC=test,DC=delphix,DC=com",
    "search_attr" : "uid"
  } ],
  "enable_ssl" : false,
  "enabled" : true,
  "truststore_filename" : "truststore_filename"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK LDAPConfigParams
Up 
get /management/engines/{engineId}
Returns a registered engine by ID. (getRegisteredEngine)

Path parameters

engineId (required)
Path Parameter — The ID of the registered engine. default: null

Return type

RegisteredEngine

Example data

Content-Type: application/json
{
  "id" : "engine-123",
  "uuid" : "54290b71-58cd-463d-bd62-7219d4c4d2d5",
  "type" : "VIRTUALIZATION",
  "version" : "6.0.7.0",
  "name" : "My Favorite Engine",
  "hostname" : "eng09.dev.delphix.com",
  "cpu_core_count" : 4,
  "memory_size" : 16000000000,
  "data_storage_capacity" : 100000000000,
  "data_storage_used" : 85000000000,
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ],
  "connection_status" : "OFFLINE",
  "connection_status_details" : "Unable to authenticate with engine"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RegisteredEngine
Up 
get /management/engines
Returns a list of registered engines. (getRegisteredEngines)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListRegisteredEnginesResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "id" : "engine-123",
    "uuid" : "54290b71-58cd-463d-bd62-7219d4c4d2d5",
    "type" : "VIRTUALIZATION",
    "version" : "6.0.7.0",
    "name" : "My Favorite Engine",
    "hostname" : "eng09.dev.delphix.com",
    "cpu_core_count" : 4,
    "memory_size" : 16000000000,
    "data_storage_capacity" : 100000000000,
    "data_storage_used" : 85000000000,
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ],
    "connection_status" : "OFFLINE",
    "connection_status_details" : "Unable to authenticate with engine"
  }, {
    "id" : "engine-123",
    "uuid" : "54290b71-58cd-463d-bd62-7219d4c4d2d5",
    "type" : "VIRTUALIZATION",
    "version" : "6.0.7.0",
    "name" : "My Favorite Engine",
    "hostname" : "eng09.dev.delphix.com",
    "cpu_core_count" : 4,
    "memory_size" : 16000000000,
    "data_storage_capacity" : 100000000000,
    "data_storage_used" : 85000000000,
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ],
    "connection_status" : "OFFLINE",
    "connection_status_details" : "Unable to authenticate with engine"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListRegisteredEnginesResponse
Up 
get /management/saml-config
Returns the SAML configuration (getSamlConfig)

Return type

SAMLConfigParams

Example data

Content-Type: application/json
{
  "metadata" : "metadata",
  "last_name_attr" : "lastName",
  "auto_create_users" : true,
  "response_skew" : 120,
  "group_attr" : "groups",
  "first_name_attr" : "firstName",
  "entity_id" : "https://dct.delphix.com",
  "enabled" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SAMLConfigParams
Up 
get /management/smtp
Returns the SMTP configuration (getSmtpConfig)

Return type

SMTPConfigParams

Example data

Content-Type: application/json
{
  "server" : "smtp.host.com",
  "password" : "password",
  "authentication_enabled" : false,
  "tls_enabled" : false,
  "port" : 25,
  "send_timeout" : 24,
  "from_address" : "sender@example.com",
  "enabled" : false,
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SMTPConfigParams
Up 
get /management/properties
Get global properties. (listProperties)

Return type

GlobalProperties

Example data

Content-Type: application/json
{
  "disable_username_password" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK GlobalProperties
Up 
post /management/engines
Register an engine. (registerEngine)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

EngineRegistrationParameter EngineRegistrationParameter (required)
Body Parameter —

Return type

RegisteredEngine

Example data

Content-Type: application/json
{
  "id" : "engine-123",
  "uuid" : "54290b71-58cd-463d-bd62-7219d4c4d2d5",
  "type" : "VIRTUALIZATION",
  "version" : "6.0.7.0",
  "name" : "My Favorite Engine",
  "hostname" : "eng09.dev.delphix.com",
  "cpu_core_count" : 4,
  "memory_size" : 16000000000,
  "data_storage_capacity" : 100000000000,
  "data_storage_used" : 85000000000,
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ],
  "connection_status" : "OFFLINE",
  "connection_status_details" : "Unable to authenticate with engine"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created RegisteredEngine
Up 
post /management/engines/search
Search for engines. (searchEngines)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

SearchEnginesResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "id" : "engine-123",
    "uuid" : "54290b71-58cd-463d-bd62-7219d4c4d2d5",
    "type" : "VIRTUALIZATION",
    "version" : "6.0.7.0",
    "name" : "My Favorite Engine",
    "hostname" : "eng09.dev.delphix.com",
    "cpu_core_count" : 4,
    "memory_size" : 16000000000,
    "data_storage_capacity" : 100000000000,
    "data_storage_used" : 85000000000,
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ],
    "connection_status" : "OFFLINE",
    "connection_status_details" : "Unable to authenticate with engine"
  }, {
    "id" : "engine-123",
    "uuid" : "54290b71-58cd-463d-bd62-7219d4c4d2d5",
    "type" : "VIRTUALIZATION",
    "version" : "6.0.7.0",
    "name" : "My Favorite Engine",
    "hostname" : "eng09.dev.delphix.com",
    "cpu_core_count" : 4,
    "memory_size" : 16000000000,
    "data_storage_capacity" : 100000000000,
    "data_storage_used" : 85000000000,
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ],
    "connection_status" : "OFFLINE",
    "connection_status_details" : "Unable to authenticate with engine"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchEnginesResponse
Up 
delete /management/engines/{engineId}
Unregister an engine. (unregisterEngine)

Path parameters

engineId (required)
Path Parameter — The ID of the registered engine. default: null

Return type

DeleteEngineResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DeleteEngineResponse
Up 
put /management/api-classification
Update the api classification to new version. (updateApiClassification)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

APIClassificationConfig APIClassificationConfig (required)
Body Parameter —

Return type

APIClassificationConfig

Example data

Content-Type: application/json
{
  "api_classification" : [ {
    "end_date" : "2000-01-23T04:56:07.000+00:00",
    "path" : "/vdb-groups",
    "is_automation" : true,
    "api_method" : "POST",
    "start_date" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "end_date" : "2000-01-23T04:56:07.000+00:00",
    "path" : "/vdb-groups",
    "is_automation" : true,
    "api_method" : "POST",
    "start_date" : "2000-01-23T04:56:07.000+00:00"
  } ],
  "version" : "1.0.0"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK APIClassificationConfig
Up 
put /management/ldap-config
Update LDAP Config. (updateLdapConfig)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

LDAPConfigParams LDAPConfigParams (required)
Body Parameter —

Return type

LDAPConfigParams

Example data

Content-Type: application/json
{
  "hostname" : "ldap.server.com",
  "auto_create_users" : true,
  "port" : 389,
  "truststore_password" : "truststore_password",
  "unsafe_ssl_hostname_check" : false,
  "insecure_ssl" : false,
  "domains" : [ {
    "object_class_attr" : "person",
    "last_name_attr" : "sn",
    "msad_domain_name" : "msad.domain.com",
    "email_attr" : "mail",
    "username_pattern" : "uid={0},ou=Users",
    "group_attr" : "gidNumber",
    "first_name_attr" : "cn",
    "search_base" : "DC=test,DC=delphix,DC=com",
    "search_attr" : "uid"
  }, {
    "object_class_attr" : "person",
    "last_name_attr" : "sn",
    "msad_domain_name" : "msad.domain.com",
    "email_attr" : "mail",
    "username_pattern" : "uid={0},ou=Users",
    "group_attr" : "gidNumber",
    "first_name_attr" : "cn",
    "search_base" : "DC=test,DC=delphix,DC=com",
    "search_attr" : "uid"
  } ],
  "enable_ssl" : false,
  "enabled" : true,
  "truststore_filename" : "truststore_filename"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK LDAPConfigParams
Up 
patch /management/properties
Update value of predefined properties. (updateProperties)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GlobalProperties GlobalProperties (required)
Body Parameter —

Return type

GlobalProperties

Example data

Content-Type: application/json
{
  "disable_username_password" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK GlobalProperties
Up 
put /management/engines/{engineId}
Update a registered engine. (updateRegisteredEngine)

Path parameters

engineId (required)
Path Parameter — The ID of the registered engine. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

RegisteredEngine RegisteredEngine (required)
Body Parameter —

Return type

RegisteredEngine

Example data

Content-Type: application/json
{
  "id" : "engine-123",
  "uuid" : "54290b71-58cd-463d-bd62-7219d4c4d2d5",
  "type" : "VIRTUALIZATION",
  "version" : "6.0.7.0",
  "name" : "My Favorite Engine",
  "hostname" : "eng09.dev.delphix.com",
  "cpu_core_count" : 4,
  "memory_size" : 16000000000,
  "data_storage_capacity" : 100000000000,
  "data_storage_used" : 85000000000,
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ],
  "connection_status" : "OFFLINE",
  "connection_status_details" : "Unable to authenticate with engine"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RegisteredEngine
Up 
put /management/saml-config
Update SAML Config. (updateSamlConfig)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SAMLConfigParams SAMLConfigParams (required)
Body Parameter —

Return type

SAMLConfigParams

Example data

Content-Type: application/json
{
  "metadata" : "metadata",
  "last_name_attr" : "lastName",
  "auto_create_users" : true,
  "response_skew" : 120,
  "group_attr" : "groups",
  "first_name_attr" : "firstName",
  "entity_id" : "https://dct.delphix.com",
  "enabled" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SAMLConfigParams
Up 
put /management/smtp
Update SMTP Config. (updateSmtpConfig)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SMTPConfigParams SMTPConfigParams (required)
Body Parameter —

Return type

SMTPConfigParams

Example data

Content-Type: application/json
{
  "server" : "smtp.host.com",
  "password" : "password",
  "authentication_enabled" : false,
  "tls_enabled" : false,
  "port" : 25,
  "send_timeout" : 24,
  "from_address" : "sender@example.com",
  "enabled" : false,
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SMTPConfigParams
Up 
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. (validateLdapConfig)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

LdapConfigValidateParameter LdapConfigValidateParameter (optional)
Body Parameter —

Return type

LdapValidateResponse

Example data

Content-Type: application/json
{
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK LdapValidateResponse
Up 
post /management/smtp/validate
Validate SMTP Config. (validateSmtpConfig)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SMTPConfigValidate SMTPConfigValidate (required)
Body Parameter —

Responses

200

OK

MaskingJobs

Up 
post /masking-jobs/{maskingJobId}/copy
Copies the masking job to another engine. (copyMaskingJob)

Path parameters

maskingJobId (required)
Path Parameter — The ID of the Masking Job. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CopyMaskingJobParameters CopyMaskingJobParameters (optional)
Body Parameter —

Return type

CopyMaskingJobResponse

Example data

Content-Type: application/json
{
  "masking_job_id" : "masking_job_id",
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Copy masking job initiated. CopyMaskingJobResponse
Up 
post /masking-jobs/{maskingJobId}/tags
Create tags for a Masking Job. (createMaskingJobTag)

Path parameters

maskingJobId (required)
Path Parameter — The ID of the Masking Job. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TagsRequest TagsRequest (required)
Body Parameter —

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created TagsResponse
Up 
delete /masking-jobs/{maskingJobId}
Delete a masking job. (deleteMaskingJob)

Path parameters

maskingJobId (required)
Path Parameter — The ID of the Masking Job. default: null

Query parameters

force (optional)
Query Parameter — If true, ignores any failures to remove a masking job on an engine. default: false

Return type

DeleteMaskingJobResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Masking job delete initiated. DeleteMaskingJobResponse
Up 
post /masking-jobs/{maskingJobId}/tags/delete
Delete tags for a Masking Job. (deleteMaskingJobTag)

Path parameters

maskingJobId (required)
Path Parameter — The ID of the Masking Job. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteTag DeleteTag (optional)
Body Parameter —

Responses

204

No Content
Up 
post /masking-jobs/{maskingJobId}/execute
Execute a MaskingJob. (executeMaskingJob)

Path parameters

maskingJobId (required)
Path Parameter — The ID of the Masking Job. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ExecuteMaskingJobParameters ExecuteMaskingJobParameters (optional)
Body Parameter —

Return type

ExecuteMaskingJobResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Masking job execute initiated. ExecuteMaskingJobResponse
Up 
get /masking-jobs/{maskingJobId}
Retrieve a MaskingJob by ID. (getMaskingJobById)

Path parameters

maskingJobId (required)
Path Parameter — The ID of the Masking Job. default: null

Return type

MaskingJob

Example data

Content-Type: application/json
{
  "on_the_fly_source_connector_password" : "*****",
  "connector_password" : "*****",
  "is_on_the_fly_masking" : true,
  "last_execution_status" : "SUCCEEDED",
  "on_the_fly_source_connector_username" : "user123",
  "connector_username" : "user123",
  "name" : "My favorite MaskingJob",
  "ruleset" : {
    "type" : "DATABASE",
    "name" : "The best Ruleset",
    "refresh_drops_tables" : true
  },
  "id" : "masking-job-1",
  "creation_date" : "2022-11-30T08:51:34.148Z",
  "last_completed_execution_date" : "2022-11-30T09:51:34.148Z",
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MaskingJob
Up 
get /masking-jobs/{maskingJobId}/connectors
Get connectors for a Masking Job by ID. (getMaskingJobConnectors)

Path parameters

maskingJobId (required)
Path Parameter — The ID of the Masking Job. default: null

Return type

MaskingJobConnectorsResponse

Example data

Content-Type: application/json
{
  "connector" : {
    "id" : "1-database-123",
    "name" : "connector-name",
    "engine_id" : 123,
    "type" : "DATABASE",
    "hostname" : "database_server.mycompany.co",
    "port" : 4322,
    "username" : "user-123"
  },
  "on_the_fly_connector" : {
    "id" : "1-database-123",
    "name" : "connector-name",
    "engine_id" : 123,
    "type" : "DATABASE",
    "hostname" : "database_server.mycompany.co",
    "port" : 4322,
    "username" : "user-123"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MaskingJobConnectorsResponse
Up 
get /masking-jobs/source-engines
Retrieve the list of masking jobs along with their source engine. (getMaskingJobSourceEngines)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies a descending order. default: null

Return type

ListMaskingJobSourceEnginesResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "masking_job_id" : "masking-job-1",
    "source_engine_id" : "engine-123"
  }, {
    "masking_job_id" : "masking-job-1",
    "source_engine_id" : "engine-123"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListMaskingJobSourceEnginesResponse
Up 
get /masking-jobs/{maskingJobId}/tags
Get tags for a Masking Job. (getMaskingJobTag)

Path parameters

maskingJobId (required)
Path Parameter — The ID of the Masking Job. default: null

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ok TagsResponse
Up 
get /masking-jobs
Retrieve the list of masking jobs. (getMaskingJobs)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies a descending order. default: null

Return type

ListMaskingJobsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "on_the_fly_source_connector_password" : "*****",
    "connector_password" : "*****",
    "is_on_the_fly_masking" : true,
    "last_execution_status" : "SUCCEEDED",
    "on_the_fly_source_connector_username" : "user123",
    "connector_username" : "user123",
    "name" : "My favorite MaskingJob",
    "ruleset" : {
      "type" : "DATABASE",
      "name" : "The best Ruleset",
      "refresh_drops_tables" : true
    },
    "id" : "masking-job-1",
    "creation_date" : "2022-11-30T08:51:34.148Z",
    "last_completed_execution_date" : "2022-11-30T09:51:34.148Z",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  }, {
    "on_the_fly_source_connector_password" : "*****",
    "connector_password" : "*****",
    "is_on_the_fly_masking" : true,
    "last_execution_status" : "SUCCEEDED",
    "on_the_fly_source_connector_username" : "user123",
    "connector_username" : "user123",
    "name" : "My favorite MaskingJob",
    "ruleset" : {
      "type" : "DATABASE",
      "name" : "The best Ruleset",
      "refresh_drops_tables" : true
    },
    "id" : "masking-job-1",
    "creation_date" : "2022-11-30T08:51:34.148Z",
    "last_completed_execution_date" : "2022-11-30T09:51:34.148Z",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListMaskingJobsResponse
Up 
post /masking-jobs/{maskingJobId}/migrate
Migrates the masking job from its current source engine to another engine. (migrateMaskingJob)

Path parameters

maskingJobId (required)
Path Parameter — The ID of the Masking Job. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

MigrateMaskingJobParameters MigrateMaskingJobParameters (optional)
Body Parameter —

Return type

MigrateMaskingJobResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Migrate masking job initiated. MigrateMaskingJobResponse
Up 
post /masking-jobs/source-engines/search
Search the list of masking jobs along with their source engine. (searchMaskingJobSourceEngines)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies a descending order. default: null

Return type

SearchMaskingJobSourceEnginesResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "masking_job_id" : "masking-job-1",
    "source_engine_id" : "engine-123"
  }, {
    "masking_job_id" : "masking-job-1",
    "source_engine_id" : "engine-123"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchMaskingJobSourceEnginesResponse
Up 
post /masking-jobs/search
Search masking jobs. (searchMaskingJobs)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies a descending order. default: null

Return type

SearchMaskingJobsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "on_the_fly_source_connector_password" : "*****",
    "connector_password" : "*****",
    "is_on_the_fly_masking" : true,
    "last_execution_status" : "SUCCEEDED",
    "on_the_fly_source_connector_username" : "user123",
    "connector_username" : "user123",
    "name" : "My favorite MaskingJob",
    "ruleset" : {
      "type" : "DATABASE",
      "name" : "The best Ruleset",
      "refresh_drops_tables" : true
    },
    "id" : "masking-job-1",
    "creation_date" : "2022-11-30T08:51:34.148Z",
    "last_completed_execution_date" : "2022-11-30T09:51:34.148Z",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  }, {
    "on_the_fly_source_connector_password" : "*****",
    "connector_password" : "*****",
    "is_on_the_fly_masking" : true,
    "last_execution_status" : "SUCCEEDED",
    "on_the_fly_source_connector_username" : "user123",
    "connector_username" : "user123",
    "name" : "My favorite MaskingJob",
    "ruleset" : {
      "type" : "DATABASE",
      "name" : "The best Ruleset",
      "refresh_drops_tables" : true
    },
    "id" : "masking-job-1",
    "creation_date" : "2022-11-30T08:51:34.148Z",
    "last_completed_execution_date" : "2022-11-30T09:51:34.148Z",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchMaskingJobsResponse
Up 
patch /masking-jobs/{maskingJobId}
Update values of a MaskingJob. (updateMaskingJobById)

Path parameters

maskingJobId (required)
Path Parameter — The ID of the Masking Job. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateMaskingJobParameters UpdateMaskingJobParameters (optional)
Body Parameter —

Return type

MaskingJob

Example data

Content-Type: application/json
{
  "on_the_fly_source_connector_password" : "*****",
  "connector_password" : "*****",
  "is_on_the_fly_masking" : true,
  "last_execution_status" : "SUCCEEDED",
  "on_the_fly_source_connector_username" : "user123",
  "connector_username" : "user123",
  "name" : "My favorite MaskingJob",
  "ruleset" : {
    "type" : "DATABASE",
    "name" : "The best Ruleset",
    "refresh_drops_tables" : true
  },
  "id" : "masking-job-1",
  "creation_date" : "2022-11-30T08:51:34.148Z",
  "last_completed_execution_date" : "2022-11-30T09:51:34.148Z",
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MaskingJob

Reporting

Up 
post /reporting/schedule
Create a new report schedule. (createReportingSchedule)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ReportingScheduleCreateParameters ReportingScheduleCreateParameters (required)
Body Parameter —

Return type

ReportingSchedule

Example data

Content-Type: application/json
{
  "sort_column" : "engine_name",
  "cron_expression" : "0 0 2 ? * Mon-Fri",
  "report_id" : 123,
  "recipients" : [ "user@example.com", "user@example.com" ],
  "report_type" : "VIRTUALIZATION_STORAGE_SUMMARY",
  "time_zone" : "America/Los_Angeles",
  "message" : "sample message",
  "file_format" : "CSV",
  "enabled" : true,
  "row_count" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Returns the newly created schedule for a report. ReportingSchedule
Up 
delete /reporting/schedule/{reportId}
Delete report schedule by ID. (deleteReportingSchedule)

Path parameters

reportId (required)
Path Parameter — The ID of the report schedule. default: null

Responses

204

No Content
Up 
get /reporting/api-usage-report
Gets the report of API usage metrics over a given time period. (getApiUsageReport)

Query parameters

start_date (optional)
Query Parameter — Report start date/time. Defaults to first API request. default: null format: date-time
end_date (optional)
Query Parameter — Report end date/time. Defaults to current time. default: null format: date-time
api_metric_kind (optional)
Query Parameter — Restrict the list to API usage metric of the given kind default: null

Return type

ApiUsageReportResponse

Example data

Content-Type: application/json
{
  "total_management_api_count" : 4200,
  "total_automation_api_count" : 4200,
  "items" : [ {
    "api_endpoint" : "/v2/management/engines",
    "api_method" : "GET",
    "kind" : "automation",
    "api_count" : 4200
  }, {
    "api_endpoint" : "/v2/management/engines",
    "api_method" : "GET",
    "kind" : "automation",
    "api_count" : 4200
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Returns a list of API usage metrics. ApiUsageReportResponse
Up 
get /reporting/dsource-consumption-report
Gets the consumption report for virtualization engine dSources. (getDsourceConsumptionReport)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. default: 10000
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

DSourceConsumptionReportResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "database_type" : "Oracle",
    "engine_id" : "1",
    "last_consumption_date" : "2000-01-23T04:56:07.000+00:00",
    "name" : "prod01-main",
    "engine_name" : "My favorite engine",
    "ingested_size" : 12345,
    "status" : "Running"
  }, {
    "database_type" : "Oracle",
    "engine_id" : "1",
    "last_consumption_date" : "2000-01-23T04:56:07.000+00:00",
    "name" : "prod01-main",
    "engine_name" : "My favorite engine",
    "ingested_size" : 12345,
    "status" : "Running"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Returns a list of dSource consumption data. DSourceConsumptionReportResponse
Up 
get /reporting/dsource-usage-report
Gets the usage report for virtualization engine dSources. (getDsourceUsageReport)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. default: 10000
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

DSourceUsageReportResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "actual_space" : 339292672,
    "dependant_vdbs" : 25,
    "name" : "prod01-main",
    "engine_name" : "My favorite engine",
    "unvirtualized_space" : 109242677
  }, {
    "actual_space" : 339292672,
    "dependant_vdbs" : 25,
    "name" : "prod01-main",
    "engine_name" : "My favorite engine",
    "unvirtualized_space" : 109242677
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Returns a list of dSource usage data. DSourceUsageReportResponse
Up 
get /reporting/product_info
Returns the DCT Product Information. (getProductInfo)

Return type

ProductInfo

Example data

Content-Type: application/json
{
  "product_version" : "1.0.0",
  "product_upgrade_history" : [ {
    "installed_on" : "2022-05-22T09:15:30Z",
    "version" : "1.0.0"
  }, {
    "installed_on" : "2022-05-22T09:15:30Z",
    "version" : "1.0.0"
  } ],
  "supported_api_versions" : [ "supported_api_versions", "supported_api_versions" ],
  "api_version" : "1.0.0"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ProductInfo
Up 
get /reporting/schedule/{reportId}
Returns a report schedule by ID. (getReportingScheduleById)

Path parameters

reportId (required)
Path Parameter — The ID of the report schedule. default: null

Return type

ReportingSchedule

Example data

Content-Type: application/json
{
  "sort_column" : "engine_name",
  "cron_expression" : "0 0 2 ? * Mon-Fri",
  "report_id" : 123,
  "recipients" : [ "user@example.com", "user@example.com" ],
  "report_type" : "VIRTUALIZATION_STORAGE_SUMMARY",
  "time_zone" : "America/Los_Angeles",
  "message" : "sample message",
  "file_format" : "CSV",
  "enabled" : true,
  "row_count" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ReportingSchedule
Up 
get /reporting/schedule
List all report schedules. (getReportingSchedules)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListReportingScheduleResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "sort_column" : "engine_name",
    "cron_expression" : "0 0 2 ? * Mon-Fri",
    "report_id" : 123,
    "recipients" : [ "user@example.com", "user@example.com" ],
    "report_type" : "VIRTUALIZATION_STORAGE_SUMMARY",
    "time_zone" : "America/Los_Angeles",
    "message" : "sample message",
    "file_format" : "CSV",
    "enabled" : true,
    "row_count" : 1
  }, {
    "sort_column" : "engine_name",
    "cron_expression" : "0 0 2 ? * Mon-Fri",
    "report_id" : 123,
    "recipients" : [ "user@example.com", "user@example.com" ],
    "report_type" : "VIRTUALIZATION_STORAGE_SUMMARY",
    "time_zone" : "America/Los_Angeles",
    "message" : "sample message",
    "file_format" : "CSV",
    "enabled" : true,
    "row_count" : 1
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListReportingScheduleResponse
Up 
get /reporting/vdb-inventory-report
Gets the inventory report for virtualization engine VDBs. (getVdbInventoryReport)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. default: 10000
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

VDBInventoryReportResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "parent_name" : "parent_name",
    "parent_timeflow_timestamp" : "2000-01-23T04:56:07.000+00:00",
    "parent_id" : "parent_id",
    "parent_timeflow_location" : "parent_timeflow_location",
    "name" : "name",
    "engine_name" : "engine_name",
    "parent_timeflow_timezone" : "parent_timeflow_timezone",
    "creation_date" : "2000-01-23T04:56:07.000+00:00",
    "type" : "type",
    "version" : "version",
    "enabled" : true,
    "status" : "status"
  }, {
    "parent_name" : "parent_name",
    "parent_timeflow_timestamp" : "2000-01-23T04:56:07.000+00:00",
    "parent_id" : "parent_id",
    "parent_timeflow_location" : "parent_timeflow_location",
    "name" : "name",
    "engine_name" : "engine_name",
    "parent_timeflow_timezone" : "parent_timeflow_timezone",
    "creation_date" : "2000-01-23T04:56:07.000+00:00",
    "type" : "type",
    "version" : "version",
    "enabled" : true,
    "status" : "status"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Returns a list of inventory data of VDBs. VDBInventoryReportResponse
Up 
get /reporting/virtualization-storage-summary-report
Gets the storage summary report for virtualization engines. (getVirtualizationStorageSummaryReport)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. default: 10000
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

VirtualizationStorageSummaryReportResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "free_storage" : 99000000000,
    "dsource_count" : 50,
    "vdb_count" : 200,
    "engine_id" : "engine-123",
    "engine_hostname" : "eng09.dev.delphix.com",
    "used_percentage" : 75.0,
    "used_storage" : 85000000000,
    "engine_name" : "My Favorite Engine",
    "total_capacity" : 100000000000,
    "total_object_count" : 400
  }, {
    "free_storage" : 99000000000,
    "dsource_count" : 50,
    "vdb_count" : 200,
    "engine_id" : "engine-123",
    "engine_hostname" : "eng09.dev.delphix.com",
    "used_percentage" : 75.0,
    "used_storage" : 85000000000,
    "engine_name" : "My Favorite Engine",
    "total_capacity" : 100000000000,
    "total_object_count" : 400
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Returns a list of storage summary data of virtualization engines. VirtualizationStorageSummaryReportResponse
Up 
post /reporting/dsource-consumption-report/search
Search the consumption report for virtualization engine DSources. (searchDsourceConsumptionReport)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. default: 10000
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

DSourceConsumptionReportResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "database_type" : "Oracle",
    "engine_id" : "1",
    "last_consumption_date" : "2000-01-23T04:56:07.000+00:00",
    "name" : "prod01-main",
    "engine_name" : "My favorite engine",
    "ingested_size" : 12345,
    "status" : "Running"
  }, {
    "database_type" : "Oracle",
    "engine_id" : "1",
    "last_consumption_date" : "2000-01-23T04:56:07.000+00:00",
    "name" : "prod01-main",
    "engine_name" : "My favorite engine",
    "ingested_size" : 12345,
    "status" : "Running"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Returns a list of dSource consumption data. DSourceConsumptionReportResponse
Up 
post /reporting/dsource-usage-report/search
Search the usage report for virtualization engine dSources. (searchDsourceUsageReport)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. default: 10000
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

DSourceUsageReportResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "actual_space" : 339292672,
    "dependant_vdbs" : 25,
    "name" : "prod01-main",
    "engine_name" : "My favorite engine",
    "unvirtualized_space" : 109242677
  }, {
    "actual_space" : 339292672,
    "dependant_vdbs" : 25,
    "name" : "prod01-main",
    "engine_name" : "My favorite engine",
    "unvirtualized_space" : 109242677
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Returns a list of dSource usage data. DSourceUsageReportResponse
Up 
post /reporting/vdb-inventory-report/search
Search the inventory report for virtualization engine VDBs. (searchVdbInventoryReport)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. default: 10000
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

VDBInventoryReportResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "parent_name" : "parent_name",
    "parent_timeflow_timestamp" : "2000-01-23T04:56:07.000+00:00",
    "parent_id" : "parent_id",
    "parent_timeflow_location" : "parent_timeflow_location",
    "name" : "name",
    "engine_name" : "engine_name",
    "parent_timeflow_timezone" : "parent_timeflow_timezone",
    "creation_date" : "2000-01-23T04:56:07.000+00:00",
    "type" : "type",
    "version" : "version",
    "enabled" : true,
    "status" : "status"
  }, {
    "parent_name" : "parent_name",
    "parent_timeflow_timestamp" : "2000-01-23T04:56:07.000+00:00",
    "parent_id" : "parent_id",
    "parent_timeflow_location" : "parent_timeflow_location",
    "name" : "name",
    "engine_name" : "engine_name",
    "parent_timeflow_timezone" : "parent_timeflow_timezone",
    "creation_date" : "2000-01-23T04:56:07.000+00:00",
    "type" : "type",
    "version" : "version",
    "enabled" : true,
    "status" : "status"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Returns a list of inventory data of VDBs. VDBInventoryReportResponse
Up 
post /reporting/virtualization-storage-summary-report/search
Search the storage summary report for virtualization engines. (searchVirtualizationStorageSummaryReport)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. default: 10000
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

VirtualizationStorageSummaryReportResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "free_storage" : 99000000000,
    "dsource_count" : 50,
    "vdb_count" : 200,
    "engine_id" : "engine-123",
    "engine_hostname" : "eng09.dev.delphix.com",
    "used_percentage" : 75.0,
    "used_storage" : 85000000000,
    "engine_name" : "My Favorite Engine",
    "total_capacity" : 100000000000,
    "total_object_count" : 400
  }, {
    "free_storage" : 99000000000,
    "dsource_count" : 50,
    "vdb_count" : 200,
    "engine_id" : "engine-123",
    "engine_hostname" : "eng09.dev.delphix.com",
    "used_percentage" : 75.0,
    "used_storage" : 85000000000,
    "engine_name" : "My Favorite Engine",
    "total_capacity" : 100000000000,
    "total_object_count" : 400
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Returns a list of storage summary data of virtualization engines. VirtualizationStorageSummaryReportResponse
Up 
put /reporting/schedule/{reportId}
Update a reporting schedule by ID. (updateReportingSchedule)

Path parameters

reportId (required)
Path Parameter — The ID of the report schedule. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ReportingSchedule ReportingSchedule (optional)
Body Parameter —

Return type

ReportingSchedule

Example data

Content-Type: application/json
{
  "sort_column" : "engine_name",
  "cron_expression" : "0 0 2 ? * Mon-Fri",
  "report_id" : 123,
  "recipients" : [ "user@example.com", "user@example.com" ],
  "report_type" : "VIRTUALIZATION_STORAGE_SUMMARY",
  "time_zone" : "America/Los_Angeles",
  "message" : "sample message",
  "file_format" : "CSV",
  "enabled" : true,
  "row_count" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ReportingSchedule

SamlLogin

Up 
get /is-saml-enabled
Check if SAML is enabled (checkSaml)

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

SAML is enabled

400

SAML is not enabled ErrorResponse

Snapshots

Up 
get /snapshots/{snapshotId}
Get a Snapshot by ID. (getSnapshotById)

Path parameters

snapshotId (required)
Path Parameter — The ID of the snaphost. default: null

Return type

Snapshot

Example data

Content-Type: application/json
{
  "creation_time" : "2023-02-02T19:30:00.589Z",
  "temporary" : false,
  "ase_db_encryption_key" : "keyname",
  "start_timestamp" : "2021-05-01T08:51:34.148Z",
  "mssql_internal_version" : 706,
  "timezone" : "America/New_York,EST-0500",
  "mssql_empty_snapshot" : true,
  "timeflow_id" : "1-ORACLE_TIMEFLOW-1",
  "missing_non_logged_data" : false,
  "consistency" : "CONSISTENT",
  "start_location" : "1178883",
  "appdata_toolkit" : "APPDATA_TOOLKIT-1",
  "mssql_backup_set_uuid" : "54290b71-58cd-463d-bd62-7219d4c4d2d5",
  "id" : "snapshot-123",
  "retention" : -1,
  "timestamp" : "2021-05-01T08:51:34.148Z",
  "dataset_id" : "dataset-123",
  "mssql_backup_software_type" : "NATIVE",
  "oracle_from_physical_standby_vdb" : false,
  "oracle_redo_log_size_in_bytes" : 314572800,
  "version" : "11.2.0.4.0",
  "mssql_backup_location_type" : "BACKUP_SERVER",
  "appdata_metadata" : {
    "oracleHome" : "apps/tech_st/10.1.3"
  },
  "engine_id" : "1",
  "namespace" : "NAMESPACE-1",
  "name" : "@2023-02-02T14:30:00.589",
  "location" : "1178883"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Snapshot

Sources

Up 
post /sources/{sourceId}/tags
Create tags for a Source. (createSourceTags)

Path parameters

sourceId (required)
Path Parameter — The ID of the Source. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TagsRequest TagsRequest (required)
Body Parameter —

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created TagsResponse
Up 
post /sources/{sourceId}/tags/delete
Delete tags for a Source. (deleteSourceTags)

Path parameters

sourceId (required)
Path Parameter — The ID of the Source. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteTag DeleteTag (optional)
Body Parameter —

Responses

204

No Content
Up 
get /sources/{sourceId}
Get a source by ID. (getSourceById)

Path parameters

sourceId (required)
Path Parameter — The ID of the Source. default: null

Return type

Source

Example data

Content-Type: application/json
{
  "id" : "source-123",
  "database_type" : "Oracle",
  "name" : "production01",
  "database_version" : "11.1.0.7.0",
  "environment_id" : "environment-123",
  "data_uuid" : "1734315df891991101eb96963535afa0",
  "ip_address" : "192.0.2.0",
  "fqdn" : "prod01.myhost.com",
  "size" : 856981504,
  "jdbc_connection_string" : "jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))",
  "plugin_version" : "1.0",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Source
Up 
get /sources/{sourceId}/tags
Get tags for a Source. (getSourceTags)

Path parameters

sourceId (required)
Path Parameter — The ID of the Source. default: null

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ok TagsResponse
Up 
get /sources
List all sources. (getSources)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListSourcesResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "id" : "source-123",
    "database_type" : "Oracle",
    "name" : "production01",
    "database_version" : "11.1.0.7.0",
    "environment_id" : "environment-123",
    "data_uuid" : "1734315df891991101eb96963535afa0",
    "ip_address" : "192.0.2.0",
    "fqdn" : "prod01.myhost.com",
    "size" : 856981504,
    "jdbc_connection_string" : "jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))",
    "plugin_version" : "1.0",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ]
  }, {
    "id" : "source-123",
    "database_type" : "Oracle",
    "name" : "production01",
    "database_version" : "11.1.0.7.0",
    "environment_id" : "environment-123",
    "data_uuid" : "1734315df891991101eb96963535afa0",
    "ip_address" : "192.0.2.0",
    "fqdn" : "prod01.myhost.com",
    "size" : 856981504,
    "jdbc_connection_string" : "jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))",
    "plugin_version" : "1.0",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ]
  } ],
  "errors" : [ {
    "object_name" : "object_name",
    "message" : "message"
  }, {
    "object_name" : "object_name",
    "message" : "message"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListSourcesResponse
Up 
post /sources/search
Search for Sources. (searchSources)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

SearchSourcesResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "id" : "source-123",
    "database_type" : "Oracle",
    "name" : "production01",
    "database_version" : "11.1.0.7.0",
    "environment_id" : "environment-123",
    "data_uuid" : "1734315df891991101eb96963535afa0",
    "ip_address" : "192.0.2.0",
    "fqdn" : "prod01.myhost.com",
    "size" : 856981504,
    "jdbc_connection_string" : "jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))",
    "plugin_version" : "1.0",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ]
  }, {
    "id" : "source-123",
    "database_type" : "Oracle",
    "name" : "production01",
    "database_version" : "11.1.0.7.0",
    "environment_id" : "environment-123",
    "data_uuid" : "1734315df891991101eb96963535afa0",
    "ip_address" : "192.0.2.0",
    "fqdn" : "prod01.myhost.com",
    "size" : 856981504,
    "jdbc_connection_string" : "jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))",
    "plugin_version" : "1.0",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchSourcesResponse

VCDBs

Up 
post /vcdbs/{vcdbId}/tags
Create tags for a vCDB. (createVcdbTags)

Path parameters

vcdbId (required)
Path Parameter — The ID of the vCDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TagsRequest TagsRequest (required)
Body Parameter —

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created TagsResponse
Up 
post /vcdbs/{vcdbId}/tags/delete
Delete tags for a vCDB. (deleteVcdbTags)

Path parameters

vcdbId (required)
Path Parameter — The ID of the vCDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteTag DeleteTag (optional)
Body Parameter —

Responses

204

No Content
Up 
get /vcdbs/{vcdbId}/tags
Get tags for a vCDB. (getTagsVcdb)

Path parameters

vcdbId (required)
Path Parameter — The ID of the vCDB. default: null

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ok TagsResponse
Up 
get /vcdbs/{vcdbId}
Get a CDB by ID (Oracle only). (getVcdbById)

Path parameters

vcdbId (required)
Path Parameter — The ID of the vCDB. default: null

Return type

VCDB

Example data

Content-Type: application/json
{
  "environment_id" : "1-ENVIRONMENT-1",
  "size" : 339292672,
  "engine_id" : "engine-12",
  "group_name" : "Untitled",
  "parent_id" : "1-CDB-1",
  "name" : "Oracle CDB",
  "database_version" : "10.2.0.5.0",
  "id" : "1-CDB-1",
  "creation_date" : "2022-10-15T08:51:34.148Z",
  "enabled" : true,
  "status" : "RUNNING",
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VCDB
Up 
get /vcdbs
List all vCDBs (Oracle only). (getVcdbs)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListVCDBsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "environment_id" : "1-ENVIRONMENT-1",
    "size" : 339292672,
    "engine_id" : "engine-12",
    "group_name" : "Untitled",
    "parent_id" : "1-CDB-1",
    "name" : "Oracle CDB",
    "database_version" : "10.2.0.5.0",
    "id" : "1-CDB-1",
    "creation_date" : "2022-10-15T08:51:34.148Z",
    "enabled" : true,
    "status" : "RUNNING",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  }, {
    "environment_id" : "1-ENVIRONMENT-1",
    "size" : 339292672,
    "engine_id" : "engine-12",
    "group_name" : "Untitled",
    "parent_id" : "1-CDB-1",
    "name" : "Oracle CDB",
    "database_version" : "10.2.0.5.0",
    "id" : "1-CDB-1",
    "creation_date" : "2022-10-15T08:51:34.148Z",
    "enabled" : true,
    "status" : "RUNNING",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListVCDBsResponse
Up 
post /vcdbs/search
Search for vCDBs (Oracle only). (searchVcdbs)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

SearchVCDBsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "environment_id" : "1-ENVIRONMENT-1",
    "size" : 339292672,
    "engine_id" : "engine-12",
    "group_name" : "Untitled",
    "parent_id" : "1-CDB-1",
    "name" : "Oracle CDB",
    "database_version" : "10.2.0.5.0",
    "id" : "1-CDB-1",
    "creation_date" : "2022-10-15T08:51:34.148Z",
    "enabled" : true,
    "status" : "RUNNING",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  }, {
    "environment_id" : "1-ENVIRONMENT-1",
    "size" : 339292672,
    "engine_id" : "engine-12",
    "group_name" : "Untitled",
    "parent_id" : "1-CDB-1",
    "name" : "Oracle CDB",
    "database_version" : "10.2.0.5.0",
    "id" : "1-CDB-1",
    "creation_date" : "2022-10-15T08:51:34.148Z",
    "enabled" : true,
    "status" : "RUNNING",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchVCDBsResponse

VDBGroups

Up 
post /vdb-groups
Create a new VDBGroup. (createVdbGroup)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateVDBGroupRequest CreateVDBGroupRequest (required)
Body Parameter —

Return type

CreateVDBGroupResponse

Example data

Content-Type: application/json
{
  "vdb_group" : {
    "name" : "my-first-vdb-group",
    "vdb_ids" : [ "vdb-123", "vdb-456" ],
    "id" : "123",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

VDBGroup Created. CreateVDBGroupResponse
Up 
post /vdb-groups/{vdbGroupId}/tags
Create tags for a VDB Group. (createVdbGroupsTags)

Path parameters

vdbGroupId (required)
Path Parameter — The ID or name of the VDBGroup. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TagsRequest TagsRequest (required)
Body Parameter —

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created TagsResponse
Up 
delete /vdb-groups/{vdbGroupId}
Delete a VDBGoup. (deleteVdbGroup)

Path parameters

vdbGroupId (required)
Path Parameter — The ID or name of the VDBGroup. default: null

Responses

204

No Content
Up 
post /vdb-groups/{vdbGroupId}/tags/delete
Delete tags for a VDB Group. (deleteVdbGroupTags)

Path parameters

vdbGroupId (required)
Path Parameter — The ID or name of the VDBGroup. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteTag DeleteTag (optional)
Body Parameter —

Responses

204

No Content
Up 
get /vdb-groups/{vdbGroupId}/bookmarks
List bookmarks compatible with this VDB Group. (getBookmarksByVdbGroup)

Path parameters

vdbGroupId (required)
Path Parameter — The ID or name of the VDBGroup. default: null

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListBookmarksByVDBGroupsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "name" : "my-bookmark-123",
    "vdb_ids" : [ "vdb-123", "vdb-456" ],
    "id" : "bookmark-123",
    "creation_date" : "2021-07-04T08:51:34.148Z",
    "retention" : 365,
    "status" : "RESTORED",
    "tags" : [ {
      "key" : "key-1",
      "value" : "value-1"
    }, {
      "key" : "key-2",
      "value" : "value-2"
    } ]
  }, {
    "name" : "my-bookmark-123",
    "vdb_ids" : [ "vdb-123", "vdb-456" ],
    "id" : "bookmark-123",
    "creation_date" : "2021-07-04T08:51:34.148Z",
    "retention" : 365,
    "status" : "RESTORED",
    "tags" : [ {
      "key" : "key-1",
      "value" : "value-1"
    }, {
      "key" : "key-2",
      "value" : "value-2"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListBookmarksByVDBGroupsResponse
Up 
get /vdb-groups/{vdbGroupId}
Get a VDBGroup by name. (getVdbGroup)

Path parameters

vdbGroupId (required)
Path Parameter — The ID or name of the VDBGroup. default: null

Return type

VDBGroup

Example data

Content-Type: application/json
{
  "name" : "my-first-vdb-group",
  "vdb_ids" : [ "vdb-123", "vdb-456" ],
  "id" : "123",
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VDBGroup
Up 
get /vdb-groups/{vdbGroupId}/tags
Get tags for a VDB Group. (getVdbGroupTags)

Path parameters

vdbGroupId (required)
Path Parameter — The ID or name of the VDBGroup. default: null

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ok TagsResponse
Up 
get /vdb-groups
List all VDBGroups. (getVdbGroups)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListVDBGroupsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "name" : "my-first-vdb-group",
    "vdb_ids" : [ "vdb-123", "vdb-456" ],
    "id" : "123",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  }, {
    "name" : "my-first-vdb-group",
    "vdb_ids" : [ "vdb-123", "vdb-456" ],
    "id" : "123",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListVDBGroupsResponse
Up 
post /vdb-groups/provision_from_bookmark
Provision a new VDB Group from a Bookmark. (provisionVdbGroupFromBookmark)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ProvisionVDBGroupFromBookmarkParameters ProvisionVDBGroupFromBookmarkParameters (optional)
Body Parameter —

Return type

ProvisionVDBGroupFromBookmarkResponse

Example data

Content-Type: application/json
{
  "vdb_group" : {
    "name" : "my-first-vdb-group",
    "vdb_ids" : [ "vdb-123", "vdb-456" ],
    "id" : "123",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  },
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ProvisionVDBGroupFromBookmarkResponse
Up 
post /vdb-groups/{vdbGroupId}/refresh
Refresh a VDBGroup. (refreshVdbGroup)

Path parameters

vdbGroupId (required)
Path Parameter — The ID or name of the VDBGroup. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

RefreshVDBGroupParameters RefreshVDBGroupParameters (optional)
Body Parameter —

Return type

RefreshVDBGroupResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDBGroup refresh initiated. RefreshVDBGroupResponse
Up 
post /vdb-groups/{vdbGroupId}/rollback
Rollback a VDBGroup. (rollbackVdbGroup)

Path parameters

vdbGroupId (required)
Path Parameter — The ID or name of the VDBGroup. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

RollbackVDBGroupParameters RollbackVDBGroupParameters (optional)
Body Parameter —

Return type

RollbackVDBGroupResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDBGroup rollback initiated. RollbackVDBGroupResponse
Up 
post /vdb-groups/search
Search for VDB Groups. (searchVdbGroups)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

SearchVDBGroupResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "name" : "my-first-vdb-group",
    "vdb_ids" : [ "vdb-123", "vdb-456" ],
    "id" : "123",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  }, {
    "name" : "my-first-vdb-group",
    "vdb_ids" : [ "vdb-123", "vdb-456" ],
    "id" : "123",
    "tags" : [ {
      "value" : "value-1",
      "key" : "key-1"
    }, {
      "value" : "value-1",
      "key" : "key-1"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchVDBGroupResponse
Up 
patch /vdb-groups/{vdbGroupId}
Update values of a VDB group. (updateVdbGroupById)

Path parameters

vdbGroupId (required)
Path Parameter — The ID or name of the VDBGroup. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateVDBGroupParameters UpdateVDBGroupParameters (optional)
Body Parameter —

Return type

VDBGroup

Example data

Content-Type: application/json
{
  "name" : "my-first-vdb-group",
  "vdb_ids" : [ "vdb-123", "vdb-456" ],
  "id" : "123",
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VDBGroup

VDBs

Up 
post /vdbs/{vdbId}/tags
Create tags for a VDB. (createVdbTags)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TagsRequest TagsRequest (required)
Body Parameter —

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created TagsResponse
Up 
post /vdbs/{vdbId}/delete
Delete a VDB. (deleteVdb)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteVDBParameters DeleteVDBParameters (optional)
Body Parameter —

Return type

DeleteVDBResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDB delete initiated. DeleteVDBResponse
Up 
post /vdbs/{vdbId}/tags/delete
Delete tags for a VDB. (deleteVdbTags)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteTag DeleteTag (optional)
Body Parameter —

Responses

204

No Content
Up 
post /vdbs/{vdbId}/disable
Disable a VDB. (disableVdb)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DisableVDBParameters DisableVDBParameters (optional)
Body Parameter —

Return type

DisableVDBResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDB disable initiated. DisableVDBResponse
Up 
post /vdbs/{vdbId}/enable
Enable a VDB. (enableVdb)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

EnableVDBParameters EnableVDBParameters (optional)
Body Parameter —

Return type

EnableVDBResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDB enable initiated. EnableVDBResponse
Up 
get /vdbs/{vdbId}/tags
Get tags for a VDB. (getTagsVdb)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Return type

TagsResponse

Example data

Content-Type: application/json
{
  "tags" : [ {
    "value" : "value-1",
    "key" : "key-1"
  }, {
    "value" : "value-1",
    "key" : "key-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ok TagsResponse
Up 
get /vdbs/{vdbId}
Get a VDB by ID. (getVdbById)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Return type

VDB

Example data

Content-Type: application/json
{
  "id" : "vdb-123",
  "database_type" : "Oracle",
  "name" : "prod01-copy01",
  "database_version" : "10.2.0.5.0",
  "size" : 339292672,
  "engine_id" : "engine-123",
  "status" : "RUNNING",
  "environment_id" : "environment-123",
  "ip_address" : "192.0.2.0",
  "fqdn" : "virtual-dbs.myhost.com",
  "parent_id" : "vdb-122",
  "parent_dsource_id" : "dsource-id",
  "group_name" : "VDBs",
  "cdb_id" : "cdb-123",
  "engine_name" : "engine-123-name",
  "appdata_source_params" : {
    "param" : "value",
    "param2" : "value2"
  },
  "additional_mount_points" : [ {
    "shared_path" : "/",
    "mount_path" : "/work",
    "environment_id" : "environment-123"
  } ],
  "appdata_config_params" : {
    "foo" : "bar"
  },
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ],
  "creation_date" : "2021-05-01T08:51:34.148000+00:00",
  "hooks" : {
    "pre_refresh" : [ {
      "name" : "Print the current user",
      "command" : "whoami",
      "shell" : "bash",
      "element_id" : "0"
    } ]
  },
  "template_id" : "DATABASE_TEMPLATE-1"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VDB
Up 
get /vdbs/{vdbId}/snapshots
List Snapshots for a VDB. (getVdbSnapshots)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null

Return type

ListSnapshotsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "creation_time" : "2023-02-02T19:30:00.589Z",
    "temporary" : false,
    "ase_db_encryption_key" : "keyname",
    "start_timestamp" : "2021-05-01T08:51:34.148Z",
    "mssql_internal_version" : 706,
    "timezone" : "America/New_York,EST-0500",
    "mssql_empty_snapshot" : true,
    "timeflow_id" : "1-ORACLE_TIMEFLOW-1",
    "missing_non_logged_data" : false,
    "consistency" : "CONSISTENT",
    "start_location" : "1178883",
    "appdata_toolkit" : "APPDATA_TOOLKIT-1",
    "mssql_backup_set_uuid" : "54290b71-58cd-463d-bd62-7219d4c4d2d5",
    "id" : "snapshot-123",
    "retention" : -1,
    "timestamp" : "2021-05-01T08:51:34.148Z",
    "dataset_id" : "dataset-123",
    "mssql_backup_software_type" : "NATIVE",
    "oracle_from_physical_standby_vdb" : false,
    "oracle_redo_log_size_in_bytes" : 314572800,
    "version" : "11.2.0.4.0",
    "mssql_backup_location_type" : "BACKUP_SERVER",
    "appdata_metadata" : {
      "oracleHome" : "apps/tech_st/10.1.3"
    },
    "engine_id" : "1",
    "namespace" : "NAMESPACE-1",
    "name" : "@2023-02-02T14:30:00.589",
    "location" : "1178883"
  }, {
    "creation_time" : "2023-02-02T19:30:00.589Z",
    "temporary" : false,
    "ase_db_encryption_key" : "keyname",
    "start_timestamp" : "2021-05-01T08:51:34.148Z",
    "mssql_internal_version" : 706,
    "timezone" : "America/New_York,EST-0500",
    "mssql_empty_snapshot" : true,
    "timeflow_id" : "1-ORACLE_TIMEFLOW-1",
    "missing_non_logged_data" : false,
    "consistency" : "CONSISTENT",
    "start_location" : "1178883",
    "appdata_toolkit" : "APPDATA_TOOLKIT-1",
    "mssql_backup_set_uuid" : "54290b71-58cd-463d-bd62-7219d4c4d2d5",
    "id" : "snapshot-123",
    "retention" : -1,
    "timestamp" : "2021-05-01T08:51:34.148Z",
    "dataset_id" : "dataset-123",
    "mssql_backup_software_type" : "NATIVE",
    "oracle_from_physical_standby_vdb" : false,
    "oracle_redo_log_size_in_bytes" : 314572800,
    "version" : "11.2.0.4.0",
    "mssql_backup_location_type" : "BACKUP_SERVER",
    "appdata_metadata" : {
      "oracleHome" : "apps/tech_st/10.1.3"
    },
    "engine_id" : "1",
    "namespace" : "NAMESPACE-1",
    "name" : "@2023-02-02T14:30:00.589",
    "location" : "1178883"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListSnapshotsResponse
Up 
get /vdbs
List all vdbs. (getVdbs)

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

ListVDBsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "id" : "vdb-123",
    "database_type" : "Oracle",
    "name" : "prod01-copy01",
    "database_version" : "10.2.0.5.0",
    "size" : 339292672,
    "engine_id" : "engine-123",
    "status" : "RUNNING",
    "environment_id" : "environment-123",
    "ip_address" : "192.0.2.0",
    "fqdn" : "virtual-dbs.myhost.com",
    "parent_id" : "vdb-122",
    "parent_dsource_id" : "dsource-id",
    "group_name" : "VDBs",
    "cdb_id" : "cdb-123",
    "engine_name" : "engine-123-name",
    "appdata_source_params" : {
      "param" : "value",
      "param2" : "value2"
    },
    "additional_mount_points" : [ {
      "shared_path" : "/",
      "mount_path" : "/work",
      "environment_id" : "environment-123"
    } ],
    "appdata_config_params" : {
      "foo" : "bar"
    },
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ],
    "creation_date" : "2021-05-01T08:51:34.148000+00:00",
    "hooks" : {
      "pre_refresh" : [ {
        "name" : "Print the current user",
        "command" : "whoami",
        "shell" : "bash",
        "element_id" : "0"
      } ]
    },
    "template_id" : "DATABASE_TEMPLATE-1"
  }, {
    "id" : "vdb-123",
    "database_type" : "Oracle",
    "name" : "prod01-copy01",
    "database_version" : "10.2.0.5.0",
    "size" : 339292672,
    "engine_id" : "engine-123",
    "status" : "RUNNING",
    "environment_id" : "environment-123",
    "ip_address" : "192.0.2.0",
    "fqdn" : "virtual-dbs.myhost.com",
    "parent_id" : "vdb-122",
    "parent_dsource_id" : "dsource-id",
    "group_name" : "VDBs",
    "cdb_id" : "cdb-123",
    "engine_name" : "engine-123-name",
    "appdata_source_params" : {
      "param" : "value",
      "param2" : "value2"
    },
    "additional_mount_points" : [ {
      "shared_path" : "/",
      "mount_path" : "/work",
      "environment_id" : "environment-123"
    } ],
    "appdata_config_params" : {
      "foo" : "bar"
    },
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ],
    "creation_date" : "2021-05-01T08:51:34.148000+00:00",
    "hooks" : {
      "pre_refresh" : [ {
        "name" : "Print the current user",
        "command" : "whoami",
        "shell" : "bash",
        "element_id" : "0"
      } ]
    },
    "template_id" : "DATABASE_TEMPLATE-1"
  } ],
  "errors" : [ {
    "object_name" : "object_name",
    "message" : "message"
  }, {
    "object_name" : "object_name",
    "message" : "message"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ListVDBsResponse
Up 
post /vdbs/provision_by_snapshot
Provision a new VDB by snapshot. (provisionVdbBySnapshot)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ProvisionVDBBySnapshotParameters ProvisionVDBBySnapshotParameters (required)
Body Parameter —

Return type

ProvisionVDBResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  },
  "vdb_id" : "vdb_id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDB provisioning initiated. ProvisionVDBResponse
Up 
post /vdbs/provision_by_timestamp
Provision a new VDB by timestamp. (provisionVdbByTimestamp)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ProvisionVDBByTimestampParameters ProvisionVDBByTimestampParameters (required)
Body Parameter —

Return type

ProvisionVDBResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  },
  "vdb_id" : "vdb_id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDB provisioning initiated. ProvisionVDBResponse
Up 
post /vdbs/provision_from_bookmark
Provision a new VDB from a bookmark with a single VDB. (provisionVdbFromBookmark)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ProvisionVDBFromBookmarkParameters ProvisionVDBFromBookmarkParameters (required)
Body Parameter —

Return type

ProvisionVDBResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  },
  "vdb_id" : "vdb_id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDB provisioning initiated. ProvisionVDBResponse
Up 
post /vdbs/{vdbId}/refresh_by_snapshot
Refresh a VDB by snapshot. (refreshVdbBySnapshot)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

RefreshVDBBySnapshotParameters RefreshVDBBySnapshotParameters (optional)
Body Parameter —

Return type

RefreshVDBBySnapshotResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDB refresh initiated. RefreshVDBBySnapshotResponse
Up 
post /vdbs/{vdbId}/refresh_by_timestamp
Refresh a VDB by timestamp. (refreshVdbByTimestamp)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

RefreshVDBByTimestampParameters RefreshVDBByTimestampParameters (optional)
Body Parameter —

Return type

RefreshVDBByTimestampResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDB refresh initiated. RefreshVDBByTimestampResponse
Up 
post /vdbs/{vdbId}/refresh_from_bookmark
Refresh a VDB from bookmark with a single VDB. (refreshVdbFromBookmark)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

RefreshVDBFromBookmarkParameters RefreshVDBFromBookmarkParameters (optional)
Body Parameter —

Return type

RefreshVDBFromBookmarkResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDB refresh initiated. RefreshVDBFromBookmarkResponse
Up 
post /vdbs/{vdbId}/rollback_by_snapshot
Rollback a VDB by snapshot. (rollbackVdbBySnapshot)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

RollbackVDBBySnapshotParameters RollbackVDBBySnapshotParameters (optional)
Body Parameter —

Return type

RollbackVDBBySnapshotResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDB rollback initiated. RollbackVDBBySnapshotResponse
Up 
post /vdbs/{vdbId}/rollback_by_timestamp
Rollback a VDB by timestamp. (rollbackVdbByTimestamp)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

RollbackVDBByTimestampParameters RollbackVDBByTimestampParameters (optional)
Body Parameter —

Return type

RollbackVDBByTimestampResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDB rollback initiated. RollbackVDBByTimestampResponse
Up 
post /vdbs/{vdbId}/rollback_from_bookmark
Rollback a VDB from a bookmark with only the same VDB. (rollbackVdbFromBookmark)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

RollbackVDBFromBookmarkParameters RollbackVDBFromBookmarkParameters (optional)
Body Parameter —

Return type

RollbackVDBFromBookmarkResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDB rollback initiated. RollbackVDBFromBookmarkResponse
Up 
post /vdbs/search
Search for VDBs. (searchVdbs)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchBody SearchBody (optional)
Body Parameter —

Query parameters

limit (optional)
Query Parameter — Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. default: 100
cursor (optional)
Query Parameter — 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. default: null
sort (optional)
Query Parameter — The field to sort results by. A property name with a prepended '-' signifies descending order. default: null

Return type

SearchVDBsResponse

Example data

Content-Type: application/json
{
  "response_metadata" : {
    "prev_cursor" : "prev_cursor",
    "next_cursor" : "next_cursor",
    "total" : 0
  },
  "items" : [ {
    "id" : "vdb-123",
    "database_type" : "Oracle",
    "name" : "prod01-copy01",
    "database_version" : "10.2.0.5.0",
    "size" : 339292672,
    "engine_id" : "engine-123",
    "status" : "RUNNING",
    "environment_id" : "environment-123",
    "ip_address" : "192.0.2.0",
    "fqdn" : "virtual-dbs.myhost.com",
    "parent_id" : "vdb-122",
    "parent_dsource_id" : "dsource-id",
    "group_name" : "VDBs",
    "cdb_id" : "cdb-123",
    "engine_name" : "engine-123-name",
    "appdata_source_params" : {
      "param" : "value",
      "param2" : "value2"
    },
    "additional_mount_points" : [ {
      "shared_path" : "/",
      "mount_path" : "/work",
      "environment_id" : "environment-123"
    } ],
    "appdata_config_params" : {
      "foo" : "bar"
    },
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ],
    "creation_date" : "2021-05-01T08:51:34.148000+00:00",
    "hooks" : {
      "pre_refresh" : [ {
        "name" : "Print the current user",
        "command" : "whoami",
        "shell" : "bash",
        "element_id" : "0"
      } ]
    },
    "template_id" : "DATABASE_TEMPLATE-1"
  }, {
    "id" : "vdb-123",
    "database_type" : "Oracle",
    "name" : "prod01-copy01",
    "database_version" : "10.2.0.5.0",
    "size" : 339292672,
    "engine_id" : "engine-123",
    "status" : "RUNNING",
    "environment_id" : "environment-123",
    "ip_address" : "192.0.2.0",
    "fqdn" : "virtual-dbs.myhost.com",
    "parent_id" : "vdb-122",
    "parent_dsource_id" : "dsource-id",
    "group_name" : "VDBs",
    "cdb_id" : "cdb-123",
    "engine_name" : "engine-123-name",
    "appdata_source_params" : {
      "param" : "value",
      "param2" : "value2"
    },
    "additional_mount_points" : [ {
      "shared_path" : "/",
      "mount_path" : "/work",
      "environment_id" : "environment-123"
    } ],
    "appdata_config_params" : {
      "foo" : "bar"
    },
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ],
    "creation_date" : "2021-05-01T08:51:34.148000+00:00",
    "hooks" : {
      "pre_refresh" : [ {
        "name" : "Print the current user",
        "command" : "whoami",
        "shell" : "bash",
        "element_id" : "0"
      } ]
    },
    "template_id" : "DATABASE_TEMPLATE-1"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchVDBsResponse
Up 
post /vdbs/{vdbId}/snapshots
Snapshot a VDB. (snapshotVdb)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Return type

SnapshotVDBResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDB snapshot initiated. SnapshotVDBResponse
Up 
post /vdbs/{vdbId}/start
Start a VDB. (startVdb)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Return type

StartVDBResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDB start initiated. StartVDBResponse
Up 
post /vdbs/{vdbId}/stop
Stop a VDB. (stopVdb)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Return type

StopVDBResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VDB stop initiated. StopVDBResponse
Up 
patch /vdbs/{vdbId}
Update values of a VDB (updateVdbById)

Path parameters

vdbId (required)
Path Parameter — The ID of the VDB. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateVDBParameters UpdateVDBParameters (optional)
Body Parameter —

Return type

UpdateVDBResponse

Example data

Content-Type: application/json
{
  "job" : {
    "warning_message" : "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "start_time" : "2022-01-02T05:11:24.148Z",
    "update_time" : "2022-01-02T06:11:24.148Z",
    "trace_id" : "trace_id",
    "error_details" : "Unable to connect to the engine.",
    "target_id" : "vdb-123",
    "id" : "job-123",
    "type" : "DB_REFRESH",
    "status" : "RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK UpdateVDBResponse

Models

[ Jump to Methods ]

Table of Contents

  1. APIClassificationConfig - APIClassificationConfig
  2. AccessGroup -
  3. AccessGroupAccountIdsRequest -
  4. AccessGroupScope -
  5. AccessGroupScopesRequest -
  6. AccessGroupUpdateParameters -
  7. Account -
  8. AccountCreateParameter -
  9. AccountCreateResponse -
  10. AccountLoginParameter -
  11. AccountUpdateParameter -
  12. AdditionalMountPoint -
  13. AllObjectPermissionsResponse -
  14. AlwaysAllowedPermission -
  15. AlwaysAllowedPermissionRequest -
  16. ApiClassificationObject -
  17. ApiUsageData -
  18. ApiUsageReportResponse - ApiUsageReportResponse
  19. BaseProvisionVDBParameters -
  20. BaseProvisionVDBParameters_allOf -
  21. Bookmark -
  22. BookmarkCreateParameters -
  23. CDB -
  24. ChangePasswordParameter -
  25. ConnectivityCheckParameters - ConnectivityCheckParameters
  26. ConnectivityCheckResponse - ConnectivityResponse
  27. Connector -
  28. ConnectorTestResponse - ConnectorTestResponse
  29. ConnectorUpdateParameters -
  30. CopyMaskingJobParameters -
  31. CopyMaskingJobResponse - CopyMaskingJobResponse
  32. CreateBookmarkResponse - CreateBookmarkResponse
  33. CreateDatabaseTemplateResponse - CreateDatabaseTemplateResponse
  34. CreateEnvironmentResponse - CreateEnvironmentResponse
  35. CreateEnvironmentUserResponse - CreateEnvironmentUserResponse
  36. CreateHostResponse - CreateHostResponse
  37. CreateRole -
  38. CreateVDBGroupRequest - CreateVDBGroupRequest
  39. CreateVDBGroupResponse - CreateVDBGroupResponse
  40. DSource -
  41. DSourceConsumptionData -
  42. DSourceConsumptionReportResponse - DSourceConsumptionReportResponse
  43. DSourceSnapshotParameters -
  44. DSourceUsageData -
  45. DSourceUsageReportResponse - DSourceUsageReportResponse
  46. DataPointBySnapshotParameters -
  47. DataPointByTimestampParameters -
  48. DataPointFromBookmarkParameters -
  49. DatabaseTemplate -
  50. DatabaseTemplateCreateParameters -
  51. DeleteDatabaseTemplateResponse - DeleteDatabaseTemplateResponse
  52. DeleteEngineResponse - DeleteEngineResponse
  53. DeleteEnvironmentResponse - DeleteEnvironmentResponse
  54. DeleteEnvironmentUserResponse - DeleteEnvironmentUserResponse
  55. DeleteHostResponse - DeleteHostResponse
  56. DeleteMaskingJobResponse - DeleteMaskingJobResponse
  57. DeleteScopeObjectTags -
  58. DeleteScopedObjectItem -
  59. DeleteTag -
  60. DeleteVDBParameters -
  61. DeleteVDBResponse - DeleteVDBResponse
  62. DisableEnvironmentResponse - DisableEnvironmentResponse
  63. DisableVDBParameters -
  64. DisableVDBResponse - DisableVDBResponse
  65. Domain -
  66. EffectiveScope -
  67. EnableEnvironmentResponse - EnableEnvironmentResponse
  68. EnableVDBParameters -
  69. EnableVDBResponse - EnableVDBResponse
  70. Engine -
  71. EngineIdBody -
  72. EngineRegistrationParameter - EngineRegistrationParameter
  73. Environment -
  74. EnvironmentCreateParameters -
  75. EnvironmentUpdateParameters -
  76. EnvironmentUser -
  77. EnvironmentUserParams -
  78. Error -
  79. ErrorResponse -
  80. ExecuteMaskingJobParameters -
  81. ExecuteMaskingJobResponse - ExecuteMaskingJobResponse
  82. Execution -
  83. ExecutionCancelParameters -
  84. GlobalProperties - GlobalProperties
  85. HashicorpVault - HashicorpVault
  86. Hook -
  87. Host -
  88. HostCreateParameters -
  89. HostUpdateParameters -
  90. Job -
  91. LDAPConfigParams - LDAPConfigParams
  92. LdapConfigValidateParameter -
  93. LdapValidateResponse - LdapValidateResponse
  94. ListAccessGroupsResponse - ListAccessGroupsResponse
  95. ListAccountsResponse - ListAccountsResponse
  96. ListBookmarksByVDBGroupsResponse - ListBookmarksByVDBGroupsResponse
  97. ListBookmarksResponse - ListBookmarksResponse
  98. ListCDBsResponse - ListCDBsResponse
  99. ListConnectorsResponse - ListConnectorsResponse
  100. ListDSourcesResponse - ListDSourcesResponse
  101. ListDatabaseTemplatesResponse - ListDatabaseTemplatesResponse
  102. ListEnvironmentUsers -
  103. ListEnvironmentsResponse - ListEnvironmentsResponse
  104. ListExecutionsResponse - ListExecutionsResponse
  105. ListHashicorpVaultsResponse - ListHashicorpVaultsResponse
  106. ListJobsResponse - ListJobsResponse
  107. ListMaskingJobSourceEnginesResponse - ListMaskingJobSourceEnginesResponse
  108. ListMaskingJobsResponse - ListMaskingJobsResponse
  109. ListRegisteredEnginesResponse - ListRegisteredEnginesResponse
  110. ListReportingScheduleResponse - ListReportingScheduleResponse
  111. ListRolesResponse - ListRolesResponse
  112. ListSnapshotsResponse -
  113. ListSourcesResponse - ListSourcesResponse
  114. ListVCDBsResponse - ListVCDBsResponse
  115. ListVDBGroupsByBookmarkResponse - ListVDBGroupsByBookmarkResponse
  116. ListVDBGroupsResponse - ListVDBGroupsResponse
  117. ListVDBsResponse - ListVDBsResponse
  118. LoginToken -
  119. MaskingJob -
  120. MaskingJobConnectorsResponse -
  121. MaskingJobSourceEngine -
  122. MaskingRuleset -
  123. MigrateMaskingJobParameters -
  124. MigrateMaskingJobResponse - MigrateMaskingJobResponse
  125. ObjectPermissionAccessGroups -
  126. ObjectPermissionAccount -
  127. ObjectPermissionsResponse -
  128. ObjectTypeEnum -
  129. ObjectTypeProperty -
  130. OracleRacCustomEnvFile -
  131. OracleRacCustomEnvVar -
  132. OracleVirtualIP -
  133. PaginatedResponseMetadata -
  134. PasswordPoliciesParams - PasswordPoliciesParameters
  135. PermissionEnum -
  136. PermissionObject -
  137. PermissionProperty -
  138. PermissionsRequest -
  139. PrimaryEnvironmentUserResponse - PrimaryEnvironmentUserResponse
  140. ProductHistory -
  141. ProductInfo - ProductInfoResponse
  142. ProvisionVDBBySnapshotParameters -
  143. ProvisionVDBBySnapshotParameters_allOf -
  144. ProvisionVDBByTimestampParameters -
  145. ProvisionVDBByTimestampParameters_allOf -
  146. ProvisionVDBFromBookmarkParameters -
  147. ProvisionVDBFromBookmarkParameters_allOf -
  148. ProvisionVDBGroupFromBookmarkParameters -
  149. ProvisionVDBGroupFromBookmarkResponse - ProvisionVDBGroupFromBookmarkResponse
  150. ProvisionVDBResponse -
  151. RefreshEnvironmentResponse - RefreshEnvironmentResponse
  152. RefreshVDBBySnapshotParameters -
  153. RefreshVDBBySnapshotResponse - RefreshVDBBySnapshotResponse
  154. RefreshVDBByTimestampParameters -
  155. RefreshVDBByTimestampParameters_allOf -
  156. RefreshVDBByTimestampResponse - RefreshVDBByTimestampResponse
  157. RefreshVDBFromBookmarkParameters -
  158. RefreshVDBFromBookmarkResponse - RefreshVDBFromBookmarkResponse
  159. RefreshVDBGroupParameters -
  160. RefreshVDBGroupResponse - RefreshVDBGroupResponse
  161. RegisteredEngine - RegisteredEngine
  162. RemoveMaskingJobParameters -
  163. ReportingSchedule -
  164. ReportingScheduleCreateParameters -
  165. Repository -
  166. ResetPasswordParameter -
  167. Role -
  168. RoleUpdateParameters -
  169. Role_allOf -
  170. RollbackVDBBySnapshotParameters -
  171. RollbackVDBBySnapshotResponse - RollbackVDBBySnapshotResponse
  172. RollbackVDBByTimestampParameters -
  173. RollbackVDBByTimestampResponse - RollbackVDBByTimestampResponse
  174. RollbackVDBFromBookmarkParameters -
  175. RollbackVDBFromBookmarkResponse - RollbackVDBFromBookmarkResponse
  176. RollbackVDBGroupParameters -
  177. RollbackVDBGroupResponse - RollbackVDBGroupResponse
  178. SAMLConfigParams - SAMLConfigParams
  179. SMTPConfigParams - SMTPConfigParameters
  180. SMTPConfigValidate - SMTPValidationParams
  181. SSHVerificationStrategy -
  182. ScopeTag -
  183. ScopeTagsRequest -
  184. ScopeTagsResponse -
  185. ScopedObjectItem -
  186. ScopedObjectItemsResponse -
  187. ScopedObjectsRequest -
  188. SearchAccessGroupsResponse - SearchAccessGroupsResponse
  189. SearchAccountsResponse - SearchAccountsResponse
  190. SearchBody -
  191. SearchBookmarksResponse - SearchBookmarksResponse
  192. SearchCDBsResponse - SearchCDBsResponse
  193. SearchConnectorsResponse - SearchConnectorsResponse
  194. SearchDSourcesResponse - SearchDSourcesResponse
  195. SearchDatabaseTemplatesResponse - SearchDatabaseTemplatesResponse
  196. SearchEnginesResponse - SearchEnginesResponse
  197. SearchEnvironmentsResponse - SearchEnvironmentsResponse
  198. SearchExecutionsResponse - SearchExecutionsResponse
  199. SearchJobsResponse - SearchJobsResponse
  200. SearchMaskingJobSourceEnginesResponse - SearchMaskingJobSourceEnginesResponse
  201. SearchMaskingJobsResponse - SearchMaskingJobsResponse
  202. SearchRolesResponse - SearchRolesResponse
  203. SearchSourcesResponse - SearchSourcesResponse
  204. SearchVCDBsResponse - SearchVCDBsResponse
  205. SearchVDBGroupResponse - SearchVDBGroupResponse
  206. SearchVDBsResponse - SearchVDBsResponse
  207. Snapshot -
  208. SnapshotDSourceResponse - SnapshotDSourceResponse
  209. SnapshotVDBResponse - SnapshotVDBResponse
  210. Source -
  211. StartVDBResponse - StartVDBResponse
  212. StopVDBResponse - StopVDBResponse
  213. Tag -
  214. TagsRequest -
  215. TagsResponse -
  216. TaskEvent -
  217. TokenInfoRequest -
  218. TokenInfoResponse -
  219. UpdateAccessGroupScope -
  220. UpdateConnectorResponse - UpdateConnectorResponse
  221. UpdateDatabaseTemplateParameters -
  222. UpdateDatabaseTemplateResponse - UpdateDatabaseTemplateResponse
  223. UpdateEnvironmentResponse - UpdateEnvironmentResponse
  224. UpdateEnvironmentUserResponse - UpdateEnvironmentUserResponse
  225. UpdateHostResponse - UpdateHostResponse
  226. UpdateMaskingJobParameters -
  227. UpdateVDBGroupParameters -
  228. UpdateVDBParameters -
  229. UpdateVDBResponse - UpdateVDBResponse
  230. VCDB -
  231. VDB -
  232. VDBGroup -
  233. VDBInventoryData -
  234. VDBInventoryReportResponse - VDBInventoryReportResponse
  235. VirtualDatasetHooks -
  236. VirtualizationStorageSummaryData -
  237. VirtualizationStorageSummaryReportResponse - VirtualizationStorageSummaryReportResponse

APIClassificationConfig - APIClassificationConfig Up

Api Classification Config.
version (optional)
String Api Classification Config Version.
api_classification (optional)
array[ApiClassificationObject] The classification of each APIs, either it is automation or not.

AccessGroup - Up

An Access group is the DCT mechanism to grant roles to accounts. Each account has its own Access Group which can be used to manage permissions for that account, and an unlimited number of other Access groups can be created to manage permissions by groups of accounts.
id (optional)
String The Access group ID.
name
String The Access group name
single_account (optional)
Boolean Indicates that this Access group defines the permissions of a single account, and thus account and account tags cannot be modified. Instead create a new Access group to manage permissions of multiple accounts.
account_ids (optional)
array[Long] List of accounts ids included individually (as opposed to added by tags) in the Access group. format: int64
tagged_account_ids (optional)
array[Long] List of accounts ids included by tags in the Access group. format: int64
account_tags (optional)
array[Tag] List of account tags. Accounts matching any of these tags will be automatically added to the Access group.
scopes (optional)
array[AccessGroupScope] The Access group scopes.

AccessGroupAccountIdsRequest - Up

account_ids
set[Long] format: int64

AccessGroupScope - Up

An Access group scope allows a role to be granted to accounts in the Access group.
id (optional)
String The Access group scope ID.
name (optional)
String The Access group scope name.
role_id
String The Access group role id.
scope_type (optional)
String Specifies the type of the scope. Scope of type SIMPLE would grant access to all DCT objects. Scope of type SCOPED would grant access to all objects based on objects and object-tags and permissions defined in linked role. Scope of type ADVANCED would grant access to DCT objects based on objects and object-tags and the individual permissions.
Enum:
SIMPLE
SCOPED
ADVANCED
object_tags (optional)
array[ScopeTag] The permissions in this access group scope will be granted to all DCT objects tagged with tags matching this property. This is cumulative with objects defined in the 'objects' property, and mutually exclusive with scope_type 'SIMPLE'.
objects (optional)
array[ScopedObjectItem] The permissions in this access group scope will be granted to all DCT objects with matching object id and object type, mutually exclusive with scope_type 'SIMPLE'.
always_allowed_permissions (optional)
array[AlwaysAllowedPermission] An array of always allowed permissions which can be used to specify object type and permission. An object with same object type and permission can not be added in 'objects' array.

AccessGroupScopesRequest - Up

scopes
array[AccessGroupScope]

AccessGroupUpdateParameters - Up

name (optional)
String The Access group name

Account - Up

id (optional)
Long Numeric ID of the Account. format: int64
api_client_id (optional)
String The unique ID which is used to identify the identity of an API request. The web server (nginx) configuration must be configured so as to include the external ID as the value of the X_CLIENT_ID HTTP request header when requests are proxied. For OAuth2/JWT based authentication, this typically corresponds to a value extracted from the JWT, uniquely identifying the Account.
first_name (optional)
String An optional first name for the Account.
last_name (optional)
String An optional last name for the Account.
email (optional)
String An optional email for the Account.
username (optional)
String The username for username/password authentication. This can also be used to provide an optional logical name for the Account.
ldap_principal (optional)
String This value will be used for linking this account to an LDAP user when authenticated with the same LDAP principal. When accounts authenticate with LDAP, an LDAP principal value is calculated based on the username, msad_domain_name, search_base and username_pattern.
effective_scopes (optional)
array[EffectiveScope] Access group scopes associated with this account.
tags (optional)
array[Tag] The tags to be created for this Account.

AccountCreateParameter - Up

is_admin (optional)
Boolean Whether the created account must be granted to admin role.
generate_api_key (optional)
Boolean Whether an API key must be generated for this Account. This must be set if the Account will be used for API key based authentication, and unset otherwise.
api_client_id (optional)
String The unique ID which is used to identify the identity of an API request. The web server (nginx) configuration must be configured so as to include the external ID as the value of the X_CLIENT_ID HTTP request header when requests are proxied. If this value isn't set, the application will automatically generate one. For OAuth2/JWT based authentication, this typically corresponds to a value extracted from the JWT, uniquely identifying the Account.
first_name (optional)
String An optional first name for the Account.
last_name (optional)
String An optional last name for the Account.
email (optional)
String An optional email for the Account.
username (optional)
String The username for username/password authentication. This can also be used to provide an optional logical name for the Account.
password (optional)
String The password for username/password authentication.
ldap_principal (optional)
String This value will be used for linking this account to an LDAP user when authenticated with the same LDAP principal. When accounts authenticate with LDAP, an LDAP principal value is calculated based on the username, msad_domain_name, search_base and username_pattern.
tags (optional)
array[Tag] The tags to be created for this Account.

AccountCreateResponse - Up

token (optional)
String The opaque token to use to authenticate for other API calls. The token must be included in all HTTP API calls in a request header named "Authorization", and prefixed with "apk " to denote that it is a proprietary API key format. For instance, if the token is "abc123", request must contain the following HTTP request header: "Authorization: apk abc123".
id (optional)
Long Numeric ID of the created Account. format: int64
first_name (optional)
String First name of the created Account.
last_name (optional)
String Last name of the created Account.
email (optional)
String Email of the created Account.
username (optional)
String Username of the created Account.
ldap_principal (optional)
String The LDAP principal of the created Account.
tags (optional)
array[Tag] The tags to be created for this Account.

AccountLoginParameter - Up

username
String Username of the account that needs to login
password
String Password of the account that needs to login.

AccountUpdateParameter - Up

id (optional)
Long Numeric ID of the Account. format: int64
api_client_id (optional)
String The unique ID which is used to identify the identity of an API request. The web server (nginx) configuration must be configured so as to include the external ID as the value of the X_CLIENT_ID HTTP request header when requests are proxied. For OAuth2/JWT based authentication, this typically corresponds to a value extracted from the JWT, uniquely identifying the Account.
first_name (optional)
String An optional first name for the Account.
last_name (optional)
String An optional last name for the Account.
email (optional)
String An optional email for the Account.
username (optional)
String The username for username/password authentication. This can also be used to provide an optional logical name for the Account.
ldap_principal (optional)
String This value will be used for linking this account to an LDAP user when authenticated with the same LDAP principal. When accounts authenticate with LDAP, an LDAP principal value is calculated based on the username, msad_domain_name, search_base and username_pattern.

AdditionalMountPoint - Up

Specifies an additional location on which to mount a subdirectory of an AppData container.
shared_path (optional)
String Relative path within the container of the directory that should be mounted.
mount_path (optional)
String Absolute path on the target environment were the filesystem should be mounted
environment_id (optional)
String The entity ID of the environment on which the file system will be mounted.

AllObjectPermissionsResponse - Up

object_permissions (optional)
array[PermissionObject]

AlwaysAllowedPermission - Up

object_type
ObjectTypeEnum
permission
PermissionEnum

AlwaysAllowedPermissionRequest - Up

always_allowed_permissions
set[AlwaysAllowedPermission] An array of always allowed permissions

ApiClassificationObject - Up

An API classification object which classifies APIs as automation or management.
api_method (optional)
String HTTP method of the API.
Enum:
GET
POST
PUT
PATCH
DELETE
path (optional)
String context path of the API.
is_automation (optional)
Boolean Either this API is automation or not.
start_date (optional)
Date The start date and time from when this api's is_automation definition has changed. format: date-time
end_date (optional)
Date The end date and time from when this api's is_automation definition has changed. format: date-time

ApiUsageData - Up

api_endpoint (optional)
String API called.
api_method (optional)
String HTTP method for API called.
api_count
Long Count of API calls over the requested timeframe. format: int64
kind (optional)
String Whether the API calls are of kind automation or management
Enum:
automation
management

ApiUsageReportResponse - ApiUsageReportResponse Up

items (optional)
array[ApiUsageData]
total_automation_api_count (optional)
Long Total count of automation API calls over the requested timeframe. format: int64
total_management_api_count (optional)
Long Total count of management API calls over the requested timeframe. format: int64

BaseProvisionVDBParameters - Up

pre_refresh (optional)
array[Hook] The commands to execute on the target environment before refreshing the VDB.
post_refresh (optional)
array[Hook] The commands to execute on the target environment after refreshing the VDB.
pre_rollback (optional)
array[Hook] The commands to execute on the target environment before rewinding the VDB.
post_rollback (optional)
array[Hook] The commands to execute on the target environment after rewinding the VDB.
configure_clone (optional)
array[Hook] The commands to execute on the target environment when the VDB is created or refreshed.
pre_snapshot (optional)
array[Hook] The commands to execute on the target environment before snapshotting a virtual source. These commands can quiesce any data prior to snapshotting.
post_snapshot (optional)
array[Hook] The commands to execute on the target environment after snapshotting a virtual source.
pre_start (optional)
array[Hook] The commands to execute on the target environment before starting a virtual source.
post_start (optional)
array[Hook] The commands to execute on the target environment after starting a virtual source.
pre_stop (optional)
array[Hook] The commands to execute on the target environment before stopping a virtual source.
post_stop (optional)
array[Hook] The commands to execute on the target environment after stopping a virtual source.
target_group_id (optional)
String The ID of the group into which the VDB will be provisioned. If unset, a group is selected randomly on the Engine.
name (optional)
String The unique name of the provisioned VDB within a group. If unset, a name is randomly generated.
database_name (optional)
String The name of the database on the target environment. Defaults to the value of the name property.
cdb_id (optional)
String The ID of the container database (CDB) to provision an Oracle Multitenant database into. This corresponds to a CDB or VCDB API object. When this is not set, a new vCDB will be provisioned.
cluster_node_ids (optional)
array[String] The cluster node ids, name or addresses for this provision operation (Oracle RAC Only).
truncate_log_on_checkpoint (optional)
Boolean Whether to truncate log on checkpoint (ASE only).
os_username (optional)
String The name of the privileged user to run the provision operation (Oracle Only).
os_password (optional)
String The password of the privileged user to run the provision operation (Oracle Only).
environment_id (optional)
String The ID of the target environment where to provision the VDB. If repository_id unambigously identifies a repository, this is unnecessary and ignored. Otherwise, a compatible repository is randomly selected on the environment.
environment_user_id (optional)
String The environment user ID to use to connect to the target environment.
repository_id (optional)
String The ID of the target repository where to provision the VDB. A repository typically corresponds to a database installation (Oracle home, database instance, ...). Setting this attribute implicitly determines the environment where to provision the VDB.
auto_select_repository (optional)
Boolean Option to automatically select a compatible environment and repository. Mutually exclusive with repository_id.
vdb_restart (optional)
Boolean Indicates whether the Engine should automatically restart this virtual source when target host reboot is detected.
template_id (optional)
String The ID of the target VDB Template (Oracle Only).
auxiliary_template_id (optional)
String The ID of the configuration template to apply to the auxiliary container database. This is only relevant when provisioning a Multitenant pluggable database into an existing CDB, i.e when the cdb_id property is set.(Oracle Only)
file_mapping_rules (optional)
String Target VDB file mapping rules (Oracle Only). Rules must be line separated (\n or \r) and each line must have the format "pattern:replacement". Lines are applied in order.
oracle_instance_name (optional)
String Target VDB SID name (Oracle Only).
unique_name (optional)
String Target VDB db_unique_name (Oracle Only).
vcdb_name (optional)
String When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the name of the provisioned vCDB (Oracle Multitenant Only).
vcdb_database_name (optional)
String When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the database name of the provisioned vCDB. Defaults to the value of the vcdb_name property. (Oracle Multitenant Only).
mount_point (optional)
String Mount point for the VDB (Oracle, ASE, AppData).
open_reset_logs (optional)
Boolean Whether to open the database after provision (Oracle Only).
snapshot_policy_id (optional)
String The ID of the snapshot policy for the VDB.
retention_policy_id (optional)
String The ID of the retention policy for the VDB.
recovery_model (optional)
String Recovery model of the source database (MSSql Only).
Enum:
FULL
SIMPLE
BULK_LOGGED
pre_script (optional)
String PowerShell script or executable to run prior to provisioning (MSSql Only).
post_script (optional)
String PowerShell script or executable to run after provisioning (MSSql Only).
cdc_on_provision (optional)
Boolean Option to enable change data capture (CDC) on both the provisioned VDB and subsequent snapshot-related operations (e.g. refresh, rewind) (MSSql Only).
online_log_size (optional)
Integer Online log size in MB (Oracle Only).
online_log_groups (optional)
Integer Number of online log groups (Oracle Only).
archive_log (optional)
Boolean Option to create a VDB in archivelog mode (Oracle Only).
new_dbid (optional)
Boolean Option to generate a new DB ID for the created VDB (Oracle Only).
listener_ids (optional)
array[String] The listener IDs for this provision operation (Oracle Only).
custom_env_vars (optional)
map[String, String] Environment variable to be set when the engine creates a VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.
custom_env_files (optional)
array[String] Environment files to be sourced when the Engine creates a VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.
oracle_rac_custom_env_files (optional)
array[OracleRacCustomEnvFile] Environment files to be sourced when the Engine creates an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.
oracle_rac_custom_env_vars (optional)
array[OracleRacCustomEnvVar] Environment variable to be set when the engine creates an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.
parentTdeKeystorePath (optional)
String Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)
parent_tde_keystore_password (optional)
String The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)
tde_exported_key_file_secret (optional)
String Secret to be used while exporting and importing vPDB encryption keys if Transparent Data Encryption is enabled on the vPDB. (Oracle Multitenant Only)
tde_key_identifier (optional)
String ID of the key created by Delphix. (Oracle Multitenant Only)
target_vcdb_tde_keystore_path (optional)
String Path to the keystore of the target vCDB. (Oracle Multitenant Only)
cdb_tde_keystore_password (optional)
String The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)
vcdb_tde_key_identifier (optional)
String ID of the key created by Delphix. (Oracle Multitenant Only)
appdata_source_params (optional)
map[String, Object] The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.
additional_mount_points (optional)
array[AdditionalMountPoint] Specifies additional locations on which to mount a subdirectory of an AppData container.
appdata_config_params (optional)
map[String, Object] The list of parameters specified by the source config schema in the toolkit
config_params (optional)
map[String, Object] Database configuration parameter overrides.
tags (optional)
array[Tag] The tags to be created for VDB.

BaseProvisionVDBParameters_allOf - Up

target_group_id (optional)
String The ID of the group into which the VDB will be provisioned. If unset, a group is selected randomly on the Engine.
name (optional)
String The unique name of the provisioned VDB within a group. If unset, a name is randomly generated.
database_name (optional)
String The name of the database on the target environment. Defaults to the value of the name property.
cdb_id (optional)
String The ID of the container database (CDB) to provision an Oracle Multitenant database into. This corresponds to a CDB or VCDB API object. When this is not set, a new vCDB will be provisioned.
cluster_node_ids (optional)
array[String] The cluster node ids, name or addresses for this provision operation (Oracle RAC Only).
truncate_log_on_checkpoint (optional)
Boolean Whether to truncate log on checkpoint (ASE only).
os_username (optional)
String The name of the privileged user to run the provision operation (Oracle Only).
os_password (optional)
String The password of the privileged user to run the provision operation (Oracle Only).
environment_id (optional)
String The ID of the target environment where to provision the VDB. If repository_id unambigously identifies a repository, this is unnecessary and ignored. Otherwise, a compatible repository is randomly selected on the environment.
environment_user_id (optional)
String The environment user ID to use to connect to the target environment.
repository_id (optional)
String The ID of the target repository where to provision the VDB. A repository typically corresponds to a database installation (Oracle home, database instance, ...). Setting this attribute implicitly determines the environment where to provision the VDB.
auto_select_repository (optional)
Boolean Option to automatically select a compatible environment and repository. Mutually exclusive with repository_id.
vdb_restart (optional)
Boolean Indicates whether the Engine should automatically restart this virtual source when target host reboot is detected.
template_id (optional)
String The ID of the target VDB Template (Oracle Only).
auxiliary_template_id (optional)
String The ID of the configuration template to apply to the auxiliary container database. This is only relevant when provisioning a Multitenant pluggable database into an existing CDB, i.e when the cdb_id property is set.(Oracle Only)
file_mapping_rules (optional)
String Target VDB file mapping rules (Oracle Only). Rules must be line separated (\n or \r) and each line must have the format "pattern:replacement". Lines are applied in order.
oracle_instance_name (optional)
String Target VDB SID name (Oracle Only).
unique_name (optional)
String Target VDB db_unique_name (Oracle Only).
vcdb_name (optional)
String When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the name of the provisioned vCDB (Oracle Multitenant Only).
vcdb_database_name (optional)
String When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the database name of the provisioned vCDB. Defaults to the value of the vcdb_name property. (Oracle Multitenant Only).
mount_point (optional)
String Mount point for the VDB (Oracle, ASE, AppData).
open_reset_logs (optional)
Boolean Whether to open the database after provision (Oracle Only).
snapshot_policy_id (optional)
String The ID of the snapshot policy for the VDB.
retention_policy_id (optional)
String The ID of the retention policy for the VDB.
recovery_model (optional)
String Recovery model of the source database (MSSql Only).
Enum:
FULL
SIMPLE
BULK_LOGGED
pre_script (optional)
String PowerShell script or executable to run prior to provisioning (MSSql Only).
post_script (optional)
String PowerShell script or executable to run after provisioning (MSSql Only).
cdc_on_provision (optional)
Boolean Option to enable change data capture (CDC) on both the provisioned VDB and subsequent snapshot-related operations (e.g. refresh, rewind) (MSSql Only).
online_log_size (optional)
Integer Online log size in MB (Oracle Only).
online_log_groups (optional)
Integer Number of online log groups (Oracle Only).
archive_log (optional)
Boolean Option to create a VDB in archivelog mode (Oracle Only).
new_dbid (optional)
Boolean Option to generate a new DB ID for the created VDB (Oracle Only).
listener_ids (optional)
array[String] The listener IDs for this provision operation (Oracle Only).
custom_env_vars (optional)
map[String, String] Environment variable to be set when the engine creates a VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.
custom_env_files (optional)
array[String] Environment files to be sourced when the Engine creates a VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.
oracle_rac_custom_env_files (optional)
array[OracleRacCustomEnvFile] Environment files to be sourced when the Engine creates an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.
oracle_rac_custom_env_vars (optional)
array[OracleRacCustomEnvVar] Environment variable to be set when the engine creates an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.
parentTdeKeystorePath (optional)
String Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)
parent_tde_keystore_password (optional)
String The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)
tde_exported_key_file_secret (optional)
String Secret to be used while exporting and importing vPDB encryption keys if Transparent Data Encryption is enabled on the vPDB. (Oracle Multitenant Only)
tde_key_identifier (optional)
String ID of the key created by Delphix. (Oracle Multitenant Only)
target_vcdb_tde_keystore_path (optional)
String Path to the keystore of the target vCDB. (Oracle Multitenant Only)
cdb_tde_keystore_password (optional)
String The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)
vcdb_tde_key_identifier (optional)
String ID of the key created by Delphix. (Oracle Multitenant Only)
appdata_source_params (optional)
map[String, Object] The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.
additional_mount_points (optional)
array[AdditionalMountPoint] Specifies additional locations on which to mount a subdirectory of an AppData container.
appdata_config_params (optional)
map[String, Object] The list of parameters specified by the source config schema in the toolkit
config_params (optional)
map[String, Object] Database configuration parameter overrides.
tags (optional)
array[Tag] The tags to be created for VDB.

Bookmark - Up

A Data Control Tower object that references points in time for one or more datasets.
id (optional)
String The Bookmark object entity ID.
name (optional)
String The user-defined name of this bookmark.
creation_date (optional)
Date The date and time that this bookmark was created. format: date-time
vdb_ids (optional)
array[String] The list of VDB IDs associated with this bookmark.
retention (optional)
Long The retention policy for this bookmark, in days. A value of -1 indicates the bookmark should be kept forever. format: int64
status (optional)
String A message with details about operation progress or state of this bookmark.
tags (optional)
array[Tag] The tags to be created for this Bookmark.

BookmarkCreateParameters - Up

A Data Control Tower object that references points in time for one or more datasets.
name
String The user-defined name of this bookmark.
vdb_ids
array[String] The list of VDB IDs associated with this bookmark.
retention (optional)
Long The retention policy for this bookmark, in days. A value of -1 indicates the bookmark should be kept forever. format: int64
tags (optional)
array[Tag] The tags to be created for this Bookmark.
make_current_account_owner (optional)
Boolean Whether the account creating this bookmark must be configured as owner of the bookmark.

CDB - Up

The Delphix representation of an Oracle Container Database.
id (optional)
String The CDB object entity ID.
name (optional)
String The name of this CDB.
database_version (optional)
String The version of this CDB.
environment_id (optional)
String A reference to the Environment that hosts this CDB.
size (optional)
Long The total size of the data files used by this CDB, in bytes. format: int64
jdbc_connection_string (optional)
String The JDBC connection URL for this CDB.
engine_id (optional)
String A reference to the Engine that this CDB belongs to.
tags (optional)
array[Tag]

ChangePasswordParameter - Up

old_password
String Old password that needs to be changed for the Account.
new_password (optional)
String New password that needs to be set for the Account. Set this to null for unsetting the current password. Not including this property also results in unsetting of the current password.

ConnectivityCheckParameters - ConnectivityCheckParameters Up

Parameters to check connectivity between engine and remote host.
engine_id
String The ID of the engine to check.
host
String The hostname of the remote host machine to check.
port
Integer The port of the remote host machine to check.

ConnectivityCheckResponse - ConnectivityResponse Up

The result of the connectivity check.
message
String A message describing the result of the connectivity check.

Connector - Up

Connectors are the way users define the data sources to which the Masking Engine should connect.
id (optional)
String The Connector entity ID.
name (optional)
String The Connector name.
engine_id (optional)
String A reference to the Engine that this Connector belongs to.
type (optional)
String The type of Connector. One of Database, File, or Mainframe.
Enum:
DATABASE
FILE
MAINFRAME_DATASET
hostname (optional)
String The network hostname or IP address of the database server.
port (optional)
Integer The TCP port of the server. format: int32
username (optional)
String The username this Connector will use to connect to the database.

ConnectorTestResponse - ConnectorTestResponse Up

The result of the masking connector test.
status
String Connection status, SUCCEEDED or FAILED
Enum:
SUCCEEDED
FAILED
message
String A message describing the result of the masking connector test.

ConnectorUpdateParameters - Up

Parameters used to update a Masking Connector.
name (optional)
String The Connector name.
hostname (optional)
String The network hostname or IP address of the database server.
port (optional)
Integer The TCP port of the server. format: int32
username (optional)
String The username this Connector will use to connect to the database.
password (optional)
String The password this Connector will use to connect to the database.

CopyMaskingJobParameters - Up

Parameters to copy a masking job.
target_engine_id
String The ID of the engine to copy the job to.
source_environment_id (optional)
String The ID or name of the source environment on the target engine. This only applies to On-The-Fly jobs.
target_environment_id (optional)
String The ID or name of the target environment to copy the job into.

CopyMaskingJobResponse - CopyMaskingJobResponse Up

job (optional)
Job
masking_job_id (optional)
String

CreateBookmarkResponse - CreateBookmarkResponse Up

bookmark (optional)
Bookmark
job (optional)
Job

CreateDatabaseTemplateResponse - CreateDatabaseTemplateResponse Up

database_template (optional)
DatabaseTemplate
job (optional)
Job

CreateEnvironmentResponse - CreateEnvironmentResponse Up

job (optional)
Job
environment_id (optional)
String The id of environment created.

CreateEnvironmentUserResponse - CreateEnvironmentUserResponse Up

user_ref (optional)
String The reference of the created environment user
job (optional)
Job

CreateHostResponse - CreateHostResponse Up

job (optional)
Job
cluster_node_id (optional)
String The id of the created cluster node.

CreateRole - Up

A role Object to create a custom role.
name
String The Role name.
description (optional)
String Role description.
permission_objects
set[PermissionObject] The list of permissions granted by this role.

CreateVDBGroupRequest - CreateVDBGroupRequest Up

name
String
vdb_ids
array[String]
tags (optional)
array[Tag] The tags to be created for VDB Group.
make_current_account_owner (optional)
Boolean Whether the account creating this VDB group must be configured as owner of the VDB group.

CreateVDBGroupResponse - CreateVDBGroupResponse Up

vdb_group (optional)
VDBGroup

DSource - Up

The Delphix storage-based copy of the source database including its history.
id (optional)
String The dSource object entity ID.
database_type (optional)
String The database type of this dSource.
name (optional)
String The container name of this dSource.
database_version (optional)
String The database version of this dSource.
data_uuid (optional)
String A universal ID that uniquely identifies the dSource database.
storage_size (optional)
Long The actual space used by this dSource, in bytes. format: int64
plugin_version (optional)
String The version of the plugin associated with this source database.
creation_date (optional)
Date The date this dSource was created. format: date-time
group_name (optional)
String The name of the group containing this dSource.
enabled (optional)
Boolean A value indicating whether this dSource is enabled.
engine_id (optional)
String A reference to the Engine that this dSource belongs to.
source_id (optional)
String A reference to the Source associated with this dSource.
status (optional)
String The runtime status of the dSource. 'Unknown' if all attempts to connect to the source failed.
engine_name (optional)
String Name of the Engine where this DSource is hosted
cdb_id (optional)
String A reference to the CDB associated with this dSource.
tags (optional)
array[Tag]

DSourceConsumptionData - Up

name (optional)
String The name of the dSource
status (optional)
String The status of the dSource
database_type (optional)
String The type of the dSource
engine_id (optional)
String The id of the engine the dSource belongs to.
engine_name (optional)
String The name of the engine the dSource belongs to
last_consumption_date (optional)
Date The most recent date where consumption data was captured for this dSource. format: date-time
ingested_size (optional)
Long The ingested size of the dSource format: int64

DSourceConsumptionReportResponse - DSourceConsumptionReportResponse Up

items (optional)
array[DSourceConsumptionData]
response_metadata (optional)
PaginatedResponseMetadata

DSourceSnapshotParameters - Up

Parameters to snapshot a DSource.
drop_and_recreate_devices (optional)
Boolean If this parameter is set to true, older devices will be dropped and new devices created instead of trying to remap the devices. This might increase the space utilization on Delphix Engine. (ASE only)
sync_strategy (optional)
String

Determines how the Delphix Engine will take a backup:

  • latest_backup - Use the most recent backup.
  • new_backup - Delphix will take a new backup of your source database.
  • specific_backup - Use a specific backup. Using this option requires setting ase_backup_files for ASE dSources or mssql_backup_uuid for MSSql dSources. Default is new_backup. (ASE, MSSql only)
Enum:
latest_backup
new_backup
specific_backup
ase_backup_files (optional)
array[String] When using the specific_backup sync_strategy, determines the backup files. (ASE Only)
mssql_backup_uuid (optional)
String When using the specific_backup sync_strategy, determines the Backup Set UUID. (MSSql only)
compression_enabled (optional)
Boolean When using the new_backup sync_strategy, determines if compression must be enabled. Defaults to the configuration of the ingestion strategy configured on the Delphix Engine for this dSource. (MSSql only)
availability_group_backup_policy (optional)
String

When using the new_backup sync_strategy for an MSSql Availability Group, determines the backup policy:

  • primary - Backups only go to the primary node.
  • secondary_only - Backups only go to secondary nodes. If secondary nodes are down, backups will fail.
  • prefer_secondary - Backups go to secondary nodes, but if secondary nodes are down, backups will go to the primary node. (MSSql only)
Enum:
primary
secondary_only
prefer_secondary
do_not_resume (optional)
Boolean Indicates whether a fresh SnapSync must be started regardless if it was possible to resume the current SnapSync. If true, we will not resume but instead ignore previous progress and backup all datafiles even if already completed from previous failed SnapSync. This does not force a full backup, if an incremental was in progress this will start a new incremental snapshot. (Oracle only)
double_sync (optional)
Boolean Indicates whether two SnapSyncs should be performed in immediate succession to reduce the number of logs required to provision the snapshot. This may significantly reduce the time necessary to provision from a snapshot. (Oracle only).
force_full_backup (optional)
Boolean Whether or not to take another full backup of the source database. (Oracle only)
skip_space_check (optional)
Boolean Skip check that tests if there is enough space available to store the database in the Delphix Engine. The Delphix Engine estimates how much space a database will occupy after compression and prevents SnapSync if insufficient space is available. This safeguard can be overridden using this option. This may be useful when linking highly compressible databases. (Oracle only)
files_for_partial_full_backup (optional)
array[Long] List of datafiles to take a full backup of. This would be useful in situations where certain datafiles could not be backed up during previous SnapSync due to corruption or because they went offline. (Oracle only) format: int64

DSourceUsageData - Up

engine_name (optional)
String The name of the engine the dSource belongs to.
name (optional)
String The name of the dSource
unvirtualized_space (optional)
Long The the disk space that would be required if not using Delphix virtualizion, in bytes. format: int64
actual_space (optional)
Long The actual space used by this dSource, in bytes. This includes the disk space used by the current copy of the data as well as the snaphots and log files retained to enable provisioning from historical versions. format: int64
dependant_vdbs (optional)
Integer The number of VDBs that are dependant on this dSource. This includes all VDB descendants that have this dSource as an ancestor.

DSourceUsageReportResponse - DSourceUsageReportResponse Up

items (optional)
array[DSourceUsageData]
response_metadata (optional)
PaginatedResponseMetadata

DataPointBySnapshotParameters - Up

snapshot_id (optional)
String The ID of the snapshot from which to execute the operation. If the snapshot_id is not, selects the latest snapshot.

DataPointByTimestampParameters - Up

timestamp (optional)
Date The point in time from which to execute the operation. Mutually exclusive with timestamp_in_database_timezone. If the timestamp is not set, selects the latest point. format: date-time
timestamp_in_database_timezone (optional)
String The point in time from which to execute the operation, expressed as a date-time in the timezone of the source database. Mutually exclusive with timestamp.

DataPointFromBookmarkParameters - Up

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

DatabaseTemplate - Up

A database template to use for provisioning and refresh. If set, configParams will be ignored on provision or refresh.
id (optional)
String The DatabaseTemplate entity ID.
name
String The DatabaseTemplate name.
description (optional)
String User provided description for this template.
source_type
String The type of the source associated with the template.
Enum:
OracleVirtualSource
OracleLinkedSource
MSSqlVirtualSource
MSSqlLinkedSource
parameters (optional)
map[String, String] A name/value map of string configuration parameters.

DatabaseTemplateCreateParameters - Up

Parameters to create a database template.
name
String The DatabaseTemplate name.
description (optional)
String User provided description for this template.
source_type
String The type of the source associated with the template.
Enum:
OracleVirtualSource
OracleLinkedSource
MSSqlVirtualSource
MSSqlLinkedSource
parameters (optional)
map[String, String] A name/value map of string configuration parameters.
make_current_account_owner (optional)
Boolean Whether the account creating this database template must be configured as owner of the database template.

DeleteDatabaseTemplateResponse - DeleteDatabaseTemplateResponse Up

job (optional)
Job

DeleteEngineResponse - DeleteEngineResponse Up

job (optional)
Job

DeleteEnvironmentResponse - DeleteEnvironmentResponse Up

job (optional)
Job

DeleteEnvironmentUserResponse - DeleteEnvironmentUserResponse Up

job (optional)
Job

DeleteHostResponse - DeleteHostResponse Up

job (optional)
Job

DeleteMaskingJobResponse - DeleteMaskingJobResponse Up

job (optional)
Job

DeleteScopeObjectTags - Up

tags (optional)
set[ScopeTag] List of scope tags to be deleted

DeleteScopedObjectItem - Up

objects
set[ScopedObjectItem] List of scoped objects to be deleted

DeleteTag - Up

key (optional)
String Key of the tag
value (optional)
String Value of the tag
tags (optional)
set[Tag] List of tags to be deleted

DeleteVDBParameters - Up

Parameters to delete a VDB.
force (optional)
Boolean Whether to continue the operation upon failures.

DeleteVDBResponse - DeleteVDBResponse Up

job (optional)
Job

DisableEnvironmentResponse - DisableEnvironmentResponse Up

job (optional)
Job

DisableVDBParameters - Up

Parameters to disable a VDB.
attempt_cleanup (optional)
Boolean Whether to attempt a cleanup of the VDB before the disable.

DisableVDBResponse - DisableVDBResponse Up

job (optional)
Job

Domain - Up

msad_domain_name (optional)
String This is used to get full DN for authentication and search. Provide this value only if server is microsoft AD.
username_pattern (optional)
String The username_patterns can be used to avoid providing full-dn during login. This will also be used for search of groups,email, first name and last name.
search_base (optional)
String Search base used to search for ldap user groups. Leave this field empty if a full username_pattern is provided and server is non microsoft AD.
group_attr (optional)
String Group mapped attribute on ldap side used for user group search.
email_attr (optional)
String Email mapped attribute on ldap side used for mapping on DCT side account.
first_name_attr (optional)
String First name attribute mapped on ldap side used for mapping on DCT side account.
last_name_attr (optional)
String Last name attribute mapped on ldap side used for mapping on DCT side account.
object_class_attr (optional)
String The name of the objectClass on ldap side under which the user is mapped.This is used to search for the user details.
search_attr (optional)
String Search attribute mapped on ldap side using which search on ldap side will be made.

EffectiveScope - Up

id (optional)
String Id of the access group scope.
name (optional)
String Name of the access group scope.

EnableEnvironmentResponse - EnableEnvironmentResponse Up

job (optional)
Job

EnableVDBParameters - Up

Parameters to enable a VDB.
attempt_start (optional)
Boolean Whether to attempt a startup of the VDB after the enable.

EnableVDBResponse - EnableVDBResponse Up

job (optional)
Job

Engine - Up

A Delphix Virtualization or Masking Engine.
id (optional)
String The Engine object entity ID.
uuid (optional)
String The unique identifier generated by this engine.
type (optional)
String The type of this engine.
Enum:
VIRTUALIZATION
MASKING
BOTH
UNSET
version (optional)
String The engine version.
name (optional)
String The name of this engine.
hostname (optional)
String The hostname of this engine.
registration_status (optional)
String The registration status of this engine.
Enum:
CONNECTED
PENDING
connection_status (optional)
String The connection status of this engine.
Enum:
ONLINE
OFFLINE
last_connection_time (optional)
Date The last time a connection was established with this engine. format: date-time
boot_storage_capacity (optional)
Long The total amount of storage allocated to the engine's boot partition, in bytes. format: int64
cpu_core_count (optional)
Integer The total number of CPU cores on this engine. format: int32
cpu_type (optional)
String The model of the processors on this engine.
memory_size (optional)
Long The total amount of memory on this engine, in bytes. format: int64
data_storage_capacity (optional)
Long The total amount of storage allocated for engine objects and system metadata, in bytes. format: int64
data_storage_used (optional)
Long The amount of storage used by engine objects and system metadata, in bytes. format: int64
tags (optional)
array[Tag]

EngineIdBody - Up

The ID of the registered engine.
engine_id (optional)
String

EngineRegistrationParameter - EngineRegistrationParameter Up

Parameters to register and authenticate an engine.
name
String
hostname
String
username (optional)
String The virtualization domain admin username.
password (optional)
String The virtualization domain admin password.
masking_username (optional)
String The masking admin username.
masking_password (optional)
String The masking admin password.
hashicorp_vault_username_command_args (optional)
array[String] Arguments to pass to the Vault CLI tool to retrieve the virtualzation username for the engine.
hashicorp_vault_masking_username_command_args (optional)
array[String] Arguments to pass to the Vault CLI tool to retrieve the masking username for the engine.
hashicorp_vault_password_command_args (optional)
array[String] Arguments to pass to the Vault CLI tool to retrieve the virtualization password for the engine.
hashicorp_vault_masking_password_command_args (optional)
array[String] Arguments to pass to the Vault CLI tool to retrieve the masking password for the engine.
hashicorp_vault_id (optional)
Long Reference to the Hashicorp vault to use to retrieve virtualization engine credentials. format: int64
masking_hashicorp_vault_id (optional)
Long Reference to the Hashicorp vault to use to retrieve masking engine credentials. format: int64
insecure_ssl (optional)
Boolean Allow connections to the engine over HTTPs without validating the TLS certificate. Even though the connection to the engine might be performed over HTTPs, setting this property eliminates the protection against a man-in-the-middle attach for connections to this engine. Instead, consider creating a truststore with a Certificate Authority to validate the engine's certificate, and set the truststore_path propery.
unsafe_ssl_hostname_check (optional)
Boolean Ignore validation of the name associated to the TLS certificate when connecting to the engine over HTTPs. Setting this value must only be done if the TLS certificate of the engine does not match the hostname, and the TLS configuration of the engine cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this engine. This is ignored if insecure_ssl is set.
truststore_filename (optional)
String File name of a truststore which can be used to validate the TLS certificate of the engine. The truststore must be available at /etc/config/certs/<truststore_filename>
truststore_password (optional)
String Password to read the truststore.
tags (optional)
array[Tag] The tags to be created for this engine.

Environment - Up

A grouping of a single host or a cluster of hosts.
id (optional)
String The Environment object entity ID.
name (optional)
String The name of this environment.
namespace (optional)
String The namespace of this environment for replicated and restored objects.
engine_id (optional)
String A reference to the Engine that this Environment connection is associated with.
enabled (optional)
Boolean True if this environment is enabled.
is_cluster (optional)
Boolean True if this environment is a cluster of hosts.
is_windows_target (optional)
Boolean True if this windows environment is a target environment.
hosts (optional)
array[Host] The hosts that are part of this environment.
tags (optional)
array[Tag] The tags to be created for this environment.
repositories (optional)
array[Repository] Repositories associated with this environment. A Repository typically corresponds to a database installation.

EnvironmentCreateParameters - Up

name (optional)
String The name of the environment.
engine_id
String The ID of the Engine onto which to create the environment.
os_name
String Operating system type of the environment.
Enum:
UNIX
WINDOWS
is_cluster (optional)
Boolean Whether the environment to be created is a cluster.
cluster_home (optional)
String Absolute path to cluster home drectory. This parameter is mandatory for UNIX cluster environments.
hostname
String host address of the machine.
staging_environment (optional)
String Id of the connector environment which is used to connect to this source environment. This is mandatory parameter when creating Windows source environments.
connector_port (optional)
Integer Specify port on which Delphix connector will run. This is mandatory parameter when creating Windows target environments. format: int32
connector_authentication_key (optional)
String Unique per Delphix key used to authenticate with the remote Delphix Connector.
is_target (optional)
Boolean Whether the environment to be created is a target cluster environment. This property is used only when creating Windows cluster environments.
ssh_port (optional)
Long ssh port of the host. format: int64
toolkit_path (optional)
String The path for the toolkit that resides on the host.
username (optional)
String Username of the OS.
password (optional)
String Password of the OS.
vault (optional)
String The name or reference of the vault from which to read the host credentials.
hashicorp_vault_engine (optional)
String Vault engine name where the credential is stored.
hashicorp_vault_secret_path (optional)
String Path in the vault engine where the credential is stored.
hashicorp_vault_username_key (optional)
String Key for the username in the key-value store.
hashicorp_vault_secret_key (optional)
String Key for the password in the key-value store.
cyberark_vault_query_string (optional)
String Query to find a credential in the CyberArk vault.
use_kerberos_authentication (optional)
Boolean Whether to use kerberos authentication.
use_engine_public_key (optional)
Boolean Whether to use public key authentication.
nfs_addresses (optional)
array[String] array of ip address or hostnames
ase_db_username (optional)
String username of the SAP ASE database.
ase_db_password (optional)
String password of the SAP ASE database.
ase_db_vault (optional)
String The name or reference of the vault from which to read the ASE database credentials.
ase_db_hashicorp_vault_engine (optional)
String Vault engine name where the credential is stored.
ase_db_hashicorp_vault_secret_path (optional)
String Path in the vault engine where the credential is stored.
ase_db_hashicorp_vault_username_key (optional)
String Key for the username in the key-value store.
ase_db_hashicorp_vault_secret_key (optional)
String Key for the password in the key-value store.
ase_db_cyberark_vault_query_string (optional)
String Query to find a credential in the CyberArk vault.
ase_db_use_kerberos_authentication (optional)
Boolean Whether to use kerberos authentication for ASE DB discovery.
java_home (optional)
String The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used.
dsp_keystore_path (optional)
String DSP keystore path.
dsp_keystore_password (optional)
String DSP keystore password.
dsp_keystore_alias (optional)
String DSP keystore alias.
dsp_truststore_path (optional)
String DSP truststore path.
dsp_truststore_password (optional)
String DSP truststore password.
description (optional)
String The environment description.
tags (optional)
array[Tag] The tags to be created for this environment.
make_current_account_owner (optional)
Boolean Whether the account creating this environment must be configured as owner of the environment.

EnvironmentUpdateParameters - Up

name (optional)
String The name of the environment.
staging_environment (optional)
String Id of the connector environment which is used to connect to this source environment.
cluster_address (optional)
String Address of the cluster. This property can be modified for Windows cluster only.
cluster_home (optional)
String Absolute path to cluster home directory. This parameter is for UNIX cluster environments.
ase_db_username (optional)
String username of the SAP ASE database.
ase_db_password (optional)
String password of the SAP ASE database.
ase_db_vault (optional)
String The name or reference of the vault from which to read the ASE database credentials.
ase_db_hashicorp_vault_engine (optional)
String Vault engine name where the credential is stored.
ase_db_hashicorp_vault_secret_path (optional)
String Path in the vault engine where the credential is stored.
ase_db_hashicorp_vault_username_key (optional)
String Key for the username in the key-value store.
ase_db_hashicorp_vault_secret_key (optional)
String Key for the password in the key-value store.
ase_db_cyberark_vault_query_string (optional)
String Query to find a credential in the CyberArk vault.
ase_db_use_kerberos_authentication (optional)
Boolean Whether to use kerberos authentication for ASE DB discovery.
description (optional)
String The environment description.

EnvironmentUser - Up

user_ref (optional)
String Environment user reference
username (optional)
String Username of environment user
primary_user (optional)
Boolean This indicates if this user is primary or not
auth_type (optional)
String Authentication type of this user. PasswordCredential indicates username and password are used, SystemKeyCredential indicates public key based security credential, KeyPairCredential indicates public key based security credential consisting of a user specified key pair, KerberosCredential indicates Kerberos authentication, CyberArkVaultCredential indicates CyberArk Vault is used and HashiCorpVaultCredential indicates that Hashicorp vault is used for authentication
Enum:
PasswordCredential
SystemKeyCredential
KeyPairCredential
KerberosCredential
CyberArkVaultCredential
HashiCorpVaultCredential

EnvironmentUserParams - Up

username (optional)
String Username of the OS.
password (optional)
String Password of the OS.
vault (optional)
String The name or reference of the vault from which to read the host credentials.
vault_username (optional)
String Delphix display name for the vault user
hashicorp_vault_engine (optional)
String Vault engine name where the credential is stored.
hashicorp_vault_secret_path (optional)
String Path in the vault engine where the credential is stored.
hashicorp_vault_username_key (optional)
String Key for the username in the key-value store.
hashicorp_vault_secret_key (optional)
String Key for the password in the key-value store.
cyberark_vault_query_string (optional)
String Query to find a credential in the CyberArk vault.
use_kerberos_authentication (optional)
Boolean Whether to use kerberos authentication.
use_engine_public_key (optional)
Boolean Whether to use public key authentication.

Error - Up

message (optional)
String Message providing more detail about the error that occurred, if available.
object_name (optional)
String Name of the object affected by the error.

ErrorResponse - Up

error (optional)
String Error code for any failure
error_description (optional)
String Error description for any failure

ExecuteMaskingJobParameters - Up

Parameters to execute a MaskingJob.
engine_id
String The ID of the Engine to execute this MaskingJob on.

ExecuteMaskingJobResponse - ExecuteMaskingJobResponse Up

job (optional)
Job

Execution - Up

The execution of a masking or profile job.
id (optional)
String The Execution entity ID.
engine_id (optional)
String The ID of the engine where this execution ran.
masking_job_id (optional)
String The ID of the masking job that is being executed.
source_connector_id (optional)
String The ID of the source connector. This field is only used for multi-tenant jobs that are also on-the-fly.
target_connector_id (optional)
String The ID of the target connector. This field is only used for multi-tenant jobs.
status (optional)
String The status of the execution regarding its completion.
Enum:
PENDING
QUEUED
RUNNING
CANCELLED
FAILED
SUCCEEDED
rows_masked (optional)
Long The number of rows masked or profiled so far by this execution. This is not applicable for JSON file type. format: int64
rows_total (optional)
Long The total number of rows that this execution should mask. This value is set to -1 while the total row count is being calculated. This is not applicable for JSON file type. format: int64
bytes_processed (optional)
Long The number of bytes masked so far by this execution. This is only applicable for JSON file type. format: int64
bytes_total (optional)
Long The total number of bytes that this execution should mask. This value is set to -1 while the total byte count is being calculated. This is only applicable for JSON file type. format: int64
start_time (optional)
Date The date and time that this execution was started. format: date-time
submit_time (optional)
Date The date and time that this execution was submitted. format: date-time
end_time (optional)
Date The date and time that this execution completed. format: date-time
task_events (optional)
array[TaskEvent] The progression of steps or events performed by this execution. Only available for executions on masking engines that are version 6.0.14.0 and higher.

ExecutionCancelParameters - Up

Parameters to cancel an execution.
expected_status (optional)
String The expected status of the execution to cancel to prevent cancelling a queued job that has transitioned to a running state since the request was issued.
Enum:
QUEUED
RUNNING

GlobalProperties - GlobalProperties Up

Global properties response.
disable_username_password (optional)
Boolean Property to define either username & password based authentication disabled or not.

HashicorpVault - HashicorpVault Up

Configuration required to connect and authenticate with an Hashicorp Vault which stores engines username and passwords.
id (optional)
Long format: int64
env_variables (optional)
map[String, String] Environment variables to set when invoking the Vault CLI tool. The environment variables will be used both to login to the vault (if this step is required) and to retrieve engine username and passwords.
login_command_args (optional)
array[String] Arguments to the "vault" CLI tool to be used to fetch a client token (or "login"). If supporting files, such as TLS certificates, must be used to authenticate, they can be mounted to the /etc/config directory. This property must not be set when using the TOKEN authentication method as login is not required.

Hook - Up

name (optional)
String
command
String
shell (optional)
String
Enum:
bash
shell
expect
ps
psd
element_id (optional)
String
has_credentials (optional)
Boolean

Host - Up

A physical/virtual server.
id (optional)
String The entity ID of this Host.
hostname (optional)
String The hostname or IP address of this host.
os_name (optional)
String The name of the OS on this host.
os_version (optional)
String The version of the OS on this host.
memory_size (optional)
Long The total amount of memory on this host in bytes. format: int64
available (optional)
Boolean True if the host is up and a connection can be established from the engine.
available_timestamp (optional)
Date The last time the available property was updated. format: date-time
not_available_reason (optional)
String The reason why the host is not available.
oracle_cluster_node_reference (optional)
String The reference to the associated OracleClusterNode.
oracle_cluster_node_name (optional)
String The name of the associated OracleClusterNode.
oracle_cluster_node_enabled (optional)
Boolean Whether the associated OracleClusterNode is enabled.
oracle_cluster_node_discovered (optional)
Boolean Whether the associated OracleClusterNode was discovered.
oracle_cluster_node_virtual_ips (optional)
array[OracleVirtualIP] The Virtual IP addresses associated with the OracleClusterNode.
windows_cluster_node_reference (optional)
String The reference to the associated WindowsClusterNode.
windows_cluster_node_name (optional)
String The name of the associated WindowsClusterNode.
windows_cluster_node_discovered (optional)
Boolean Whether the associated Windows cluster node was discovered.

HostCreateParameters - Up

name (optional)
String The name to associate with the host.
hostname (optional)
String The hostname or IP address of this host.
nfs_addresses (optional)
array[String] The list of host/IP addresses to use for NFS export.
ssh_port (optional)
Integer The port number used to connect to the host via SSH.
privilege_elevation_profile_reference (optional)
String Reference to a profile for escalating user privileges.
dsp_keystore_alias (optional)
String The lowercase alias to use inside the user managed DSP keystore.
dsp_keystore_password (optional)
String The password for the user managed DSP keystore. format: password
dsp_keystore_path (optional)
String The path to the user managed DSP keystore.
dsp_truststore_password (optional)
String The password for the user managed DSP truststore. format: password
dsp_truststore_path (optional)
String The path to the user managed DSP truststore.
java_home (optional)
String The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used.
toolkit_path (optional)
String The path for the toolkit that resides on the host.
oracle_jdbc_keystore_password (optional)
String The password for the user managed Oracle JDBC keystore. format: password
oracle_tde_keystores_root_path (optional)
String The path to the root of the Oracle TDE keystores artifact directories.
ssh_verification_strategy (optional)
SSHVerificationStrategy
oracle_cluster_node_virtual_ips (optional)
array[OracleVirtualIP] The Virtual IP addresses associated with the OracleClusterNode.

HostUpdateParameters - Up

hostname (optional)
String host address of the machine.
oracle_cluster_node_name (optional)
String The name of the associated OracleClusterNode.
oracle_cluster_node_enabled (optional)
Boolean Whether the associated OracleClusterNode is enabled.
oracle_cluster_node_virtual_ips (optional)
array[OracleVirtualIP] The Virtual IP addresses associated with the OracleClusterNode.
nfs_addresses (optional)
array[String] array of ip addresses or hostnames
ssh_port (optional)
Long ssh port of the host. format: int64
toolkit_path (optional)
String The path for the toolkit that resides on the host.
java_home (optional)
String The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used.
dsp_keystore_path (optional)
String DSP keystore path.
dsp_keystore_password (optional)
String DSP keystore password.
dsp_keystore_alias (optional)
String DSP keystore alias.
dsp_truststore_path (optional)
String DSP truststore path.
dsp_truststore_password (optional)
String DSP truststore password.
connector_port (optional)
Integer Specify port on which Delphix connector will run. format: int32
oracle_jdbc_keystore_password (optional)
String The password for the user managed Oracle JDBC keystore. format: password
oracle_tde_keystores_root_path (optional)
String The path to the root of the Oracle TDE keystores artifact directories.
ssh_verification_strategy (optional)
SSHVerificationStrategy
connector_authentication_key (optional)
String Unique per Delphix key used to authenticate with the remote Delphix Connector.

Job - Up

An asynchronous task.
id (optional)
String The Job entity ID.
status (optional)
String The status of the job.
Enum:
PENDING
STARTED
TIMEDOUT
RUNNING
CANCELED
FAILED
SUSPENDED
WAITING
COMPLETED
ABANDONED
type (optional)
String The type of job being done.
error_details (optional)
String Details about the failure for FAILED jobs.
warning_message (optional)
String Warnings for the job.
target_id (optional)
String A reference to the job's target.
start_time (optional)
Date The time the job started executing. format: date-time
update_time (optional)
Date The time the job was last updated. format: date-time
trace_id (optional)
String traceId of the request which created this Job

LDAPConfigParams - LDAPConfigParams Up

Parameters to read or update LDAP Config
enabled (optional)
Boolean When set, these settings are enabled. True by default.
auto_create_users (optional)
Boolean When set, the system will automatically create new Accounts for those who have logged in using LDAP. This must be true if LDAP user is not already registered in system. True by default.
hostname (optional)
String The hostname of the LDAP server.
port (optional)
Integer The port of the LDAP server. Default port is 389 for non-SSL and 636 for SSL.
domains (optional)
array[Domain] DCT will try to authenticate using each Domain given in this list.
enable_ssl (optional)
Boolean True if LDAP should be used over SSL.
truststore_filename (optional)
String File name of a truststore which can be used to validate the TLS certificate of the LDAP server. The truststore must be available at /etc/config/certs/<truststore_filename>
truststore_password (optional)
String Password for reading trustStore file provided in 'truststore_filename' property
insecure_ssl (optional)
Boolean Allow connections to the LDAP server over LDAPS without validating the TLS certificate. Even though the connection to the server might be performed over LDAPS, setting this property eliminates the protection against a man-in-the-middle attach for connections to this server. Instead, consider creating a truststore with a Certificate Authority to validate the server's certificate, and set the truststore_filename property.
unsafe_ssl_hostname_check (optional)
Boolean Ignore validation of the name associated to the TLS certificate when connecting to the LDAP server over LDAPS. Setting this value must only be done if the TLS certificate of the server does not match the hostname, and the TLS configuration of the server cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this server. This is ignored if insecure_ssl is set.

LdapConfigValidateParameter - Up

username (optional)
String Username of the account to validate the ldap optional attributes.
password (optional)
String Password of the account to validate the ldap optional attributes.

LdapValidateResponse - LdapValidateResponse Up

message (optional)
String Validation message for LDAP config.

ListAccessGroupsResponse - ListAccessGroupsResponse Up

items (optional)
array[AccessGroup]
response_metadata (optional)
PaginatedResponseMetadata

ListAccountsResponse - ListAccountsResponse Up

items (optional)
array[Account]
response_metadata (optional)
PaginatedResponseMetadata

ListBookmarksByVDBGroupsResponse - ListBookmarksByVDBGroupsResponse Up

items (optional)
array[Bookmark]
response_metadata (optional)
PaginatedResponseMetadata

ListBookmarksResponse - ListBookmarksResponse Up

items (optional)
array[Bookmark]
response_metadata (optional)
PaginatedResponseMetadata

ListCDBsResponse - ListCDBsResponse Up

items (optional)
array[CDB]
response_metadata (optional)
PaginatedResponseMetadata

ListConnectorsResponse - ListConnectorsResponse Up

items (optional)
array[Connector]
response_metadata (optional)
PaginatedResponseMetadata

ListDSourcesResponse - ListDSourcesResponse Up

items (optional)
array[DSource]
errors (optional)
array[Error] Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. The Errors object contains information about full or partial failures which might have occurred during the request.
response_metadata (optional)
PaginatedResponseMetadata

ListDatabaseTemplatesResponse - ListDatabaseTemplatesResponse Up

items (optional)
array[DatabaseTemplate]
response_metadata (optional)
PaginatedResponseMetadata

ListEnvironmentUsers - Up

users (optional)
array[EnvironmentUser] List of users

ListEnvironmentsResponse - ListEnvironmentsResponse Up

items (optional)
array[Environment]
errors (optional)
array[Error] Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. The Errors object contains information about full or partial failures which might have occurred during the request.
response_metadata (optional)
PaginatedResponseMetadata

ListExecutionsResponse - ListExecutionsResponse Up

items (optional)
array[Execution]
response_metadata (optional)
PaginatedResponseMetadata

ListHashicorpVaultsResponse - ListHashicorpVaultsResponse Up

items (optional)
array[HashicorpVault]
response_metadata (optional)
PaginatedResponseMetadata

ListJobsResponse - ListJobsResponse Up

items (optional)
array[Job]
errors (optional)
array[Error] Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. The Errors object contains information about full or partial failures which might have occurred during the request.
response_metadata (optional)
PaginatedResponseMetadata

ListMaskingJobSourceEnginesResponse - ListMaskingJobSourceEnginesResponse Up

items (optional)
array[MaskingJobSourceEngine]
response_metadata (optional)
PaginatedResponseMetadata

ListMaskingJobsResponse - ListMaskingJobsResponse Up

items (optional)
array[MaskingJob]
response_metadata (optional)
PaginatedResponseMetadata

ListRegisteredEnginesResponse - ListRegisteredEnginesResponse Up

items (optional)
array[RegisteredEngine]
response_metadata (optional)
PaginatedResponseMetadata

ListReportingScheduleResponse - ListReportingScheduleResponse Up

items (optional)
array[ReportingSchedule]
response_metadata (optional)
PaginatedResponseMetadata

ListRolesResponse - ListRolesResponse Up

items (optional)
array[Role]

ListSnapshotsResponse - Up

items (optional)
array[Snapshot]
response_metadata (optional)
PaginatedResponseMetadata

ListSourcesResponse - ListSourcesResponse Up

items (optional)
array[Source]
errors (optional)
array[Error] Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. The Errors object contains information about full or partial failures which might have occurred during the request.
response_metadata (optional)
PaginatedResponseMetadata

ListVCDBsResponse - ListVCDBsResponse Up

items (optional)
array[VCDB]
response_metadata (optional)
PaginatedResponseMetadata

ListVDBGroupsByBookmarkResponse - ListVDBGroupsByBookmarkResponse Up

items (optional)
array[VDBGroup]
response_metadata (optional)
PaginatedResponseMetadata

ListVDBGroupsResponse - ListVDBGroupsResponse Up

items (optional)
array[VDBGroup]
response_metadata (optional)
PaginatedResponseMetadata

ListVDBsResponse - ListVDBsResponse Up

items (optional)
array[VDB]
errors (optional)
array[Error] Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. The Errors object contains information about full or partial failures which might have occurred during the request.
response_metadata (optional)
PaginatedResponseMetadata

LoginToken - Up

access_token
String Opaque token that validates the successful account login and is used to authenticate subsequent api calls. This token needs to be sent as part of 'Authorization' header for all api calls prefixed with value contained in 'token_type' property. For example, if the 'access_token' value is "abc123" and 'token_type' is "Bearer" then HTTP requests should contain following header : "Authorization: Bearer abc123"
token_type
String Type of the token returned in 'access_token' property.
expires_in
Long Seconds duration after which the token will expire. format: int64

MaskingJob - Up

A masking job.
id (optional)
String The MaskingJob entity ID.
name (optional)
String The name of this MaskingJob.
ruleset (optional)
MaskingRuleset
is_on_the_fly_masking (optional)
Boolean Whether this is an on-the-fly masking job.
creation_date (optional)
Date The date this MaskingJob was created. format: date-time
last_completed_execution_date (optional)
Date The date this MaskingJob was last executed to completion. format: date-time
last_execution_status (optional)
String The status of this MaskingJob's last execution.
Enum:
PENDING
CANCELLED
FAILED
QUEUED
RUNNING
SUCCEEDED
connector_username (optional)
String The username of the Connector used by the MaskingJob.
connector_password (optional)
String The password of the Connector used by the MaskingJob.
on_the_fly_source_connector_username (optional)
String The username of the source Connector used by the on-the-fly MaskingJob.
on_the_fly_source_connector_password (optional)
String The password of the source Connector used by the on-the-fly MaskingJob.
tags (optional)
array[Tag]

MaskingJobConnectorsResponse - Up

Connector(s) for a masking job.
connector (optional)
Connector
on_the_fly_connector (optional)
Connector

MaskingJobSourceEngine - Up

A masking job's source engine.
masking_job_id (optional)
String The MaskingJob entity ID.
source_engine_id (optional)
String The ID of the Engine serving as the source for the MaskingJob.

MaskingRuleset - Up

A masking ruleset.
type (optional)
String The Ruleset type.
Enum:
FILE
DATABASE
MAINFRAME_DATASET
name (optional)
String The name of this Ruleset.
refresh_drops_tables (optional)
Boolean Whether refresh drops tables. Only applicable to database ruleset type.
algorithms (optional)
array[String] The list of algorithms for this Ruleset.

MigrateMaskingJobParameters - Up

Parameters to migrate a masking job.
target_engine_id
String The ID of the engine to copy the job to.
source_environment_id (optional)
String The ID or name of the source environment on the target engine. This only applies to On-The-Fly jobs.
target_environment_id (optional)
String The ID or name of the target environment to copy the job into.

MigrateMaskingJobResponse - MigrateMaskingJobResponse Up

job (optional)
Job

ObjectPermissionAccessGroups - Up

The account groups for object permission account.
id (optional)
String ID of the access group.
name (optional)
String Name of the access group.
permissions (optional)
array[String] Permissions for the object in this access group.

ObjectPermissionAccount - Up

The account details for object permission.
id (optional)
Long Numeric ID of the Account. format: int64
first_name (optional)
String First name of the Account.
last_name (optional)
String Last name of the Account.
email (optional)
String Email of the Account.
access_groups (optional)
array[ObjectPermissionAccessGroups] Access groups of the Account.

ObjectPermissionsResponse - Up

The object permissions for a given object in DCT based on object type and object id.
accounts (optional)
array[ObjectPermissionAccount] The Accounts permitted for this object.

ObjectTypeEnum - Up

Type of the DCT object.

ObjectTypeProperty - Up

A DCT object type.
object_type
String Object type.
Enum:
ACCESS_GROUP
ACCOUNT
ROLE
API_USAGE_REPORT
BOOKMARK
CDB
DATABASE_TEMPLATE
DSOURCE
ENGINE
ENVIRONMENT
MASKING_JOB
MASKING_JOB_SET
REPORT_SCHEDULE
SOURCE
VAULT
VCDB
VDB
VDB_GROUP
CONNECTOR
CONNECTIVITY_CHECK
DSOURCE_USAGE_REPORT
DSOURCE_CONSUMPTION_REPORT
JOB
PRODUCT_INFO
ROLE
SMTP_CONFIG
STORAGE_SUMMARY_REPORT
VDB_INVENTORY_REPORT
LDAP
SAML
PASSWORD_POLICY
GLOBAL_PROPERTIES
API_CLASSIFICATION

OracleRacCustomEnvFile - Up

node_id (optional)
String
path_parameters (optional)
String

OracleRacCustomEnvVar - Up

node_id (optional)
String
name (optional)
String
value (optional)
String

OracleVirtualIP - Up

A virtual IP address.
domain_name (optional)
String The domain name for the VirtualIP.
ip (optional)
String The IP address for this VirtualIP. format: ipv4
discovered (optional)
Boolean Whether this VirtualIP was discovered.

PaginatedResponseMetadata - Up

prev_cursor (optional)
String Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
next_cursor (optional)
String Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
total (optional)
Integer The total number of results. This value may not be provided. format: int_64

PasswordPoliciesParams - PasswordPoliciesParameters Up

Parameters to read or update password policies
enabled (optional)
Boolean True if password policies are enforced/enabled.
min_length (optional)
Integer Minimum length for password.
reuse_disallow_limit (optional)
Integer The password can not be the same as any of the previous n passwords.
digit (optional)
Boolean Mandate at least one digit in password.
uppercase_letter (optional)
Boolean Mandate at least one uppercase letter in password.
lowercase_letter (optional)
Boolean Mandate at least one lower letter in password.
special_character (optional)
Boolean Mandate at least one special character in password.
disallow_username_as_password (optional)
Boolean Disallows password containing case-insensitive user name or reversed user name.
maximum_password_attempts (optional)
Integer The number of allowed attempts for incorrect password, after which the account gets locked.

PermissionEnum - Up

Type of the permission on DCT object.

PermissionObject - Up

A Permission Object which is mapping between object type and its permissions.
object_type
String Object type.
Enum:
ACCESS_GROUP
ACCOUNT
ROLE
API_USAGE_REPORT
BOOKMARK
CDB
DATABASE_TEMPLATE
DSOURCE
ENGINE
ENVIRONMENT
MASKING_JOB
MASKING_JOB_SET
REPORT_SCHEDULE
SOURCE
VAULT
VCDB
VDB
VDB_GROUP
CONNECTOR
CONNECTIVITY_CHECK
DSOURCE_USAGE_REPORT
DSOURCE_CONSUMPTION_REPORT
JOB
PRODUCT_INFO
ROLE
SMTP_CONFIG
STORAGE_SUMMARY_REPORT
VDB_INVENTORY_REPORT
LDAP
SAML
PASSWORD_POLICY
GLOBAL_PROPERTIES
API_CLASSIFICATION
permissions
set[String] List of permissions.
Enum:

PermissionProperty - Up

A Permission object.
permissions
set[String] List of permissions.
Enum:

PermissionsRequest - Up

permission_objects
set[PermissionObject] Array of permissions with object type and their permission.

PrimaryEnvironmentUserResponse - PrimaryEnvironmentUserResponse Up

job (optional)
Job

ProductHistory - Up

version (optional)
String Product Version.
installed_on (optional)
Date This version installed on date. format: date-time

ProductInfo - ProductInfoResponse Up

Product Information Response
api_version (optional)
String Current API version.
product_version (optional)
String Current installed product version.
product_upgrade_history (optional)
array[ProductHistory] Product upgrade history.
supported_api_versions (optional)
array[String] All the supported API versions.

ProvisionVDBBySnapshotParameters - Up

pre_refresh (optional)
array[Hook] The commands to execute on the target environment before refreshing the VDB.
post_refresh (optional)
array[Hook] The commands to execute on the target environment after refreshing the VDB.
pre_rollback (optional)
array[Hook] The commands to execute on the target environment before rewinding the VDB.
post_rollback (optional)
array[Hook] The commands to execute on the target environment after rewinding the VDB.
configure_clone (optional)
array[Hook] The commands to execute on the target environment when the VDB is created or refreshed.
pre_snapshot (optional)
array[Hook] The commands to execute on the target environment before snapshotting a virtual source. These commands can quiesce any data prior to snapshotting.
post_snapshot (optional)
array[Hook] The commands to execute on the target environment after snapshotting a virtual source.
pre_start (optional)
array[Hook] The commands to execute on the target environment before starting a virtual source.
post_start (optional)
array[Hook] The commands to execute on the target environment after starting a virtual source.
pre_stop (optional)
array[Hook] The commands to execute on the target environment before stopping a virtual source.
post_stop (optional)
array[Hook] The commands to execute on the target environment after stopping a virtual source.
target_group_id (optional)
String The ID of the group into which the VDB will be provisioned. If unset, a group is selected randomly on the Engine.
name (optional)
String The unique name of the provisioned VDB within a group. If unset, a name is randomly generated.
database_name (optional)
String The name of the database on the target environment. Defaults to the value of the name property.
cdb_id (optional)
String The ID of the container database (CDB) to provision an Oracle Multitenant database into. This corresponds to a CDB or VCDB API object. When this is not set, a new vCDB will be provisioned.
cluster_node_ids (optional)
array[String] The cluster node ids, name or addresses for this provision operation (Oracle RAC Only).
truncate_log_on_checkpoint (optional)
Boolean Whether to truncate log on checkpoint (ASE only).
os_username (optional)
String The name of the privileged user to run the provision operation (Oracle Only).
os_password (optional)
String The password of the privileged user to run the provision operation (Oracle Only).
environment_id (optional)
String The ID of the target environment where to provision the VDB. If repository_id unambigously identifies a repository, this is unnecessary and ignored. Otherwise, a compatible repository is randomly selected on the environment.
environment_user_id (optional)
String The environment user ID to use to connect to the target environment.
repository_id (optional)
String The ID of the target repository where to provision the VDB. A repository typically corresponds to a database installation (Oracle home, database instance, ...). Setting this attribute implicitly determines the environment where to provision the VDB.
auto_select_repository (optional)
Boolean Option to automatically select a compatible environment and repository. Mutually exclusive with repository_id.
vdb_restart (optional)
Boolean Indicates whether the Engine should automatically restart this virtual source when target host reboot is detected.
template_id (optional)
String The ID of the target VDB Template (Oracle Only).
auxiliary_template_id (optional)
String The ID of the configuration template to apply to the auxiliary container database. This is only relevant when provisioning a Multitenant pluggable database into an existing CDB, i.e when the cdb_id property is set.(Oracle Only)
file_mapping_rules (optional)
String Target VDB file mapping rules (Oracle Only). Rules must be line separated (\n or \r) and each line must have the format "pattern:replacement". Lines are applied in order.
oracle_instance_name (optional)
String Target VDB SID name (Oracle Only).
unique_name (optional)
String Target VDB db_unique_name (Oracle Only).
vcdb_name (optional)
String When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the name of the provisioned vCDB (Oracle Multitenant Only).
vcdb_database_name (optional)
String When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the database name of the provisioned vCDB. Defaults to the value of the vcdb_name property. (Oracle Multitenant Only).
mount_point (optional)
String Mount point for the VDB (Oracle, ASE, AppData).
open_reset_logs (optional)
Boolean Whether to open the database after provision (Oracle Only).
snapshot_policy_id (optional)
String The ID of the snapshot policy for the VDB.
retention_policy_id (optional)
String The ID of the retention policy for the VDB.
recovery_model (optional)
String Recovery model of the source database (MSSql Only).
Enum:
FULL
SIMPLE
BULK_LOGGED
pre_script (optional)
String PowerShell script or executable to run prior to provisioning (MSSql Only).
post_script (optional)
String PowerShell script or executable to run after provisioning (MSSql Only).
cdc_on_provision (optional)
Boolean Option to enable change data capture (CDC) on both the provisioned VDB and subsequent snapshot-related operations (e.g. refresh, rewind) (MSSql Only).
online_log_size (optional)
Integer Online log size in MB (Oracle Only).
online_log_groups (optional)
Integer Number of online log groups (Oracle Only).
archive_log (optional)
Boolean Option to create a VDB in archivelog mode (Oracle Only).
new_dbid (optional)
Boolean Option to generate a new DB ID for the created VDB (Oracle Only).
listener_ids (optional)
array[String] The listener IDs for this provision operation (Oracle Only).
custom_env_vars (optional)
map[String, String] Environment variable to be set when the engine creates a VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.
custom_env_files (optional)
array[String] Environment files to be sourced when the Engine creates a VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.
oracle_rac_custom_env_files (optional)
array[OracleRacCustomEnvFile] Environment files to be sourced when the Engine creates an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.
oracle_rac_custom_env_vars (optional)
array[OracleRacCustomEnvVar] Environment variable to be set when the engine creates an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.
parentTdeKeystorePath (optional)
String Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)
parent_tde_keystore_password (optional)
String The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)
tde_exported_key_file_secret (optional)
String Secret to be used while exporting and importing vPDB encryption keys if Transparent Data Encryption is enabled on the vPDB. (Oracle Multitenant Only)
tde_key_identifier (optional)
String ID of the key created by Delphix. (Oracle Multitenant Only)
target_vcdb_tde_keystore_path (optional)
String Path to the keystore of the target vCDB. (Oracle Multitenant Only)
cdb_tde_keystore_password (optional)
String The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)
vcdb_tde_key_identifier (optional)
String ID of the key created by Delphix. (Oracle Multitenant Only)
appdata_source_params (optional)
map[String, Object] The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.
additional_mount_points (optional)
array[AdditionalMountPoint] Specifies additional locations on which to mount a subdirectory of an AppData container.
appdata_config_params (optional)
map[String, Object] The list of parameters specified by the source config schema in the toolkit
config_params (optional)
map[String, Object] Database configuration parameter overrides.
tags (optional)
array[Tag] The tags to be created for VDB.
snapshot_id (optional)
String The ID of the snapshot from which to execute the operation. If the snapshot_id is not, selects the latest snapshot.
engine_id (optional)
String The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored.
source_data_id (optional)
String The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source. If this property is not set, the data_source of the snapshot_id will be used.
make_current_account_owner (optional)
Boolean Whether the account provisioning this VDB must be configured as owner of the VDB.

ProvisionVDBBySnapshotParameters_allOf - Up

engine_id (optional)
String The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored.
source_data_id (optional)
String The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source. If this property is not set, the data_source of the snapshot_id will be used.
make_current_account_owner (optional)
Boolean Whether the account provisioning this VDB must be configured as owner of the VDB.

ProvisionVDBByTimestampParameters - Up

pre_refresh (optional)
array[Hook] The commands to execute on the target environment before refreshing the VDB.
post_refresh (optional)
array[Hook] The commands to execute on the target environment after refreshing the VDB.
pre_rollback (optional)
array[Hook] The commands to execute on the target environment before rewinding the VDB.
post_rollback (optional)
array[Hook] The commands to execute on the target environment after rewinding the VDB.
configure_clone (optional)
array[Hook] The commands to execute on the target environment when the VDB is created or refreshed.
pre_snapshot (optional)
array[Hook] The commands to execute on the target environment before snapshotting a virtual source. These commands can quiesce any data prior to snapshotting.
post_snapshot (optional)
array[Hook] The commands to execute on the target environment after snapshotting a virtual source.
pre_start (optional)
array[Hook] The commands to execute on the target environment before starting a virtual source.
post_start (optional)
array[Hook] The commands to execute on the target environment after starting a virtual source.
pre_stop (optional)
array[Hook] The commands to execute on the target environment before stopping a virtual source.
post_stop (optional)
array[Hook] The commands to execute on the target environment after stopping a virtual source.
target_group_id (optional)
String The ID of the group into which the VDB will be provisioned. If unset, a group is selected randomly on the Engine.
name (optional)
String The unique name of the provisioned VDB within a group. If unset, a name is randomly generated.
database_name (optional)
String The name of the database on the target environment. Defaults to the value of the name property.
cdb_id (optional)
String The ID of the container database (CDB) to provision an Oracle Multitenant database into. This corresponds to a CDB or VCDB API object. When this is not set, a new vCDB will be provisioned.
cluster_node_ids (optional)
array[String] The cluster node ids, name or addresses for this provision operation (Oracle RAC Only).
truncate_log_on_checkpoint (optional)
Boolean Whether to truncate log on checkpoint (ASE only).
os_username (optional)
String The name of the privileged user to run the provision operation (Oracle Only).
os_password (optional)
String The password of the privileged user to run the provision operation (Oracle Only).
environment_id (optional)
String The ID of the target environment where to provision the VDB. If repository_id unambigously identifies a repository, this is unnecessary and ignored. Otherwise, a compatible repository is randomly selected on the environment.
environment_user_id (optional)
String The environment user ID to use to connect to the target environment.
repository_id (optional)
String The ID of the target repository where to provision the VDB. A repository typically corresponds to a database installation (Oracle home, database instance, ...). Setting this attribute implicitly determines the environment where to provision the VDB.
auto_select_repository (optional)
Boolean Option to automatically select a compatible environment and repository. Mutually exclusive with repository_id.
vdb_restart (optional)
Boolean Indicates whether the Engine should automatically restart this virtual source when target host reboot is detected.
template_id (optional)
String The ID of the target VDB Template (Oracle Only).
auxiliary_template_id (optional)
String The ID of the configuration template to apply to the auxiliary container database. This is only relevant when provisioning a Multitenant pluggable database into an existing CDB, i.e when the cdb_id property is set.(Oracle Only)
file_mapping_rules (optional)
String Target VDB file mapping rules (Oracle Only). Rules must be line separated (\n or \r) and each line must have the format "pattern:replacement". Lines are applied in order.
oracle_instance_name (optional)
String Target VDB SID name (Oracle Only).
unique_name (optional)
String Target VDB db_unique_name (Oracle Only).
vcdb_name (optional)
String When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the name of the provisioned vCDB (Oracle Multitenant Only).
vcdb_database_name (optional)
String When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the database name of the provisioned vCDB. Defaults to the value of the vcdb_name property. (Oracle Multitenant Only).
mount_point (optional)
String Mount point for the VDB (Oracle, ASE, AppData).
open_reset_logs (optional)
Boolean Whether to open the database after provision (Oracle Only).
snapshot_policy_id (optional)
String The ID of the snapshot policy for the VDB.
retention_policy_id (optional)
String The ID of the retention policy for the VDB.
recovery_model (optional)
String Recovery model of the source database (MSSql Only).
Enum:
FULL
SIMPLE
BULK_LOGGED
pre_script (optional)
String PowerShell script or executable to run prior to provisioning (MSSql Only).
post_script (optional)
String PowerShell script or executable to run after provisioning (MSSql Only).
cdc_on_provision (optional)
Boolean Option to enable change data capture (CDC) on both the provisioned VDB and subsequent snapshot-related operations (e.g. refresh, rewind) (MSSql Only).
online_log_size (optional)
Integer Online log size in MB (Oracle Only).
online_log_groups (optional)
Integer Number of online log groups (Oracle Only).
archive_log (optional)
Boolean Option to create a VDB in archivelog mode (Oracle Only).
new_dbid (optional)
Boolean Option to generate a new DB ID for the created VDB (Oracle Only).
listener_ids (optional)
array[String] The listener IDs for this provision operation (Oracle Only).
custom_env_vars (optional)
map[String, String] Environment variable to be set when the engine creates a VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.
custom_env_files (optional)
array[String] Environment files to be sourced when the Engine creates a VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.
oracle_rac_custom_env_files (optional)
array[OracleRacCustomEnvFile] Environment files to be sourced when the Engine creates an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.
oracle_rac_custom_env_vars (optional)
array[OracleRacCustomEnvVar] Environment variable to be set when the engine creates an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.
parentTdeKeystorePath (optional)
String Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)
parent_tde_keystore_password (optional)
String The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)
tde_exported_key_file_secret (optional)
String Secret to be used while exporting and importing vPDB encryption keys if Transparent Data Encryption is enabled on the vPDB. (Oracle Multitenant Only)
tde_key_identifier (optional)
String ID of the key created by Delphix. (Oracle Multitenant Only)
target_vcdb_tde_keystore_path (optional)
String Path to the keystore of the target vCDB. (Oracle Multitenant Only)
cdb_tde_keystore_password (optional)
String The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)
vcdb_tde_key_identifier (optional)
String ID of the key created by Delphix. (Oracle Multitenant Only)
appdata_source_params (optional)
map[String, Object] The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.
additional_mount_points (optional)
array[AdditionalMountPoint] Specifies additional locations on which to mount a subdirectory of an AppData container.
appdata_config_params (optional)
map[String, Object] The list of parameters specified by the source config schema in the toolkit
config_params (optional)
map[String, Object] Database configuration parameter overrides.
tags (optional)
array[Tag] The tags to be created for VDB.
timestamp (optional)
Date The point in time from which to execute the operation. Mutually exclusive with timestamp_in_database_timezone. If the timestamp is not set, selects the latest point. format: date-time
timestamp_in_database_timezone (optional)
String The point in time from which to execute the operation, expressed as a date-time in the timezone of the source database. Mutually exclusive with timestamp.
engine_id (optional)
String The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored.
source_data_id
String The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source.
make_current_account_owner (optional)
Boolean Whether the account provisioning this VDB must be configured as owner of the VDB.

ProvisionVDBByTimestampParameters_allOf - Up

engine_id (optional)
String The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored.
source_data_id
String The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source.
make_current_account_owner (optional)
Boolean Whether the account provisioning this VDB must be configured as owner of the VDB.

ProvisionVDBFromBookmarkParameters - Up

pre_refresh (optional)
array[Hook] The commands to execute on the target environment before refreshing the VDB.
post_refresh (optional)
array[Hook] The commands to execute on the target environment after refreshing the VDB.
pre_rollback (optional)
array[Hook] The commands to execute on the target environment before rewinding the VDB.
post_rollback (optional)
array[Hook] The commands to execute on the target environment after rewinding the VDB.
configure_clone (optional)
array[Hook] The commands to execute on the target environment when the VDB is created or refreshed.
pre_snapshot (optional)
array[Hook] The commands to execute on the target environment before snapshotting a virtual source. These commands can quiesce any data prior to snapshotting.
post_snapshot (optional)
array[Hook] The commands to execute on the target environment after snapshotting a virtual source.
pre_start (optional)
array[Hook] The commands to execute on the target environment before starting a virtual source.
post_start (optional)
array[Hook] The commands to execute on the target environment after starting a virtual source.
pre_stop (optional)
array[Hook] The commands to execute on the target environment before stopping a virtual source.
post_stop (optional)
array[Hook] The commands to execute on the target environment after stopping a virtual source.
target_group_id (optional)
String The ID of the group into which the VDB will be provisioned. If unset, a group is selected randomly on the Engine.
name (optional)
String The unique name of the provisioned VDB within a group. If unset, a name is randomly generated.
database_name (optional)
String The name of the database on the target environment. Defaults to the value of the name property.
cdb_id (optional)
String The ID of the container database (CDB) to provision an Oracle Multitenant database into. This corresponds to a CDB or VCDB API object. When this is not set, a new vCDB will be provisioned.
cluster_node_ids (optional)
array[String] The cluster node ids, name or addresses for this provision operation (Oracle RAC Only).
truncate_log_on_checkpoint (optional)
Boolean Whether to truncate log on checkpoint (ASE only).
os_username (optional)
String The name of the privileged user to run the provision operation (Oracle Only).
os_password (optional)
String The password of the privileged user to run the provision operation (Oracle Only).
environment_id (optional)
String The ID of the target environment where to provision the VDB. If repository_id unambigously identifies a repository, this is unnecessary and ignored. Otherwise, a compatible repository is randomly selected on the environment.
environment_user_id (optional)
String The environment user ID to use to connect to the target environment.
repository_id (optional)
String The ID of the target repository where to provision the VDB. A repository typically corresponds to a database installation (Oracle home, database instance, ...). Setting this attribute implicitly determines the environment where to provision the VDB.
auto_select_repository (optional)
Boolean Option to automatically select a compatible environment and repository. Mutually exclusive with repository_id.
vdb_restart (optional)
Boolean Indicates whether the Engine should automatically restart this virtual source when target host reboot is detected.
template_id (optional)
String The ID of the target VDB Template (Oracle Only).
auxiliary_template_id (optional)
String The ID of the configuration template to apply to the auxiliary container database. This is only relevant when provisioning a Multitenant pluggable database into an existing CDB, i.e when the cdb_id property is set.(Oracle Only)
file_mapping_rules (optional)
String Target VDB file mapping rules (Oracle Only). Rules must be line separated (\n or \r) and each line must have the format "pattern:replacement". Lines are applied in order.
oracle_instance_name (optional)
String Target VDB SID name (Oracle Only).
unique_name (optional)
String Target VDB db_unique_name (Oracle Only).
vcdb_name (optional)
String When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the name of the provisioned vCDB (Oracle Multitenant Only).
vcdb_database_name (optional)
String When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the database name of the provisioned vCDB. Defaults to the value of the vcdb_name property. (Oracle Multitenant Only).
mount_point (optional)
String Mount point for the VDB (Oracle, ASE, AppData).
open_reset_logs (optional)
Boolean Whether to open the database after provision (Oracle Only).
snapshot_policy_id (optional)
String The ID of the snapshot policy for the VDB.
retention_policy_id (optional)
String The ID of the retention policy for the VDB.
recovery_model (optional)
String Recovery model of the source database (MSSql Only).
Enum:
FULL
SIMPLE
BULK_LOGGED
pre_script (optional)
String PowerShell script or executable to run prior to provisioning (MSSql Only).
post_script (optional)
String PowerShell script or executable to run after provisioning (MSSql Only).
cdc_on_provision (optional)
Boolean Option to enable change data capture (CDC) on both the provisioned VDB and subsequent snapshot-related operations (e.g. refresh, rewind) (MSSql Only).
online_log_size (optional)
Integer Online log size in MB (Oracle Only).
online_log_groups (optional)
Integer Number of online log groups (Oracle Only).
archive_log (optional)
Boolean Option to create a VDB in archivelog mode (Oracle Only).
new_dbid (optional)
Boolean Option to generate a new DB ID for the created VDB (Oracle Only).
listener_ids (optional)
array[String] The listener IDs for this provision operation (Oracle Only).
custom_env_vars (optional)
map[String, String] Environment variable to be set when the engine creates a VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.
custom_env_files (optional)
array[String] Environment files to be sourced when the Engine creates a VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.
oracle_rac_custom_env_files (optional)
array[OracleRacCustomEnvFile] Environment files to be sourced when the Engine creates an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.
oracle_rac_custom_env_vars (optional)
array[OracleRacCustomEnvVar] Environment variable to be set when the engine creates an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.
parentTdeKeystorePath (optional)
String Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)
parent_tde_keystore_password (optional)
String The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)
tde_exported_key_file_secret (optional)
String Secret to be used while exporting and importing vPDB encryption keys if Transparent Data Encryption is enabled on the vPDB. (Oracle Multitenant Only)
tde_key_identifier (optional)
String ID of the key created by Delphix. (Oracle Multitenant Only)
target_vcdb_tde_keystore_path (optional)
String Path to the keystore of the target vCDB. (Oracle Multitenant Only)
cdb_tde_keystore_password (optional)
String The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)
vcdb_tde_key_identifier (optional)
String ID of the key created by Delphix. (Oracle Multitenant Only)
appdata_source_params (optional)
map[String, Object] The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.
additional_mount_points (optional)
array[AdditionalMountPoint] Specifies additional locations on which to mount a subdirectory of an AppData container.
appdata_config_params (optional)
map[String, Object] The list of parameters specified by the source config schema in the toolkit
config_params (optional)
map[String, Object] Database configuration parameter overrides.
tags (optional)
array[Tag] The tags to be created for VDB.
bookmark_id
String The ID of the bookmark from which to execute the operation. The bookmark must contain only one VDB.
make_current_account_owner (optional)
Boolean Whether the account provisioning this VDB must be configured as owner of the VDB.

ProvisionVDBFromBookmarkParameters_allOf - Up

make_current_account_owner (optional)
Boolean Whether the account provisioning this VDB must be configured as owner of the VDB.

ProvisionVDBGroupFromBookmarkParameters - Up

name
String Name of the created VDB group name.
bookmark_id
String ID of a bookmark to provision this VDB Group from.
provision_parameters
map[String, BaseProvisionVDBParameters] Provision parameters for each of the VDBs which will need to be provisioned. The key must be the vdb_id of the corresponding entry from the bookmark, and the value the provision parameters for the VDB which will be cloned from the bookmark.
tags (optional)
array[Tag] The tags to be created for VDB Group.
make_current_account_owner (optional)
Boolean Whether the account provisioning this VDB group must be configured as owner of the VDB group.

ProvisionVDBGroupFromBookmarkResponse - ProvisionVDBGroupFromBookmarkResponse Up

vdb_group (optional)
VDBGroup
job (optional)
Job

ProvisionVDBResponse - Up

job (optional)
Job
vdb_id (optional)
String The ID of the provisioned vdb.

RefreshEnvironmentResponse - RefreshEnvironmentResponse Up

job (optional)
Job

RefreshVDBBySnapshotParameters - Up

snapshot_id (optional)
String The ID of the snapshot from which to execute the operation. If the snapshot_id is not, selects the latest snapshot.

RefreshVDBBySnapshotResponse - RefreshVDBBySnapshotResponse Up

job (optional)
Job

RefreshVDBByTimestampParameters - Up

timestamp (optional)
Date The point in time from which to execute the operation. Mutually exclusive with timestamp_in_database_timezone. If the timestamp is not set, selects the latest point. format: date-time
timestamp_in_database_timezone (optional)
String The point in time from which to execute the operation, expressed as a date-time in the timezone of the source database. Mutually exclusive with timestamp.
dataset_id (optional)
String ID of the dataset to refresh to

RefreshVDBByTimestampParameters_allOf - Up

dataset_id (optional)
String ID of the dataset to refresh to

RefreshVDBByTimestampResponse - RefreshVDBByTimestampResponse Up

job (optional)
Job

RefreshVDBFromBookmarkParameters - Up

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

RefreshVDBFromBookmarkResponse - RefreshVDBFromBookmarkResponse Up

job (optional)
Job

RefreshVDBGroupParameters - Up

Parameters to refresh a VDB Group.
bookmark_id
String ID of a bookmark to refresh this VDB Group to.

RefreshVDBGroupResponse - RefreshVDBGroupResponse Up

job (optional)
Job

RegisteredEngine - RegisteredEngine Up

A registered engine's connection and authentication settings.
id (optional)
String The Engine object entity ID.
uuid (optional)
String The unique identifier generated by this engine.
type (optional)
String The type of this engine.
Enum:
VIRTUALIZATION
MASKING
BOTH
UNSET
version (optional)
String The engine version.
name
String The name of this engine.
hostname
String The hostname of this engine.
cpu_core_count (optional)
Integer The total number of CPU cores on this engine. format: int32
memory_size (optional)
Long The total amount of memory on this engine, in bytes. format: int64
data_storage_capacity (optional)
Long The total amount of storage allocated for engine objects and system metadata, in bytes. format: int64
data_storage_used (optional)
Long The amount of storage used by engine objects and system metadata, in bytes. format: int64
insecure_ssl (optional)
Boolean Allow connections to the engine over HTTPs without validating the TLS certificate. Even though the connection to the engine might be performed over HTTPs, setting this property eliminates the protection against a man-in-the-middle attach for connections to this engine. Instead, consider creating a truststore with a Certificate Authority to validate the engine's certificate, and set the truststore_path propery.
unsafe_ssl_hostname_check (optional)
Boolean Ignore validation of the name associated to the TLS certificate when connecting to the engine over HTTPs. Setting this value must only be done if the TLS certificate of the engine does not match the hostname, and the TLS configuration of the engine cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this engine. This is ignored if insecure_ssl is set.
truststore_filename (optional)
String File name of a truststore which can be used to validate the TLS certificate of the engine. The truststore must be available at /etc/config/certs/<truststore_filename>
truststore_password (optional)
String Password to read the truststore.
status (optional)
String the status of the engine
Enum:
CREATED
DELETING
connection_status (optional)
String The status of the connection to the engine.
Enum:
ONLINE
OFFLINE
connection_status_details (optional)
String If set, details about the status of the connection to the engine.
username (optional)
String The virtualization domain admin username.
password (optional)
String The virtualization domain admin password.
masking_username (optional)
String The masking admin username.
masking_password (optional)
String The masking admin password.
hashicorp_vault_username_command_args (optional)
array[String] Arguments to pass to the Vault CLI tool to retrieve the virtualization username for the engine.
hashicorp_vault_masking_username_command_args (optional)
array[String] Arguments to pass to the Vault CLI tool to retrieve the masking username for the engine.
hashicorp_vault_password_command_args (optional)
array[String] Arguments to pass to the Vault CLI tool to retrieve the virtualization password for the engine.
hashicorp_vault_masking_password_command_args (optional)
array[String] Arguments to pass to the Vault CLI tool to retrieve the masking password for the engine.
masking_hashicorp_vault_id (optional)
Long Reference to the Hashicorp vault to use to retrieve masking engine credentials. format: int64
hashicorp_vault_id (optional)
Long Reference to the Hashicorp vault to use to retrieve virtualization engine credentials. format: int64
tags (optional)
array[Tag] The tags to be created for this engine.
masking_memory_used (optional)
Long The current amount of memory used by running masking jobs in bytes. format: int64
masking_allocated_memory (optional)
Long The maximum amount of memory available for running masking jobs in bytes. format: int64
masking_jobs_running (optional)
Integer The number of masking jobs currently running.
masking_max_concurrent_jobs (optional)
Integer The maximum number of masking jobs that can be running at the same time.
masking_available_cores (optional)
Integer The number of CPU cores available to the masking engine.

RemoveMaskingJobParameters - Up

Parameters to remove a masking job from a masking job set.
engine_id
String The ID of the engine to remove the masking job from.

ReportingSchedule - Up

report_id (optional)
Integer
report_type
String
Enum:
VIRTUALIZATION_STORAGE_SUMMARY
VDB_INVENTORY_DATA
DSOURCE_USAGE_DATA
DSOURCE_CONSUMPTION_DATA
cron_expression
String Standard cron expressions are supported e.g. 0 15 10 L * ? - Schedule at 10:15 AM on the last day of every month, 0 0 2 ? * Mon-Fri - Schedule at 2:00 AM every Monday, Tuesday, Wednesday, Thursday and Friday. For more details kindly refer- "http://www.quartz-scheduler.org/documentation/"
time_zone (optional)
String Timezones are specified according to the Olson tzinfo database - "https://en.wikipedia.org/wiki/List_of_tz_database_time_zones".
message (optional)
String
file_format
String
Enum:
CSV
enabled
Boolean
recipients
set[String] format: email
sort_column (optional)
String
Enum:
engine_id
engine_name
engine_hostname
total_capacity
free_storage
used_storage
used_percentage
dsource_count
vdb_count
total_object_count
name
unvirtualized_space
actual_space
dependant_vdbs
type
version
parent_id
parent_name
creation_date
parent_timeflow_location
parent_timeflow_timestamp
parent_timeflow_timezone
enabled
status
-engine_id
-engine_name
-engine_hostname
-total_capacity
-free_storage
-used_storage
-used_percentage
-dsource_count
-vdb_count
-total_object_count
-unvirtualized_space
-actual_space
-dependant_vdbs
-name
-type
-version
-parent_id
-parent_name
-creation_date
-parent_timeflow_location
-parent_timeflow_timestamp
-parent_timeflow_timezone
-enabled
-status
row_count (optional)
Integer

ReportingScheduleCreateParameters - Up

report_type
String
Enum:
VIRTUALIZATION_STORAGE_SUMMARY
VDB_INVENTORY_DATA
DSOURCE_USAGE_DATA
DSOURCE_CONSUMPTION_DATA
cron_expression
String Standard cron expressions are supported e.g. 0 15 10 L * ? - Schedule at 10:15 AM on the last day of every month, 0 0 2 ? * Mon-Fri - Schedule at 2:00 AM every Monday, Tuesday, Wednesday, Thursday and Friday. For more details kindly refer- "http://www.quartz-scheduler.org/documentation/"
time_zone (optional)
String Timezones are specified according to the Olson tzinfo database - "https://en.wikipedia.org/wiki/List_of_tz_database_time_zones".
message (optional)
String
file_format
String
Enum:
CSV
enabled
Boolean
recipients
set[String] format: email
sort_column (optional)
String
Enum:
engine_id
engine_name
engine_hostname
total_capacity
free_storage
used_storage
used_percentage
dsource_count
vdb_count
total_object_count
name
unvirtualized_space
actual_space
dependant_vdbs
type
version
parent_id
parent_name
creation_date
parent_timeflow_location
parent_timeflow_timestamp
parent_timeflow_timezone
enabled
status
-engine_id
-engine_name
-engine_hostname
-total_capacity
-free_storage
-used_storage
-used_percentage
-dsource_count
-vdb_count
-total_object_count
-unvirtualized_space
-actual_space
-dependant_vdbs
-name
-type
-version
-parent_id
-parent_name
-creation_date
-parent_timeflow_location
-parent_timeflow_timestamp
-parent_timeflow_timezone
-enabled
-status
row_count (optional)
Integer
make_current_account_owner (optional)
Boolean Whether the account creating this reporting schedule must be configured as owner of the reporting schedule.

Repository - Up

id (optional)
String Entity id of the repository.
name (optional)
String Name of the repository.
database_type (optional)
String The database type of this repository.
allow_provisioning (optional)
Boolean Flag indicating whether the repository should be used for provisioning.
is_staging (optional)
Boolean Flag indicating whether this repository can be used by the Delphix Engine for internal processing.
oracle_base (optional)
String The Oracle base where database binaries are located.
version (optional)
String Version of the repository.
bits (optional)
Integer 32 or 64 bits.
install_group (optional)
String Group name of the user that owns the install.
install_user (optional)
String User name of the user that owns the install.
rac (optional)
Boolean Flag indicating whether the install supports Oracle RAC.
ports (optional)
array[Long] The network ports for connecting to the database instance. format: int64
dump_history_file (optional)
String Fully qualified name of the dump history file.
page_size (optional)
Long Database page size for the SAP ASE instance. format: int64
owner (optional)
String Account the database server instance is running as.
installation_path (optional)
String Directory path where the installation is located.
fulltext_installed (optional)
Boolean This property determines if the full-text search and semantic search is installed or not.
internal_version (optional)
Long The internal version is tied to the data format of a database and is used to detect compatibility. format: int64

ResetPasswordParameter - Up

new_password (optional)
String New password that needs to be set for the Account. Set this to null for unsetting the current password. Not including this property also results in unsetting of the current password.

Role - Up

A role is a named collection of permissions on DCT objects.
name
String The Role name.
description (optional)
String Role description.
permission_objects
set[PermissionObject] The list of permissions granted by this role.
id (optional)
String The Role ID.
system_role (optional)
Boolean System role are pre defined roles. System roles cannot be modified.

RoleUpdateParameters - Up

name (optional)
String The role name
description (optional)
String The role description

Role_allOf - Up

id (optional)
String The Role ID.
system_role (optional)
Boolean System role are pre defined roles. System roles cannot be modified.

RollbackVDBBySnapshotParameters - Up

snapshot_id (optional)
String The ID of the snapshot from which to execute the operation. If the snapshot_id is not, selects the latest snapshot.

RollbackVDBBySnapshotResponse - RollbackVDBBySnapshotResponse Up

job (optional)
Job

RollbackVDBByTimestampParameters - Up

timestamp (optional)
Date The point in time from which to execute the operation. Mutually exclusive with timestamp_in_database_timezone. If the timestamp is not set, selects the latest point. format: date-time
timestamp_in_database_timezone (optional)
String The point in time from which to execute the operation, expressed as a date-time in the timezone of the source database. Mutually exclusive with timestamp.

RollbackVDBByTimestampResponse - RollbackVDBByTimestampResponse Up

job (optional)
Job

RollbackVDBFromBookmarkParameters - Up

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

RollbackVDBFromBookmarkResponse - RollbackVDBFromBookmarkResponse Up

job (optional)
Job

RollbackVDBGroupParameters - Up

Parameters to rollback a VDB Group.
bookmark_id
String ID of a bookmark to rollback this VDB Group to.

RollbackVDBGroupResponse - RollbackVDBGroupResponse Up

job (optional)
Job

SAMLConfigParams - SAMLConfigParams Up

Parameters to read or update SAML Config
enabled (optional)
Boolean When set, SAML settings are enabled. False by default.
auto_create_users (optional)
Boolean When set, the system will automatically create new Accounts for those who have logged in using SAML. This must be true if SAML user is not already registered in system. True by default.
metadata (optional)
String IdP metadata for this service provider. This is a required property for successful SAML authentication.
entity_id (optional)
String Unique identifier of this instance as a SAML/SSO service provider.
response_skew (optional)
Integer Maximum time difference allowed between a SAML response and the DCT's current time, in seconds. If not set, it defaults to 120 seconds.
group_attr (optional)
String Group mapped attribute on SAML to create account tags in DCT.
first_name_attr (optional)
String First name attribute mapped on SAML used for mapping on DCT account.
last_name_attr (optional)
String Last name attribute mapped on SAML used for mapping on DCT account.

SMTPConfigParams - SMTPConfigParameters Up

Parameters to read or update SMTP Config
enabled (optional)
Boolean True if outbound email is enabled.
server (optional)
String IP address or hostname of SMTP relay server.
port (optional)
Integer Port number to use. A value of -1 indicates the default (25 or 587 for TLS).
authentication_enabled (optional)
Boolean True if username/password authentication should be used.
tls_enabled (optional)
Boolean True if TLS (transport layer security) should be used.
username (optional)
String If authentication is enabled, username to use when authenticating to the server.
password (optional)
String If authentication is enabled, password to use when authenticating to the server.
from_address (optional)
String From address to use when sending mail. If unspecified, 'noreply@delphix.com' is used. format: email
send_timeout (optional)
Integer Maximum timeout to wait, in seconds, when sending mail.

SMTPConfigValidate - SMTPValidationParams Up

Parameters to validate SMTP Config
to_address
String

SSHVerificationStrategy - Up

Mechanism to use for ssh host verification.
name
String The name of the verification strategy.
Enum:
RAW_KEY
FINGERPRINT
ACCEPT_ALWAYS
key_type (optional)
String The type of SSH key.
Enum:
RSA
DSA
ECDSA
ED25519
raw_key (optional)
String Base64-encoded ssh key of the host for RAW_KEY verification.
fingerprint_type (optional)
String Hash function for the fingerprint for FINGERPRINT verification.
Enum:
SHA256
SHA512
fingerprint (optional)
String Base-64 encoded fingerprint of the ssh key of the host for FINGERPRINT verification.

ScopeTag - Up

key
String Key of the tag
value
String Value of the tag
object_type (optional)
ObjectTypeEnum
permission (optional)
PermissionEnum

ScopeTagsRequest - Up

tags
set[ScopeTag] Array of tags with key value pairs along with optional object_type and permissions

ScopeTagsResponse - Up

tags (optional)
array[ScopeTag] Array of tags with key value pairs along with optional object_type and permissions

ScopedObjectItem - Up

object_id
String ID of the object
object_type
ObjectTypeEnum
permission (optional)
PermissionEnum

ScopedObjectItemsResponse - Up

objects (optional)
array[ScopedObjectItem] Array of access group scope objects with object id and object type

ScopedObjectsRequest - Up

objects
set[ScopedObjectItem] An array of scoped objects

SearchAccessGroupsResponse - SearchAccessGroupsResponse Up

items (optional)
array[AccessGroup]
response_metadata (optional)
PaginatedResponseMetadata

SearchAccountsResponse - SearchAccountsResponse Up

items (optional)
array[Account]
response_metadata (optional)
PaginatedResponseMetadata

SearchBody - Up

Search body.
filter_expression (optional)
String

SearchBookmarksResponse - SearchBookmarksResponse Up

items (optional)
array[Bookmark]
response_metadata (optional)
PaginatedResponseMetadata

SearchCDBsResponse - SearchCDBsResponse Up

items (optional)
array[CDB]
response_metadata (optional)
PaginatedResponseMetadata

SearchConnectorsResponse - SearchConnectorsResponse Up

items (optional)
array[Connector]
response_metadata (optional)
PaginatedResponseMetadata

SearchDSourcesResponse - SearchDSourcesResponse Up

items (optional)
array[DSource]
response_metadata (optional)
PaginatedResponseMetadata

SearchDatabaseTemplatesResponse - SearchDatabaseTemplatesResponse Up

items (optional)
array[DatabaseTemplate]
response_metadata (optional)
PaginatedResponseMetadata

SearchEnginesResponse - SearchEnginesResponse Up

items (optional)
array[RegisteredEngine]
response_metadata (optional)
PaginatedResponseMetadata

SearchEnvironmentsResponse - SearchEnvironmentsResponse Up

items (optional)
array[Environment]
response_metadata (optional)
PaginatedResponseMetadata

SearchExecutionsResponse - SearchExecutionsResponse Up

items (optional)
array[Execution]
response_metadata (optional)
PaginatedResponseMetadata

SearchJobsResponse - SearchJobsResponse Up

items (optional)
array[Job]
response_metadata (optional)
PaginatedResponseMetadata

SearchMaskingJobSourceEnginesResponse - SearchMaskingJobSourceEnginesResponse Up

items (optional)
array[MaskingJobSourceEngine]
response_metadata (optional)
PaginatedResponseMetadata

SearchMaskingJobsResponse - SearchMaskingJobsResponse Up

items (optional)
array[MaskingJob]
response_metadata (optional)
PaginatedResponseMetadata

SearchRolesResponse - SearchRolesResponse Up

items (optional)
array[Role]
response_metadata (optional)
PaginatedResponseMetadata

SearchSourcesResponse - SearchSourcesResponse Up

items (optional)
array[Source]
response_metadata (optional)
PaginatedResponseMetadata

SearchVCDBsResponse - SearchVCDBsResponse Up

items (optional)
array[VCDB]
response_metadata (optional)
PaginatedResponseMetadata

SearchVDBGroupResponse - SearchVDBGroupResponse Up

items (optional)
array[VDBGroup]
response_metadata (optional)
PaginatedResponseMetadata

SearchVDBsResponse - SearchVDBsResponse Up

items (optional)
array[VDB]
response_metadata (optional)
PaginatedResponseMetadata

Snapshot - Up

Virtualization Engine Snapshot of a dSource or VDB.
id (optional)
String The Snapshot ID.
engine_id (optional)
String The id of the engine the snapshot belongs to.
namespace (optional)
String Alternate namespace for this object, for replicated and restored snapshots.
name (optional)
String The snapshot's name.
consistency (optional)
String Indicates what type of recovery strategies must be invoked when provisioning from this snapshot.
Enum:
CONSISTENT
INCONSISTENT
CRASH_CONSISTENT
PLUGGABLE
missing_non_logged_data (optional)
Boolean Indicates if a virtual database provisioned from this snapshot will be missing nologging changes.
dataset_id (optional)
String The ID of the Snapshot's dSource or VDB.
creation_time (optional)
Date The time when the snapshot was created. format: date-time
start_timestamp (optional)
Date The timestamp within the parent TimeFlow at which this snapshot was initiated.
No recovery earlier than this point needs to be applied in order to provision a database from
this snapshot. If start_timestamp equals timestamp, then no recovery needs to be
applied in order to provision a database. format: date-time
start_location (optional)
String The database specific indentifier within the parent TimeFlow at which this snapshot was initiated.
No recovery earlier than this point needs to be applied in order to provision a database from
this snapshot. If start_location equals location, then no recovery needs to be
applied in order to provision a database.
timestamp (optional)
Date The logical time of the data contained in this Snapshot. format: date-time
location (optional)
String Database specific identifier for the data contained in this Snapshot, such as the Log Sequence Number (LSN) for MSsql databases, System Change Number (SCN) for Oracle databases.
retention (optional)
Long Retention policy, in days. A value of -1 indicates the snapshot should be kept forever. format: int64
timeflow_id (optional)
String The TimeFlow this snapshot was taken on.
timezone (optional)
String Time zone of the source database at the time the snapshot was taken.
version (optional)
String Version of database source repository at the time the snapshot was taken.
temporary (optional)
Boolean Indicates that this snapshot is in a transient state and should not be user visible.
appdata_toolkit (optional)
String The toolkit associated with this snapshot.
appdata_metadata (optional)
map[String, Object] The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.
ase_db_encryption_key (optional)
String Database encryption key present for this snapshot.
mssql_internal_version (optional)
Long Internal version of the source database at the time the snapshot was taken. format: int64
mssql_backup_set_uuid (optional)
String UUID of the source database backup that was restored for this snapshot.
mssql_backup_software_type (optional)
String Backup software used to restore the source database backup for this snapshot
Enum:
AZURE_NATIVE
NATIVE
LITESPEED
REDGATE
NETBACKUP
COMMVAULT
mssql_backup_location_type (optional)
String Backup software used to restore the source database backup for this snapshot
Enum:
DISK
AZURE
BACKUP_SERVER
mssql_empty_snapshot (optional)
Boolean True if the staging push dSource snapshot is empty.
oracle_from_physical_standby_vdb (optional)
Boolean True if this snapshot was taken of a standby database.
oracle_redo_log_size_in_bytes (optional)
Long Online redo log size in bytes when this snapshot was taken. format: int64

SnapshotDSourceResponse - SnapshotDSourceResponse Up

job (optional)
Job

SnapshotVDBResponse - SnapshotVDBResponse Up

job (optional)
Job

Source - Up

The Delphix representation of the source database (not typically managed by Delphix).
id (optional)
String The Source object entity ID.
database_type (optional)
String The type of this source database.
name (optional)
String The name of this source database.
database_version (optional)
String The version of this source database.
environment_id (optional)
String A reference to the Environment that hosts this source database.
data_uuid (optional)
String A universal ID that uniquely identifies this source database.
ip_address (optional)
String The IP address of the source's host.
fqdn (optional)
String The FQDN of the source's host.
size (optional)
Long The total size of this source database, in bytes. format: int64
jdbc_connection_string (optional)
String The JDBC connection URL for this source database.
plugin_version (optional)
String The version of the plugin associated with this source database.
tags (optional)
array[Tag]

StartVDBResponse - StartVDBResponse Up

job (optional)
Job

StopVDBResponse - StopVDBResponse Up

job (optional)
Job

Tag - Up

key
String Key of the tag
value
String Value of the tag

TagsRequest - Up

tags
set[Tag] Array of tags with key value pairs

TagsResponse - Up

tags (optional)
array[Tag] Array of tags with key value pairs

TaskEvent - Up

A step or event performed by a masking execution.
event (optional)
String The steps or events a task will perform.
status (optional)
String The state of result of the task event.
Enum:
CANCELLED
FAILED
QUEUED
RUNNING
SUCCEEDED
SKIPPED
NON_CONFORMANT

TokenInfoRequest - Up

token
String API Key or JWT token for fetching information

TokenInfoResponse - Up

active (optional)
Boolean Flag to identify if the token is active.
token_type (optional)
String Type of the token.
account_id (optional)
Long Numeric ID of the account. format: int64
first_name (optional)
String First name for the Account.
last_name (optional)
String Last name for the Account.
email (optional)
String Email for the Account.
username (optional)
String The username or logical name for the Account.
ldap_principal (optional)
String The LDAP Principal for the Account.
exp (optional)
Long Seconds duration after which the token will expire. format: int64

UpdateAccessGroupScope - Up

An Access group scope parameters that are allowed to update.
name (optional)
String The Access group scope name.
scope_type (optional)
String Specifies the type of the scope. Scope of type SIMPLE would grant access to all DCT objects. Scope of type SCOPED would grant access to all objects based on objects and object-tags and permissions defined in linked role. Scope of type ADVANCED would grant access to DCT objects based on objects and object-tags and the individual permissions.
Enum:
SIMPLE
SCOPED
ADVANCED

UpdateConnectorResponse - UpdateConnectorResponse Up

job (optional)
Job

UpdateDatabaseTemplateParameters - Up

Parameters to update a Database Template.
name (optional)
String The DatabaseTemplate name.
description (optional)
String User provided description for this template.
source_type (optional)
String The type of the source associated with the template.
Enum:
OracleVirtualSource
OracleLinkedSource
MSSqlVirtualSource
MSSqlLinkedSource
parameters (optional)
map[String, String] A name/value map of string configuration parameters.

UpdateDatabaseTemplateResponse - UpdateDatabaseTemplateResponse Up

job (optional)
Job

UpdateEnvironmentResponse - UpdateEnvironmentResponse Up

job (optional)
Job

UpdateEnvironmentUserResponse - UpdateEnvironmentUserResponse Up

job (optional)
Job

UpdateHostResponse - UpdateHostResponse Up

job (optional)
Job

UpdateMaskingJobParameters - Up

Parameters to update a MaskingJob.
name (optional)
String The name of the MaskingJob.
connector_username (optional)
String The username of the Connector used by the MaskingJob.
connector_password (optional)
String The password of the Connector used by the MaskingJob.
on_the_fly_source_connector_username (optional)
String The username of the source Connector used by the on-the-fly MaskingJob.
on_the_fly_source_connector_password (optional)
String The password of the source Connector used by the on-the-fly MaskingJob.

UpdateVDBGroupParameters - Up

Parameters to update a VDB group.
name (optional)
String The name of the VDB group.
vdb_ids (optional)
array[String]

UpdateVDBParameters - Up

Parameters to update a VDB.
name (optional)
String The unique name of the VDB within a group.
db_username (optional)
String The username of the database user (Oracle, ASE Only).
db_password (optional)
String The password of the database user (Oracle, ASE Only).
validate_db_credentials (optional)
Boolean Whether db_username and db_password must be validated, if present, against the VDB. This must be set to false when credentials validation is not possible, for instance if the VDB is known to be disabled.
auto_restart (optional)
Boolean Whether to enable VDB restart.
environment_user_id (optional)
String The environment user ID to use to connect to the target environment.
template_id (optional)
String The ID of the target VDB Template (Oracle Only).
listener_ids (optional)
array[String] The listener IDs for this provision operation (Oracle Only).
new_dbid (optional)
Boolean Whether to enable new DBID for Oracle
cdc_on_provision (optional)
Boolean Whether to enable CDC on provision for MSSql
pre_script (optional)
String Pre script for MSSql.
post_script (optional)
String Post script for MSSql.
hooks (optional)
VirtualDatasetHooks
custom_env_vars (optional)
map[String, String] Environment variable to be set when the engine administers a VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. Custom environment variables can only be updated while the VDB is disabled.
custom_env_files (optional)
array[String] Environment files to be sourced when the Engine administers a VDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VDB is disabled.
oracle_rac_custom_env_files (optional)
array[OracleRacCustomEnvFile] Environment files to be sourced when the Engine administers an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VDB is disabled.
oracle_rac_custom_env_vars (optional)
array[OracleRacCustomEnvVar] Environment variable to be set when the engine administers an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. Custom environment variables can only be updated while the VDB is disabled.
parent_tde_keystore_path (optional)
String Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)
parent_tde_keystore_password (optional)
String The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)
tde_key_identifier (optional)
String ID of the key created by Delphix. (Oracle Multitenant Only)
target_vcdb_tde_keystore_path (optional)
String Path to the keystore of the target vCDB. (Oracle Multitenant Only)
cdb_tde_keystore_password (optional)
String The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)
appdata_source_params (optional)
map[String, Object] The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.
additional_mount_points (optional)
array[AdditionalMountPoint] Specifies additional locations on which to mount a subdirectory of an AppData container. Can only be updated while the VDB is disabled.
appdata_config_params (optional)
map[String, Object] The parameters specified by the source config schema in the toolkit
config_params (optional)
map[String, Object] Database configuration parameter overrides.
mount_point (optional)
String Mount point for the VDB (AppData only), can only be updated while the VDB is disabled.

UpdateVDBResponse - UpdateVDBResponse Up

job (optional)
Job

VCDB - Up

The Delphix Oracle Virtual Container Database.
id (optional)
String The vCDB object entity ID.
name (optional)
String The name of this vCDB.
database_version (optional)
String The version of this vCDB.
environment_id (optional)
String A reference to the Environment that hosts this vCDB.
size (optional)
Long The total size of the data files used by this vCDB, in bytes. format: int64
engine_id (optional)
String A reference to the Engine that this vCDB belongs to.
status (optional)
String The runtime status of the vCDB.
parent_id (optional)
String A reference to the parent CDB of this vCDB.
creation_date (optional)
Date The date this vCDB was created. format: date-time
group_name (optional)
String The name of the group containing this vCDB.
enabled (optional)
Boolean Whether the vCDB is enabled or not.
tags (optional)
array[Tag]

VDB - Up

A Delphix virtual database or dataset.
id (optional)
String The VDB object entity ID.
database_type (optional)
String The database type of this VDB.
name (optional)
String The container name of this VDB.
database_version (optional)
String The database version of this VDB.
size (optional)
Long The total size of this VDB, in bytes. format: int64
engine_id (optional)
String A reference to the Engine that this VDB belongs to.
status (optional)
String The runtime status of the VDB. 'Unknown' if all attempts to connect to the dataset failed.
environment_id (optional)
String A reference to the Environment that hosts this VDB.
ip_address (optional)
String The IP address of the VDB's host.
fqdn (optional)
String The FQDN of the VDB's host.
parent_id (optional)
String A reference to the parent dataset of this VDB.
parent_dsource_id (optional)
String A reference to the parent dSource of this VDB.
group_name (optional)
String The name of the group containing this VDB.
engine_name (optional)
String Name of the Engine where this VDB is hosted
cdb_id (optional)
String A reference to the CDB or VCDB associated with this VDB.
tags (optional)
array[Tag]
creation_date (optional)
Date The date this VDB was created. format: date-time
hooks (optional)
VirtualDatasetHooks
appdata_source_params (optional)
map[String, Object] The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.
template_id (optional)
String A reference to the Database Template.
config_params (optional)
map[String, Object] Database configuration parameter overrides.
additional_mount_points (optional)
array[AdditionalMountPoint] Specifies additional locations on which to mount a subdirectory of an AppData container. Can only be updated while the VDB is disabled.
appdata_config_params (optional)
map[String, Object] The parameters specified by the source config schema in the toolkit
mount_point (optional)
String Mount point for the VDB (Oracle, ASE, AppData).

VDBGroup - Up

A collection of virtual databases and datesets.
id
String A unique identifier for the entity.
name
String A unique name for the entity.
vdb_ids
array[String] The list of VDB IDs in this VDBGroup.
tags (optional)
array[Tag]

VDBInventoryData - Up

engine_name (optional)
String
name (optional)
String
type (optional)
String
version (optional)
String
parent_name (optional)
String
parent_id (optional)
String
creation_date (optional)
Date format: date-time
parent_timeflow_location (optional)
String
parent_timeflow_timestamp (optional)
Date format: date-time
parent_timeflow_timezone (optional)
String
enabled (optional)
Boolean
status (optional)
String

VDBInventoryReportResponse - VDBInventoryReportResponse Up

items (optional)
array[VDBInventoryData]
response_metadata (optional)
PaginatedResponseMetadata

VirtualDatasetHooks - Up

VDB operation hooks.
pre_refresh (optional)
array[Hook] The commands to execute on the target environment before refreshing the VDB.
post_refresh (optional)
array[Hook] The commands to execute on the target environment after refreshing the VDB.
pre_rollback (optional)
array[Hook] The commands to execute on the target environment before rewinding the VDB.
post_rollback (optional)
array[Hook] The commands to execute on the target environment after rewinding the VDB.
configure_clone (optional)
array[Hook] The commands to execute on the target environment when the VDB is created or refreshed.
pre_snapshot (optional)
array[Hook] The commands to execute on the target environment before snapshotting a virtual source. These commands can quiesce any data prior to snapshotting.
post_snapshot (optional)
array[Hook] The commands to execute on the target environment after snapshotting a virtual source.
pre_start (optional)
array[Hook] The commands to execute on the target environment before starting a virtual source.
post_start (optional)
array[Hook] The commands to execute on the target environment after starting a virtual source.
pre_stop (optional)
array[Hook] The commands to execute on the target environment before stopping a virtual source.
post_stop (optional)
array[Hook] The commands to execute on the target environment after stopping a virtual source.

VirtualizationStorageSummaryData - Up

engine_id
String A reference to the engine.
engine_name
String The engine name.
engine_hostname
String The engine hostname.
total_capacity (optional)
Long The total amount of storage allocated for engine objects and system metadata, in bytes. format: int64
free_storage (optional)
Long The amount of available storage, in bytes. format: int64
used_storage (optional)
Long The amount of storage used by engine objects and system metadata, in bytes. format: int64
used_percentage (optional)
BigDecimal The percentage of storage used.
dsource_count (optional)
Long The number of dSources on the engine. format: int64
vdb_count (optional)
Long The number of VDBs on the engine. format: int64
total_object_count (optional)
Long The total number of dSources and VDBs on the engine. format: int64

VirtualizationStorageSummaryReportResponse - VirtualizationStorageSummaryReportResponse Up

items (optional)
array[VirtualizationStorageSummaryData]
response_metadata (optional)
PaginatedResponseMetadata