Skip to content
forgit api docs

Get a Terraform state by its name

GET
/api/v4/projects/{id}/terraform/state/{name}

Get a Terraform state by its name

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

Query Parameters

Section titled “ Query Parameters ”
ID
string
nullable <= 255 characters

Terraform state lock ID

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

204

Section titled “ 204 ”

Empty state

400

Section titled “ 400 ”

Bad Request

403

Section titled “ 403 ”

Forbidden

404

Section titled “ 404 ”

Not found

422

Section titled “ 422 ”

Validation failure