Managed Keys

Create managed key.

Create managed key.

post/_fabric/{fabric}/_api/kms/managedkey

Request

Path parameters

fabricstring required

The name of the fabric.

Request body

namestring
managedKeyTypestring
keyProviderstring
servicestring
descriptionstring
masterKeyIdsobject

Example request

{
  "name": "managed_key_1",
  "managedKeyType": "CMK",
  "keyProvider": "MACROMETA",
  "service": "SECRETS",
  "description": "Customer's managed key #1."
}

Response

Successfully created the managed key.

errorboolean

Flag if there is an error in response. False for this response.

codeinteger

The generated response code.

Example response

{
  "code": 200,
  "result": {
    "id": "lPz8KjI2_yzYBgjkk2jlWA.IqXfBlY",
    "name": "managed_key_1",
    "managedKeyType": "CMK",
    "keyProvider": "MACROMETA",
    "tenant": "_mm",
    "fabric": "_system",
    "createdAt": 1689020889736,
    "updatedAt": 1689020889736,
    "status": "ENABLED",
    "description": "Customer's key."
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.