Method: projects.locations.deployments.deleteState

• HTTP request
• Path parameters
• Request body
  • JSON representation
• Response body
• Authorization scopes
• IAM Permissions
• Try it!

Deletes Terraform state file in a given deployment.

HTTP request

POST https://config.googleapis.com/v1/{name=projects/*/locations/*/deployments/*}:deleteState

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name	string Required. The name of the deployment in the format: 'projects/{projectId}/locations/{location}/deployments/{deployment}'.

Request body

The request body contains data with the following structure:

JSON representation
{ "lockId": string }

Fields
lockId	string (int64 format) Required. Lock ID of the lock file to verify that the user who is deleting the state file previously locked the Deployment.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

• config.googleapis.com/config.deployments.deleteState

For more information, see the IAM documentation.