v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB

Secrets

Get secret

get/cloud/v1/secrets/{project_id}/{region_id}/{secret_id}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:1

Region ID

secret_idstring uuid4 required

Secret ID

Example:bfc7824b-31b6-4a28-a0c4-7df137139215

Secret ID

Response

algorithmstring nullable

Metadata provided by a user or system for informational purposes. Defaults to None

bit_lengthinteger nullable

Metadata provided by a user or system for informational purposes. Value must be greater than zero. Defaults to None

content_typesobject nullable

Describes the content-types that can be used to retrieve the payload. The content-type used with symmetric secrets is application/octet-stream

createdstring date-time nullable

Datetime when the secret was created. The format is 2020-01-01T12:00:00+00:00

expirationstring date-time nullable

Datetime when the secret will expire. The format is 2020-01-01T12:00:00+00:00. Defaults to None

idstring required

Secret uuid

modestring nullable

Metadata provided by a user or system for informational purposes. Defaults to None

namestring required

Secret name

statusstring required

Status

Example response

{
  "algorithm": "aes",
  "bit_length": 256,
  "content_types": {
    "default": "application/octet-stream"
  },
  "created": "2023-03-23T20:00:00+00:00",
  "expiration": "2023-06-23T20:00:00+00:00",
  "id": "bfc7824b-31b6-4a28-a0c4-7df137139215",
  "mode": "cbc",
  "name": "AES key",
  "status": "ACTIVE"
}