Skip to content
PalomPalomAtlas

Set Encryption

PUT
/api/v1/buckets/{bucket}/encryption
curl --request PUT \
  --url https://example.com/api/v1/buckets/example/encryption \
  --header 'Content-Type: application/json' \
  --data '{ "encryption": { "algorithm": "AES256", "kms_key_id": "example" } }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
bucket
required
Bucket
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
SetEncryptionRequest
object
encryption
required
Any of:
EncryptionConfigModel
object
algorithm
required
Algorithm
string
Allowed values: AES256 aws:kms
kms_key_id
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Any of:
EncryptionConfigModel
object
algorithm
required
Algorithm
string
Allowed values: AES256 aws:kms
kms_key_id
Any of:
string
Example
{
  "algorithm": "AES256"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}