Tokenization Management API

Get Formats getFormats

GET

Try it out

Query Parameters

query

Custom Query Parameters

Custom Headers

Get a list of formats.

Query Parameters

query: string

Filter the formats by providing a comma separate list of format uuids

Response

*/*

Successful operation.

items: array

Array items

Examples

*/*

[ { "id": "string", "type": "string" } ]

Unauthorized. Authentication credentials are missing or invalid.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal Server Error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Create Formats createFormats

POST

Try it out

Custom Query Parameters

Custom Headers

Request Body application/json

Create a new format.

Request Body

json

Response

Resource created successfully.

Examples

*/*

{}

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unauthorized. Authentication credentials are missing or invalid.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unprocessable Entity.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal Server Error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Get Formats By Formatid getFormatsByFormatid

GET

Try it out

Path Parameters

formatId *

Custom Query Parameters

Custom Headers

Get the format
with id =
{formatId}

Path Parameters

formatId *: string

The format ID to identify the target resource.

Response

Successful operation.

Examples

*/*

{}

Unauthorized. Authentication credentials are missing or invalid.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Not found. The requested resource does not exist.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Update Formats By Formatid updateFormatsByFormatid

PUT

Try it out

Path Parameters

formatId *

Custom Query Parameters

Custom Headers

Request Body application/json

Replaces a formats.

Path Parameters

formatId *: string

The format ID to identify the target resource.

Request Body

json

Response

Successful operation.

Examples

*/*

{}

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unauthorized. Authentication credentials are missing or invalid.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unprocessable Entity.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Delete Formats By Formatid deleteFormatsByFormatid

DELETE

Try it out

Path Parameters

formatId *

Custom Query Parameters

Custom Headers

Deletes a formats.

Path Parameters

formatId *: string

The format ID to identify the target resource.

Response

Operation completed successfully with no content returned.

Unauthorized. Authentication credentials are missing or invalid.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unprocessable entity. The request body contains semantic errors.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Get Services getServices

GET

Try it out

Custom Query Parameters

Custom Headers

Get a list of services.

Response

Successful operation.

Examples

*/*

{}

Unauthorized. Authentication credentials are missing or invalid.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal Server Error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Get Environments By Envid Services getEnvironmentsByEnvidServices

GET

Try it out

Path Parameters

envId *

Custom Query Parameters

Custom Headers

Get a list of services.

Path Parameters

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Response

*/*

Successful operation.

items: array

Array items

id *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

ipAddress *: any

status *: string

serviceData *: object

logs: object

environmentId *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

organizationId *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

vdpOperationInfo *: object

Used during the creation of a tokenization service. Can be used to know more about the reason for the failure of service call.

vdpUpdateOperationInfo: any

Used during the update of an existing tokenization service. Can be used to know more about the reason for the failure of update service call.

deploymentInfo *: any

Represents the deployment information. If null the deployer was not called or the call failed so there is no associated deployment for this service. If a value of DeploymentInfoObject exists then there is an 'deployerId' associated which means that a deployment request is created for this service and any further manipulation of the service will lead to update of the an object associated to this 'deploymentId'. The field 'deployerCallSuccessful' indicates whether the last call to the deployer was made successfully. This is especially helpful in scenarios where an update of service happened and we want to confirm that deployer request went through.

createdAt *: string

updatedAt *: string

downloadedAt *: string

Examples

*/*

[ { "id": "string", "type": "string" } ]

Unauthorized. Authentication credentials are missing or invalid.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal Server Error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Create Environments By Envid Services createEnvironmentsByEnvidServices

POST

Try it out

Path Parameters

envId *

Custom Query Parameters

Custom Headers

Request Body application/json

Create a new service.

Path Parameters

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Request Body

json

serviceData *: object

logs: object

audit: object

Response

