Migrate Deployment BYOK

Auth

Migrate an existing deployment to use customer-managed encryption keys (BYOK). Currently unavailable in self-hosted ECE.

Path parameters

deployment_id string required

Identifier for the Deployment

Request body

Request to migrate deployment to BYOK encryption

key_resource_path string required

Key resource path for the customer-managed encryption key.

Responses

BYOK migration request accepted.

application/json
accepted boolean required

Whether the request was accepted.

message string required

Response message.

  • BYOK is not supported for system-owned deployments. (code: byok_configuration.system_cluster_not_supported)
  • The deployment has ILM policies using found-snapshots in cold/frozen phases. (code: byok_migration.ilm_policy_conflict)
application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

You are not authorized to perform this action.

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

  • A different key is already configured on the deployment. (code: byok_migration.key_mismatch)
  • Another plan is pending on the deployment. (code: deployments.resource_plan_state_error)
application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

An error occurred while processing the request.

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields