POST api/Speke?overrideKeyIds={overrideKeyIds}&protectionScheme={protectionScheme}

Takes an input CPIX document and fills it based on the SPEKEv1 specification.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
overrideKeyIds

Overrides key IDs in the request with customer derivable key IDs.

 boolean

Default value is False
protectionScheme

Determines if the protection sceme is 'cbcs'.

 string

Default value is

Body Parameters

None.

Response Information

Resource Description

None.

Status Codes

All HTTP status codes must be expected, but the following status codes are the most probable:

  • OK (200) - CPIX was successfully generated.
  • BadRequest (400) - CPIX generation failed due to invalid input data.
  • BadRequest (400) - The 'overrideKeyIds' parameter has an incorrect value.