domain

Get all domains

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get domains. This will default to the first page if excluded

page_size
integer <int64>

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

Responses
200

Success

400

Bad request

get/domains
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create domain

Securityapi_key
Request
Request Body schema: application/json
required

The domain to create

domainName
required
string <= 20 characters
defaultAlgorithmCode
required
string <= 500 characters

Must be one of the algorithm codes

defaultTokenizationCode
string <= 500 characters

This input is optional. If used, must be one of the tokenization algorithm codes

Responses
201

Success

400

Bad request

404

Not found

409

Conflict

post/domains
Request samples
application/json
{
  • "domainName": "NEW_DOMAIN",
  • "defaultAlgorithmCode": "SimpleMaskingAlgorithm"
}
Response samples
application/json
{
  • "domainName": "NEW_DOMAIN",
  • "defaultAlgorithmCode": "SimpleMaskingAlgorithm"
}

Get domain by name

Securityapi_key
Request
path Parameters
domainName
required
string

The name of the domain to get

Responses
400

Bad request

404

Not found

409

Conflict

default

Success

get/domains/{domainName}
Response samples
application/json
{
  • "domainName": "NEW_DOMAIN",
  • "defaultAlgorithmCode": "SimpleMaskingAlgorithm"
}

Update domain by name

Securityapi_key
Request
path Parameters
domainName
required
string

The name of the domain to update

Request Body schema: application/json
required

The updated domain

domainName
required
string <= 20 characters
defaultAlgorithmCode
required
string <= 500 characters

Must be one of the algorithm codes

defaultTokenizationCode
string <= 500 characters

This input is optional. If used, must be one of the tokenization algorithm codes

Responses
200

Success

400

Bad request

404

Not found

put/domains/{domainName}
Request samples
application/json
{
  • "domainName": "NEW_DOMAIN",
  • "defaultAlgorithmCode": "SimpleMaskingAlgorithm"
}
Response samples
application/json
{
  • "domainName": "NEW_DOMAIN",
  • "defaultAlgorithmCode": "SimpleMaskingAlgorithm"
}

Delete domain by name

Securityapi_key
Request
path Parameters
domainName
required
string

The name of the domain to delete

Responses
200

Success

400

Bad request

404

Not found

delete/domains/{domainName}
➔ Next to encryptionKey