POST

/PutEncryptionConfig

http://xray.{region}.amazonaws.com/PutEncryptionConfig

Updates the encryption configuration for X-Ray data.

Access Token Required: API Key

Body Params

Typestringrequired

The type of encryption. Set to <code>KMS</code> to use your own key for encryption. Set to <code>NONE</code> for default encryption.

KeyIdstring

An Amazon Web Services KMS key in one of the following formats: <ul> <li> Alias - The name of the key. For example, <code>alias/MyKey</code>. </li> <li> Key ID - The KMS key ID of the key. For example, <code>ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>. Amazon Web Services X-Ray does not support asymmetric KMS keys. </li> <li> ARN - The full Amazon Resource Name of the key ID or alias. For example, <code>arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>. Use this format to specify a key in a different account. </li> </ul> Omit this key if you set <code>Type</code> to <code>NONE</code>.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://xray.{region}.amazonaws.com/PutEncryptionConfig' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}