*/*

Resource created successfully.

id *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

ipAddress *: any

status *: string

serviceData *: object

cpu: object

formats *: array

name *: string

minLength: 3, maxLength: 24, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

serviceURL: string

numberOfInstances *: integer

min: 1, max: 8

muleCloudID *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

esgVersion: string

logs: object

environmentId *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

organizationId *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

vdpOperationInfo *: object

Used during the creation of a tokenization service. Can be used to know more about the reason for the failure of service call.

vdpUpdateOperationInfo: any

Used during the update of an existing tokenization service. Can be used to know more about the reason for the failure of update service call.

deploymentInfo *: any

Represents the deployment information. If null the deployer was not called or the call failed so there is no associated deployment for this service. If a value of DeploymentInfoObject exists then there is an 'deployerId' associated which means that a deployment request is created for this service and any further manipulation of the service will lead to update of the an object associated to this 'deploymentId'. The field 'deployerCallSuccessful' indicates whether the last call to the deployer was made successfully. This is especially helpful in scenarios where an update of service happened and we want to confirm that deployer request went through.

createdAt *: string

updatedAt *: string

downloadedAt *: string

Examples

*/*

{ "id": { "id": "string", "type": "string" }, "ipAddress": { "id": "string", "type": "string" }, "status": { "id": "string", "type": "string" }, "serviceData": { "id": "string", "type": "string" }, "logs": { "id": "string", "type": "string" }, "environmentId": { "id": "string", "type": "string" }, "organizationId": { "id": "string", "type": "string" }, "vdpOperationInfo": { "status": { "id": "string", "type": "string" }, "finishTimestamp": "string", "processTimestamp": "string", "runnerNode": "string", "generalResponse": "string", "vdpResponse": { "id": "string", "type": "string" }, "csmResponse": { "id": "string", "type": "string" }, "exchangeResponse": { "id": "string", "type": "string" } }, "vdpUpdateOperationInfo": {}, "deploymentInfo": {} }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unauthorized. Authentication credentials are missing or invalid.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unprocessable Entity.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal Server Error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Service unavailable.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Get Environments By Envid Services By Serviceid getEnvironmentsByEnvidServicesByServiceid

GET

Try it out

Path Parameters

envId *

serviceId *

Custom Query Parameters

Custom Headers

Get the service
with id =
{serviceId}

Path Parameters

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

serviceId *: string

The service ID to identify the target resource.

Response

*/*

Successful operation.

id *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

ipAddress *: any

status *: string

serviceData *: object

cpu: object

formats *: array

name *: string

minLength: 3, maxLength: 24, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

serviceURL: string

numberOfInstances *: integer

min: 1, max: 8

muleCloudID *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

esgVersion: string

logs: object

environmentId *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

organizationId *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

vdpOperationInfo *: object

Used during the creation of a tokenization service. Can be used to know more about the reason for the failure of service call.

vdpUpdateOperationInfo: any

Used during the update of an existing tokenization service. Can be used to know more about the reason for the failure of update service call.

deploymentInfo *: any

Represents the deployment information. If null the deployer was not called or the call failed so there is no associated deployment for this service. If a value of DeploymentInfoObject exists then there is an 'deployerId' associated which means that a deployment request is created for this service and any further manipulation of the service will lead to update of the an object associated to this 'deploymentId'. The field 'deployerCallSuccessful' indicates whether the last call to the deployer was made successfully. This is especially helpful in scenarios where an update of service happened and we want to confirm that deployer request went through.

createdAt *: string

updatedAt *: string

downloadedAt *: string

Examples

*/*

{ "id": { "id": "string", "type": "string" }, "ipAddress": { "id": "string", "type": "string" }, "status": { "id": "string", "type": "string" }, "serviceData": { "id": "string", "type": "string" }, "logs": { "id": "string", "type": "string" }, "environmentId": { "id": "string", "type": "string" }, "organizationId": { "id": "string", "type": "string" }, "vdpOperationInfo": { "status": { "id": "string", "type": "string" }, "finishTimestamp": "string", "processTimestamp": "string", "runnerNode": "string", "generalResponse": "string", "vdpResponse": { "id": "string", "type": "string" }, "csmResponse": { "id": "string", "type": "string" }, "exchangeResponse": { "id": "string", "type": "string" } }, "vdpUpdateOperationInfo": {}, "deploymentInfo": {} }

