Skip to content
forgit api docs

Lock a Terraform state

POST
/api/v4/projects/{id}/terraform/state/{name}/lock

Locks a Terraform state for a specified project.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
One of:
string

The ID or URL-encoded path of the project

name
required
string

The name of a Terraform state

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
ID
required

Terraform state lock ID

string
nullable <= 255 characters
Operation
required

Terraform operation

string
nullable
Info
required

Terraform info

string
nullable
Who
required

Terraform state lock owner

string
nullable
Version
required

Terraform version

string
nullable
Created
required

Terraform state lock timestamp

string
nullable
Path
required

Terraform path

string
nullable
Examplegenerated
{
  "ID": "example",
  "Operation": "example",
  "Info": "example",
  "Who": "example",
  "Version": "example",
  "Created": "example",
  "Path": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

400

Section titled “400”

Bad Request

403

Section titled “403”

Forbidden

404

Section titled “404”

Not found

409

Section titled “409”

Conflict

422

Section titled “422”

Validation failure