Method: projects.secrets.versions.disable

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 must be empty.

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.

Try it!