Schemas

ID of the secret. (UUID format)

Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1.

The base64-encoded secret payload of the version.

The CRC32 checksum of the data as a base-10 integer. This field is only available if a CRC32 was supplied during the creation of the version.

Type of the secret. See the Secret.Type enum for a description of values.

Time frame, from one second and up to one year, during which the secret's versions are valid. (in seconds)

Returns true if the version expires after a single user access.

Action to perform when the version of a secret expires. See the EphemeralPolicy.Action enum for a description of values.

The version's expiration date. (Optional.) If not specified, the version does not have an expiration date. (RFC 3339 format)

Returns true if the version expires after a single user access. (Optional.) If not specified, the version can be accessed an unlimited amount of times.

Action to perform when the version of a secret expires. See EphemeralPolicy.Action enum for a description of values.

Single page of versions.

Number of versions.

Single page of secrets matching the requested criteria.

Count of all secrets matching the requested criteria.

ID of the secret. (UUID format)

The SRN of the secret.

ID of the Project containing the secret. (UUID format)

Name of the secret.

Current status of the secret.

• ready: the secret can be read, modified and deleted.
• locked: no action can be performed on the secret. This status can only be applied and removed by Scaleway.

Date and time of the secret's creation. (RFC 3339 format)

Last update of the secret. (RFC 3339 format)

List of the secret's tags.

Number of versions for this secret.

Updated description of the secret.

Returns true for secrets that are managed by another product.

Returns true for protected secrets that cannot be deleted.

Type of the secret. See the Secret.Type enum for a description of values.

Path of the secret. Location of the secret in the directory structure.

Ephemeral policy of the secret. (Optional.) Policy that defines whether/when a secret's versions expire. By default, the policy is applied to all the secret's versions.

List of Scaleway resources that can access and manage the secret.

Returns the time at which deletion was requested. (RFC 3339 format)

ID of the Scaleway Key Manager key. (Optional.) The Scaleway Key Manager key ID used to encrypt and decrypt secret versions. (UUID format)

Region of the secret.

Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1.

The SRN of the secret version.

ID of the secret. (UUID format)

Current status of the version.

• unknown_status: the version is in an invalid state.
• enabled: the version is accessible.
• disabled: the version is not accessible but can be enabled.
• scheduled_for_deletion: the version is scheduled for deletion. It will be deleted in 7 days.
• deleted: the version is permanently deleted. It is not possible to recover it.

Date and time of the version's creation. (RFC 3339 format)

Last update of the version. (RFC 3339 format)

Date and time of the version's deletion. (RFC 3339 format)

Description of the version.

Returns true if the version is the latest.

Properties of the ephemeral version. Returns the version's expiration date, whether it expires after being accessed once, and the action to perform (disable or delete) once the version expires.

Returns the time at which deletion was requested. (RFC 3339 format)

Region of the version.