Unauthorized. Authentication credentials are missing or invalid.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Not found. The requested resource does not exist.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Update Environments By Envid Services By Serviceid updateEnvironmentsByEnvidServicesByServiceid

PUT

Try it out

Path Parameters

envId *

serviceId *

Query Parameters

desiredStatus

rtfUpdate

Custom Query Parameters

Custom Headers

Request Body application/json

Replaces a services.

Path Parameters

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

serviceId *: string

The service ID to identify the target resource.

Query Parameters

desiredStatus: string

The desired state of service.

rtfUpdate: boolean

Set to true if the rtf needs to be changed.

Request Body

json

serviceData *: object

logs: object

audit: object

Response

Successful operation.

Examples

*/*

{ "id": "9f5d4e9a-9847-426b-8dc5-ce8db56647d2", "ipAddress": null, "status": "UPDATING", "serviceData": { "name": "ssnServiceTestNew108", "muleCloudID": "291d8f46-b24f-4caa-92d3-6671de72b20a", "formats": [ "3259bfc6-d361-4cb4-abc3-13d9741ce1e5", "3c6bdd6c-2ef2-4850-8392-a8de4d03025c" ], "numberOfInstances": 1, "esgVersion": "v0.3.153" }, "vdpOperationInfo": { "processTimestamp": "2018-09-06T15:01:59+00:00", "status": "CSM_DONE", "runnerNode": "eth0@10.7.1.51", "vdpResponse": { "domains": [ "creditCardNumber", "decimal", "laxDecimal", "socialSecurityNumber" ], "outputLocation": "vdp_1536246119750.vdp" }, "exchangeResponse": { "organizationId": "91d6681d-e388-4972-9dd9-74ee44a5088a", "groupId": "91d6681d-e388-4972-9dd9-74ee44a5088a", "assetId": "ssnServiceTestNew108-1536246400714", "version": "1.0.1536246400", "classifier": "vdp", "versionGroup": "1.0.1536246400", "metadata": { "name": "ssnServiceTestNew108", "type": "vdp", "classifier": "vdp", "tags": [ { "value": "vdp" } ] } }, "csmResponse": { "secretGroupId": "ff635e41-68b6-445b-8dea-8ea9551a7f09", "secretType": "sharedSecrets", "secretId": "28d6c3ba-a144-4285-8a3b-756a74fb48eb", "packaging": "secret", "type": "GLOBAL" }, "finishTimestamp": "2018-09-06T15:06:55+00:00" }, "logs": { "portLogLevel": "WARNING", "filters": [] }, "organizationId": "91d6681d-e388-4972-9dd9-74ee44a5088a", "environmentId": "29627ca0-fd5b-456c-8bae-7dfd5ddabe8b", "vdpUpdateOperationInfo": null, "deploymentInfo": { "deploymentId": "a3dd5aca-b1e5-11e8-b36d-fb58563a0a93", "deployerCallSuccessful": true }, "createdAt": "2019-01-14T18:23:57.267000+00:00", "updatedAt": "2019-03-14T18:23:57.267000+00:00", "downloadedAt": "2019-02-14T18:23:57.267000+00:00", "audit": { "enabled": false } }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unauthorized. Authentication credentials are missing or invalid.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unprocessable Entity.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Service unavailable.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Patch Environments By Envid Services By Serviceid patchEnvironmentsByEnvidServicesByServiceid

PATCH

Try it out

Path Parameters

envId *

serviceId *

Custom Query Parameters

Custom Headers

To perform rekey of a VDP table associated with a service.

Path Parameters

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

serviceId *: string

The service ID to identify the target resource.

Response

Successful operation.

Examples

*/*

