Skip to content
/
Get all database usages r...

Masking API (5.1.43)

Schema for the Continuous Compliance Engine API

Download OpenAPI description
CC Engine APIs (2025.3.0.0).json
CC Engine APIs (2025.3.0.0).yaml
Languages
Servers
Mock server
https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0
https://help-api.delphix.com/masking/api/v5.1.43

algorithm

Operations

logging

Operations

application

Operations

applicationSettings

Operations

asyncTask

Operations

billingUsage

Operations

Get all billing usage

Request

Security
api_key
Query
start_datestringrequired

The date after which all billing usage should be retrieved. Date format is 'yyyy-MM-dd'.

end_datestringrequired

The date before which all billing usage should be retrieved. Date format is 'yyyy-MM-dd'.

page_numberinteger(int64)

The page number for which to billing usage. This will default to the first page if excluded

Default 1
page_sizeinteger(int64)

The maximum number of objects to return. This will default to the DefaultApiPageSize setting property if not provided

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/billing-usage?start_date=string&end_date=string&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
totalSizenumber

Total size of the database from list of all database usage. It will be in bytes

Example: 2695200768
responseListArray of objects(BillingUsage)
Example: [{"databaseIdentifier":"testHost:testServiceName:testDbName","name":"testDbName","size":2695200768,"dbType":"oracle","billingPeriod":"2022 Oct - Dec (Q4)","failureReason":""}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 1,
    "total": 1
  },
  "totalSize": 2695200768,
  "responseList": [
    { … }
  ]
}

Get all database usages recorded in Masking engine

Request

Security
api_key
Query
start_datestring

The date after which database usage should be retrieved. Date format is 'yyyy-MM-dd'.

end_datestring

The date before which database usage should be retrieved. Date format is 'yyyy-MM-dd'.

database_namestring

Name of the database for which usage should be retrieved.

page_numberinteger(int64)

The page number for which to fetch database usage. This will default to the first page if excluded

Default 1
page_sizeinteger(int64)

The maximum number of objects to return. This will default to the DefaultApiPageSize setting property if not provided

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/database-usage?start_date=string&end_date=string&database_name=string&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
dataArray of objects(DatabaseUsage)
Example: [{"name":"testDbName","dbType":"oracle","size":2695200768,"databaseProperties":{"port":1504,"databaseIdentifier":"testHost:testServiceName:testDbName"},"executionId":1,"failureReason":"","reportingDate":"2018-11-06T04:14:46.929+0000"}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 1,
    "total": 1
  },
  "data": [
    { … }
  ]
}

classifier

Operations

columnMetadata

Operations

credentialPath

Operations

configuration

Operations

databaseConnector

Operations

databaseRuleset

Operations

domain

Operations

encryptionKey

Operations

environment

Operations

execution

Operations

executionComponent

Operations

executionEvent

Operations

sync

Operations

fileConnector

Operations

fileDownload

Operations

fileFieldMetadata

Operations

fileFormat

Operations

fileMetadata

Operations

fileRuleset

Operations

fileUpload

Operations

inventoryApproval

Operations

knowledgeBaseInfo

Operations

jdbcDriver

Operations

license

Operations

login

Operations

mainframeDatasetConnector

Operations

mainframeDatasetFieldMetadata

Operations

mainframeDatasetFormat

Operations

mainframeDatasetMetadata

Operations

mainframeDatasetRecordType

Operations

mainframeDatasetRuleset

Operations

mappingAlgorithm

Operations

maskingJob

Operations

monitoring

Operations

mountFilesystem

Operations

nonConformantDataSample

Operations

passwordVault

Operations

plugin

Operations

profileJob

Operations

profileSet

Operations

profileResultDatabase

Operations

profileResultFile

Operations

profileResultMainframe

Operations

recordType

Operations

recordTypeQualifier

Operations

reidentificationJob

Operations

role

Operations

sshKey

Operations

supportBundle

Operations

systemInformation

Operations

tableMetadata

Operations

tokenizationJob

Operations

user

Operations