Data Masking (DM)

DELETE /contexts/{id}

  • Description: Delete a `Context` object.

Parameters

Name Position Description Type
id path Context id string

Responses

200 - Success. The context was deleted

404 - The context with the specified id was not found

400 - Invalid request (invalid context id)

POST /policies

  • Description: Creates a new `Policy` object.
  • Consumes: [u’application/json’]

Parameters

Name Position Description Type
body body Policy

Responses

200 - Success. The body contains the requested policy id

400 - Invalid request (invalid policy).

POST /process

  • Description: process a payload
  • Consumes: [u’text/plain’, u’text/xml’, u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
policy query policy id string
context query context id string
X-DM-encryption-key header encryption key to use string
X-DM-encryption-iv header encryption initial vector to use string
body body payload

Responses

200 - Success. The body contains the processed payload

404 - The policy id or context id were not found

400 - Invalid request (invalid policy id, context id, missing headers).

POST /contexts

  • Description: Creates a new `Context` object.

Responses

200 - Success. The body contains the requested policy id

PUT /policies/{id}

  • Description: Update a `Policy` object.
  • Consumes: [u’application/json’]

Parameters

Name Position Description Type
id path Policy id string
body body Policy

Responses

200 - Success. The policy was updated

404 - The policy with the specified id was not found

400 - Invalid request (invalid policy id)

DELETE /policies/{id}

  • Description: Delete a `Policy` object.

Parameters

Name Position Description Type
id path Policy id string

Responses

200 - Success. The policy was deleted

404 - The policy with the specified id was not found

400 - Invalid request (invalid policy id)

GET /policies/{id}

  • Produces: [u’application/json’]
  • Description: Get a `Policy` object.
  • Consumes: [u’application/json’]

Parameters

Name Position Description Type
id path Policy id string

Responses

200 - Success. The body contains the requested policy

404 - The policy with the specified id was not found

400 - Invalid request (invalid policy id)