Documentation

Secrets

secrets

Methods

Create Secret -> { tasks }
post/v1/secrets/{project_id}/{region_id}

Create secret

Create Secret V2 -> { tasks }
post/v2/secrets/{project_id}/{region_id}

Create secret v2

Delete Secret -> { tasks }
delete/v1/secrets/{project_id}/{region_id}/{secret_id}

Delete secret

List Secrets -> { count, results }
get/v1/secrets/{project_id}/{region_id}

List secrets

Get Secret -> { id, name, secret_type, 7 more... }
get/v1/secrets/{project_id}/{region_id}/{secret_id}

Get secret

Parameters
project_id: number
region_id: number
secret_id: string
Response fields
id: string

Secret uuid

name: string

Secret name

secret_type: "certificate" | "opaque" | "passphrase" | 3 more...

Secret type, base64 encoded. symmetric - Used for storing byte arrays such as keys suitable for symmetric encryption; public - Used for storing the public key of an asymmetric keypair; private - Used for storing the private key of an asymmetric keypair; passphrase - Used for storing plain text passphrases; certificate - Used for storing cryptographic certificates such as X.509 certificates; opaque - Used for backwards compatibility with previous versions of the API

status: string

Status

algorithm: string
Optional

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

bit_length: number
Optional

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

content_types: Record<string, string>
Optional

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

created: string
Optional
(format: date-time)

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

expiration: string
Optional
(format: date-time)

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

mode: string
Optional

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

Request example
200Example