Sign in
Keys (byok/v1)

Update a Key

General Availability

Make a request to update a key.

patch/byok/v1/keys/{id}

Path parameters

idstring required

The unique identifier for the key.

Request body

api_version'byok/v1'

APIVersion defines the schema version of this representation of a resource.

kind'Key'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

display_namestring

The human-readable name of the key object.

providerstring

The cloud provider of the Key.

statestring

The state of the key:

AVAILABLE: key can be used for a Kafka cluster provisioning.

IN_USE: key is already in use by a Kafka cluster provisioning.

Example request

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/byok/v1/keys/cck-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/key=cck-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "key": {
    "key_arn": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
    "roles": [
      "arn:aws:iam::123456789876:role/block_storage_manager",
      "arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa"
    ]
  },
  "display_name": "Key for billing cluster",
  "provider": "AWS",
  "state": "IN_USE",
  "validation": {
    "phase": "VALID",
    "message": "Access to key denied.",
    "since": "2024-03-20T15:30:00Z",
    "region": "us-west-2"
  }
}

Response

Key.

api_version'byok/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'Key' required

Kind defines the object this REST resource represents.

idstring required

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

display_namestring

The human-readable name of the key object.

providerstring required

The cloud provider of the Key.

statestring required

The state of the key:

AVAILABLE: key can be used for a Kafka cluster provisioning.

IN_USE: key is already in use by a Kafka cluster provisioning.

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/byok/v1/keys/cck-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/key=cck-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "key": {
    "key_arn": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
    "roles": [
      "arn:aws:iam::123456789876:role/block_storage_manager",
      "arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa"
    ]
  },
  "display_name": "Key for billing cluster",
  "provider": "AWS",
  "state": "IN_USE",
  "validation": {
    "phase": "VALID",
    "message": "Access to key denied.",
    "since": "2024-03-20T15:30:00Z",
    "region": "us-west-2"
  }
}

Changes

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