{ "id": "9f5d4e9a-9847-426b-8dc5-ce8db56647d2", "ipAddress": null, "status": "UPDATING", "serviceData": { "name": "ssnServiceTestNew108", "muleCloudID": "291d8f46-b24f-4caa-92d3-6671de72b20a", "formats": [ "3259bfc6-d361-4cb4-abc3-13d9741ce1e5", "3c6bdd6c-2ef2-4850-8392-a8de4d03025c" ], "numberOfInstances": 1, "esgVersion": "v0.3.153" }, "vdpOperationInfo": { "processTimestamp": "2018-09-06T15:01:59+00:00", "status": "CSM_DONE", "runnerNode": "eth0@10.7.1.51", "vdpResponse": { "domains": [ "creditCardNumber", "decimal", "laxDecimal", "socialSecurityNumber" ], "outputLocation": "vdp_1536246119750.vdp" }, "exchangeResponse": { "organizationId": "91d6681d-e388-4972-9dd9-74ee44a5088a", "groupId": "91d6681d-e388-4972-9dd9-74ee44a5088a", "assetId": "ssnServiceTestNew108-1536246400714", "version": "1.0.1536246400", "classifier": "vdp", "versionGroup": "1.0.1536246400", "metadata": { "name": "ssnServiceTestNew108", "type": "vdp", "classifier": "vdp", "tags": [ { "value": "vdp" } ] } }, "csmResponse": { "secretGroupId": "ff635e41-68b6-445b-8dea-8ea9551a7f09", "secretType": "sharedSecrets", "secretId": "28d6c3ba-a144-4285-8a3b-756a74fb48eb", "packaging": "secret", "type": "GLOBAL" }, "finishTimestamp": "2018-09-06T15:06:55+00:00" }, "logs": { "portLogLevel": "WARNING", "filters": [] }, "organizationId": "91d6681d-e388-4972-9dd9-74ee44a5088a", "environmentId": "29627ca0-fd5b-456c-8bae-7dfd5ddabe8b", "vdpUpdateOperationInfo": null, "deploymentInfo": { "deploymentId": "a3dd5aca-b1e5-11e8-b36d-fb58563a0a93", "deployerCallSuccessful": true }, "createdAt": "2019-01-14T18:23:57.267000+00:00", "updatedAt": "2019-03-14T18:23:57.267000+00:00", "downloadedAt": "2019-02-14T18:23:57.267000+00:00", "audit": { "enabled": false } }

Unauthorized. Authentication credentials are missing or invalid.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Service unavailable.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Delete Environments By Envid Services By Serviceid deleteEnvironmentsByEnvidServicesByServiceid

DELETE

Try it out

Path Parameters

envId *

serviceId *

Custom Query Parameters

Custom Headers

Deletes a services.

Path Parameters

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

serviceId *: string

The service ID to identify the target resource.

Response

Operation completed successfully with no content returned.

Unauthorized. Authentication credentials are missing or invalid.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Get Environments By Envid Deployments getEnvironmentsByEnvidDeployments

GET

Try it out

Path Parameters

envId *

Query Parameters

tragetId *

Custom Query Parameters

Custom Headers

Get deployer information for tokenization services.

Path Parameters

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Query Parameters

tragetId *: string

This is a required parameter. This is a , separated list of all runtime fabric uuids

Response

Successful operation.

Examples

*/*

[ { "id": "4b81bb7e-d35e-11e8-a1c5-670c909cda8c", "type": "Tokenizer", "target": { "id": "6fbcddb7-5676-4b7d-adb2-923e80355b12", "provider": "MC" }, "name": "ccnServiceTest7", "scope": { "organization": "1c9c4eba-5d30-40a8-9ba4-e81c75266530", "environment": "9adfafe3-0b50-43f8-971a-f3445e7c260d" }, "labels": { "owner": "TokenizerService" }, "specVersion": "4b81bb80-d35e-11e8-a1c5-89789b0436b6", "status": { "status": "FAILED", "lastSuccessfulSpec": null, "nodes": [ { "id": "6fbcddb7-5676-4b7d-adb2-923e80355b12", "status": "FAILED", "replicas": [ { "currentVersion": "4b81bb80-d35e-11e8-a1c5-89789b0436b6", "state": "FAILED", "reason": "Failed to pull securityfabric-tokenizer:v0.3.148" } ] } ] }, "createdAt": 1539926258198, "updatedAt": 1539926258198 }, { "id": "87e42d25-d337-11e8-a4c6-79986f4f0474", "type": "Tokenizer", "target": { "id": "6fbcddb7-5676-4b7d-adb2-923e80355b12", "provider": "MC" }, "name": "ccnServiceTest6", "scope": { "organization": "1c9c4eba-5d30-40a8-9ba4-e81c75266530", "environment": "9adfafe3-0b50-43f8-971a-f3445e7c260d" }, "labels": { "owner": "TokenizerService" }, "specVersion": "87e42d27-d337-11e8-a4c6-f590e575a82c", "status": { "status": "FAILED", "lastSuccessfulSpec": null, "nodes": [ { "id": "6fbcddb7-5676-4b7d-adb2-923e80355b12", "status": "FAILED", "replicas": [ { "currentVersion": "87e42d27-d337-11e8-a4c6-f590e575a82c", "state": "FAILED", "reason": "Failed to pull securityfabric-tokenizer:v0.3.148" } ] } ] }, "createdAt": 1539909609134, "updatedAt": 1539909609134 }, { "id": "41760a5f-d2f7-11e8-a1c5-ed8fb7e98892", "type": "Tokenizer", "target": { "id": "6fbcddb7-5676-4b7d-adb2-923e80355b12", "provider": "MC" }, "name": "ssnService1", "scope": { "organization": "1c9c4eba-5d30-40a8-9ba4-e81c75266530", "environment": "9adfafe3-0b50-43f8-971a-f3445e7c260d" }, "labels": { "owner": "TokenizerService" }, "specVersion": "2bee5283-d30b-11e8-a1c5-459e04a7ab08", "status": { "status": "APPLIED", "lastSuccessfulSpec": "2bee5283-d30b-11e8-a1c5-459e04a7ab08", "nodes": [ { "id": "6fbcddb7-5676-4b7d-adb2-923e80355b12", "status": "APPLIED", "replicas": [ { "currentVersion": "2bee5283-d30b-11e8-a1c5-459e04a7ab08", "state": "STARTED", "reason": null } ] } ] }, "createdAt": 1539882003181, "updatedAt": 1539890556993 }, { "id": "d0ff583c-d189-11e8-a1c5-657a5fa20489", "type": "Tokenizer", "target": { "id": "6fbcddb7-5676-4b7d-adb2-923e80355b12", "provider": "MC" }, "name": "ccnService1", "scope": { "organization": "1c9c4eba-5d30-40a8-9ba4-e81c75266530", "environment": "9adfafe3-0b50-43f8-971a-f3445e7c260d" }, "labels": { "owner": "TokenizerService" }, "specVersion": "82c6e715-d18c-11e8-a1c5-4f85b90ed03c", "status": { "status": "APPLIED", "lastSuccessfulSpec": "82c6e715-d18c-11e8-a1c5-4f85b90ed03c", "nodes": [ { "id": "6fbcddb7-5676-4b7d-adb2-923e80355b12", "status": "APPLIED", "replicas": [ { "currentVersion": "82c6e715-d18c-11e8-a1c5-4f85b90ed03c", "state": "STARTED", "reason": null } ] } ] }, "createdAt": 1539725048192, "updatedAt": 1539726205449 } ]

Bad request. The request was malformed or contains invalid parameters.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Get Environments By Envid Deployments By Deploymentid getEnvironmentsByEnvidDeploymentsByDeploymentid

GET

Try it out

Path Parameters

envId *

deploymentId *

Custom Query Parameters

Custom Headers

Get the deployment
with id =
{deploymentId}

Path Parameters

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

Response

*/*

Successful operation.

id *: string

ID of the deployment that was created.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

type *: string

Deployment Type that has to be defined in atlas.

target *: object

Deployment Target

name *: string

scope *: object

strategies: object

Object with keys containing the name of a deployment strategy and a value containing the configuration of the strategy.

labels: object

Key value pair of labels that are used to allow custom filtering of deployments.

specVersion *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

status *: object

createdAt *: integer

updatedAt *: integer

spec: object

