Method: projects.secrets.versions.disable

HTTP request
Path parameters
Request body
- JSON representation
Response body
Authorization Scopes
Try it!

Disables a SecretVersion .

Sets the state of the SecretVersion to DISABLED .

HTTP request

POST https://secretmanager.googleapis.com/v1/{name=projects/*/secrets/*/versions/*}:disable

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

name

string

Required. The resource name of the SecretVersion to disable in the format projects/*/secrets/*/versions/* .

Authorization requires the following IAM permission on the specified resource name :

secretmanager.secrets.disable

Request body

The request body contains data with the following structure:

JSON representation
{ "etag" : string }

Fields

Fields
`etag`	`string` Optional. Etag of the `SecretVersion` . The request succeeds if it matches the etag of the currently stored secret version object. If the etag is omitted, the request succeeds.

etag

string

Optional. Etag of the SecretVersion . The request succeeds if it matches the etag of the currently stored secret version object. If the etag is omitted, the request succeeds.

Response body

If successful, the response body contains an instance of SecretVersion .

Authorization Scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .