The encryption key object

⚠️

Preview — this feature is being built; the design below is the spec.

The encryption_key object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "type": "encryption_key",
  "provider": "gcp",
  "key_ref": "projects/acme-sec/locations/europe-west3/keyRings/syntic/cryptoKeys/content-2027",
  "status": "active",
  "previous_key_ref": "projects/acme-sec/locations/europe-west3/keyRings/syntic/cryptoKeys/content",
  "reencryption": {
    "status": "running",
    "objects_total": 48211,
    "objects_done": 0
  }
}

Fields

Field	Type	Description
`type`	string	The object type, always `encryption_key`.
`provider`	string	`gcp`, `aws` or `azure`.
`key_ref`	string	The key’s resource name, ARN or URL in your KMS.
`status`	string	`verifying`, `active`, `unreachable` (cannot be used right now) or `revoked` (your KMS denied access).
`previous_key_ref`	string	Keep this key enabled until re-encryption completes.
`reencryption`	object	Progress of the background re-encryption.

Returned by

deployment_run environment

Was this page helpful?