# REST Resource: projects.secrets.versions

- [Resource: SecretVersion](https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion)
  - [JSON representation](https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion.SCHEMA_REPRESENTATION)
- [State](https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#State)
- [ReplicationStatus](https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#ReplicationStatus)
  - [JSON representation](https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#ReplicationStatus.SCHEMA_REPRESENTATION)
- [AutomaticStatus](https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#AutomaticStatus)
  - [JSON representation](https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#AutomaticStatus.SCHEMA_REPRESENTATION)
- [CustomerManagedEncryptionStatus](https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#CustomerManagedEncryptionStatus)
  - [JSON representation](https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#CustomerManagedEncryptionStatus.SCHEMA_REPRESENTATION)
- [UserManagedStatus](https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#UserManagedStatus)
  - [JSON representation](https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#UserManagedStatus.SCHEMA_REPRESENTATION)
- [ReplicaStatus](https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#ReplicaStatus)
  - [JSON representation](https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#ReplicaStatus.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#METHODS_SUMMARY)

## Resource: SecretVersion

A secret version resource in the Secret Manager API.

| JSON representation |
|---|
| ``` { "name": string, "createTime": string, "destroyTime": string, "state": enum (`https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#State`), "replicationStatus": { object (`https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#ReplicationStatus`) }, "etag": string, "clientSpecifiedPayloadChecksum": boolean } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. The resource name of the `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion` in the format `projects/*/secrets/*/versions/*`. `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion` IDs in a `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets#Secret` start at 1 and are incremented for each subsequent version of the secret. |
| `createTime` | ``string (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` format)`` Output only. The time at which the `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#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 (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` format)`` Output only. The time this `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion` was destroyed. Only present if `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion.FIELDS.state` is `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#State.ENUM_VALUES.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 (`https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#State`)`` Output only. The current state of the `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`. |
| `replicationStatus` | ``object (`https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#ReplicationStatus`)`` The replication status of the `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`. |
| `etag` | `string` Output only. Etag of the currently stored `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`. |
| `clientSpecifiedPayloadChecksum` | `boolean` Output only. True if payload checksum specified in `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/SecretPayload` object has been received by `SecretManagerService` on `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets/addVersion#google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion`. |

## State

The state of a `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`, indicating if it can be accessed.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Not specified. This value is unused and invalid. |
| `ENABLED` | The `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion` may be accessed. |
| `DISABLED` | The `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion` may not be accessed, but the secret data is still available and can be placed back into the `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#State.ENUM_VALUES.ENABLED` state. |
| `DESTROYED` | The `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion` is destroyed and the secret data is no longer stored. A version may not leave this state once entered. |

## ReplicationStatus

The replication status of a `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`.

| JSON representation |
|---|
| ``` { // Union field `replication_status` can be only one of the following: "automatic": { object (`https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#AutomaticStatus`) }, "userManaged": { object (`https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#UserManagedStatus`) } // End of list of possible types for union field `replication_status`. } ``` |

| Fields ||
|---|---|
| Union field `replication_status`. The replication status of the `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`. `replication_status` can be only one of the following: ||
| `automatic` | ``object (`https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#AutomaticStatus`)`` Describes the replication status of a `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion` with automatic replication. Only populated if the parent `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets#Secret` has an automatic replication policy. |
| `userManaged` | ``object (`https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#UserManagedStatus`)`` Describes the replication status of a `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion` with user-managed replication. Only populated if the parent `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets#Secret` has a user-managed replication policy. |

## AutomaticStatus

The replication status of a `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion` using automatic replication.

Only populated if the parent `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets#Secret` has an automatic replication policy.

| JSON representation |
|---|
| ``` { "customerManagedEncryption": { object (`https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#CustomerManagedEncryptionStatus`) } } ``` |

| Fields ||
|---|---|
| `customerManagedEncryption` | ``object (`https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#CustomerManagedEncryptionStatus`)`` Output only. The customer-managed encryption status of the `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`. Only populated if customer-managed encryption is used. |

## 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/*`. |

## UserManagedStatus

The replication status of a `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion` using user-managed replication.

Only populated if the parent `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets#Secret` has a user-managed replication policy.

| JSON representation |
|---|
| ``` { "replicas": [ { object (`https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#ReplicaStatus`) } ] } ``` |

| Fields ||
|---|---|
| `replicas[]` | ``object (`https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#ReplicaStatus`)`` Output only. The list of replica statuses for the `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`. |

## ReplicaStatus

Describes the status of a user-managed replica for the `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`.

| JSON representation |
|---|
| ``` { "location": string, "customerManagedEncryption": { object (`https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#CustomerManagedEncryptionStatus`) } } ``` |

| Fields ||
|---|---|
| `location` | `string` Output only. The canonical ID of the replica location. For example: `"us-east1"`. |
| `customerManagedEncryption` | ``object (`https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#CustomerManagedEncryptionStatus`)`` Output only. The customer-managed encryption status of the `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`. Only populated if customer-managed encryption is used. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions/access` | Accesses a `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`. |
| ### `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions/destroy` | Destroys a `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`. |
| ### `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions/disable` | Disables a `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`. |
| ### `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions/enable` | Enables a `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`. |
| ### `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions/get` | Gets metadata for a `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`. |
| ### `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions/list` | Lists `https://docs.cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets.versions#SecretVersion`. |