Examples

*/*

{ "id": "string", "type": { "id": "string", "type": "string" }, "target": { "id": "string", "provider": "MC" }, "name": "string", "scope": { "id": "string", "type": "string" }, "strategies": { "id": "string", "type": "string" }, "labels": { "id": "string", "type": "string" }, "specVersion": { "id": "string", "type": "string" }, "status": { "id": "string", "type": "string" }, "createdAt": 0 }

Unauthorized. Authentication credentials are missing or invalid.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Not found. The requested resource does not exist.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Get Environments By Envid Deployments By Deploymentid Specs getEnvironmentsByEnvidDeploymentsByDeploymentidSpecs

GET

Try it out

Path Parameters

envId *

deploymentId *

Custom Query Parameters

Custom Headers

Get the list of specs defined for a particular deployment. The specs that will appear in this list are:

1) The desired spec referenced by the specVersion attribute of the deployment.

2) The former spec.

3) All the specs that are applied in any target node.

Path Parameters

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

Response

*/*

Successful operation.

target: object

Definition of a deployment configuration

replicas: integer

Number of replicas of the deployment. The replica number define the number of times
a deployment must be replicated in a particular Targets node. This is not related to
the number of Nodes of a Target. If a Target has two nodes and the replica number is two
then four replicas total of the same deployment will be running.

default: 1, min: 1

desiredStatus: string

The desired status of the deployment replicas that will identified as the deployment to be applied.
This is a free text that will depend on the deployment type. The allowed string has to be registered in
atlas. If not defined then APPLIED is taken as default.

default: APPLIED

runtimeVersion *: string

The version of the runtime where the deployment has to be performed.

configuration: object

Deployment configuration. This is the configuration that is specific to the deployment no matter which is
the deployment target. A field called assets should be present here, containing a map from refId to Asset.

environment: object

The deployment will be performed in one particualr target provided by a Target provider. The environment
configuration is the configuration required by a deployment that is specific to a target provider. For example,
the service bindings in a PCF deployment.

createdAt *: integer

Examples

*/*

{ "target": { "id": "string", "type": "string" } }

Unauthorized. Authentication credentials are missing or invalid.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Not found. The requested resource does not exist.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Overview

Servers

Authentication & Security

Get Formats getFormats

Try it out

Response

Query Parameters

Response

Create Formats createFormats

Try it out

Response

Request Body

Response

Get Formats By Formatid getFormatsByFormatid

Try it out

Response

Path Parameters

Response

Update Formats By Formatid updateFormatsByFormatid

Try it out

Response

Path Parameters

Request Body

Response

Delete Formats By Formatid deleteFormatsByFormatid

Try it out

Response

Path Parameters

Response

Get Services getServices

Try it out

Response

Response

Get Environments By Envid Services getEnvironmentsByEnvidServices

Try it out

Response

Path Parameters

Response

Create Environments By Envid Services createEnvironmentsByEnvidServices

Try it out

Response

Path Parameters

Request Body

Response

Get Environments By Envid Services By Serviceid getEnvironmentsByEnvidServicesByServiceid

Try it out

Response

Path Parameters

Response

Update Environments By Envid Services By Serviceid updateEnvironmentsByEnvidServicesByServiceid

Try it out

Response

Path Parameters

Query Parameters

Request Body

Response

Patch Environments By Envid Services By Serviceid patchEnvironmentsByEnvidServicesByServiceid

Try it out

Response

Path Parameters

Response

Delete Environments By Envid Services By Serviceid deleteEnvironmentsByEnvidServicesByServiceid

Try it out

Response

Path Parameters

Response

Get Environments By Envid Deployments getEnvironmentsByEnvidDeployments

Try it out

Response

Path Parameters

Query Parameters

Response

Get Environments By Envid Deployments By Deploymentid getEnvironmentsByEnvidDeploymentsByDeploymentid

Try it out

Response

Path Parameters

Response

Get Environments By Envid Deployments By Deploymentid Specs getEnvironmentsByEnvidDeploymentsByDeploymentidSpecs

Try it out