- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.
HTTP request
POST https://config.googleapis.com/v1/{parent=projects/*/locations/*/deployments/*}:importState
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{projectId}/locations/{location}/deployments/{deployment}'. It takes the form |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "lockId": string } |
Fields | |
---|---|
lock |
Required. Lock ID of the lock file to verify that the user who is importing the state file previously locked the Deployment. |
Response body
If successful, the response body contains an instance of Statefile
.
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 parent
resource:
config.googleapis.com/config.deployments.updateState
For more information, see the IAM documentation.