REST Resource: projects.locations.secrets.versions

Resource: SecretVersion

A secret version resource in the Secret Manager API.

JSON representation 
{
  "name": string,
  "createTime": string,
  "destroyTime": string,
  "state": enum (State),
  "etag": string,
  "clientSpecifiedPayloadChecksum": boolean,
  "scheduledDestroyTime": string,
  "customerManagedEncryption": {
    object (CustomerManagedEncryptionStatus)
  }
}
Fields
name

string

Output only. The resource name of the SecretVersion in the format projects/*/locations/*/secrets/*/versions/*.

SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
createTime

string (Timestamp format)

Output only. The time at which the SecretVersion was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
destroyTime

string (Timestamp format)

Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Output only. The current state of the SecretVersion.
etag

string

Output only. Etag of the currently stored SecretVersion.
clientSpecifiedPayloadChecksum

boolean

Output only. True if payload checksum specified in SecretPayload object has been received by SecretManagerService on SecretManagerService.AddSecretVersion.
scheduledDestroyTime

string (Timestamp format)

Optional. Output only. Scheduled destroy time for secret version. This is a part of the Delayed secret version destroy feature. For a Secret with a valid version destroy TTL, when a secert version is destroyed, version is moved to disabled state and it is scheduled for destruction Version is destroyed only after the scheduledDestroyTime.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
customerManagedEncryption

object (CustomerManagedEncryptionStatus)

Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a regionalized secret.

State

The state of a SecretVersion, indicating if it can be accessed.

Enums
STATE_UNSPECIFIED Not specified. This value is unused and invalid.
ENABLED The SecretVersion may be accessed.
DISABLED The SecretVersion may not be accessed, but the secret data is still available and can be placed back into the ENABLED state.
DESTROYED The SecretVersion is destroyed and the secret data is no longer stored. A version may not leave this state once entered.

CustomerManagedEncryptionStatus

Describes the status of customer-managed encryption.

JSON representation 
{
  "kmsKeyVersionName": string
}
Fields
kmsKeyVersionName

string

Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*.

Methods

access

 Accesses a SecretVersion.

destroy

 Destroys a SecretVersion.

disable

 Disables a SecretVersion.

enable

 Enables a SecretVersion.

get

 Gets metadata for a SecretVersion.

list

 Lists SecretVersions.