Ctrlk
Sign UpGet a DemoContact Us
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tf Standard Backend

HTTP standard backend for Terraform

Show terraform state

get
Path parameters
orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: y8
projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: uo
workspacestringRequired

Workspace identifier

Example: workspace123
Query parameters
accountIdentifierstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: d
Responses
200

OK response.

application/json
string · binaryOptional
get/api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend?accountIdentifier=d HTTP/1.1
Host: localhost:80
Accept: */*

binary

Create terraform state

post
Path parameters
orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: wdz
projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: loa
workspacestringRequired

Workspace identifier

Example: workspace123
Query parameters
accountIdentifierstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: g0
IDstringOptional

If the backend is locked, this value must match the persisted terraform lock id.

Example: 1ac4b858-bf0b-8539-9d80-8c521f6423cf
Header parameters
Content-Lengthinteger · int64Optional

Size in bytes of the state.

Example: 1738329114368899000
Responses
200

OK response.

No content
post/api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend
POST /api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend?accountIdentifier=g0 HTTP/1.1
Host: localhost:80
Accept: */*

No content

Lock workspace

post
Path parameters
orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: az
projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: 6z
workspacestringRequired

Workspace identifier

Example: workspace123
Query parameters
accountIdentifierstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: c
Body
createdstringRequired

Time that the lock was taken.

Example: Atque nam possimus enim quo sit dolores.
idstring · min: 1Required

Unique ID for the lock. Generated by the terraform cli.

Example: 1ac4b858-bf0b-8539-9d80-8c521f6423cf
infostringOptional

Extra information to store with the lock.

Default: ""Example: production workspace lock
operationstringRequired

Terraform operation.

Example: OperationTypePlan
pathstringOptional

Path to the state file when applicable.

Default: ""Example: /api/orgs/org1/projects/proj1/workspaces/production/data/fcdf0196-f5b3-49ab-87e3-ff102dfaf58c
versionstringRequired

Terraform version.

Example: 1.0.0
whostringOptional

The machine user who is performing the operation.

Default: ""Example: user1
Responses
200

OK response.

application/json

Terraform lock information resource.

accountstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: 7t1
createdinteger · int64Required

Time that the lock was taken.

Example: 6484153978943259000
idstring · min: 1Required

Unique ID for the lock. Generated by the terraform cli.

Example: 1ac4b858-bf0b-8539-9d80-8c521f6423cf
infostringOptional

Extra information to store with the lock.

Default: ""Example: production workspace lock
locked_by_display_namestringOptional

Display name of who locked the workspace

Example: Placeat ad consectetur eius facere quam.
locked_by_principal_idstringOptional

Principal ID who created the manual lock

Example: Sunt consequatur.
locked_by_principal_typestringOptional

Type of principal: 'user' or 'service_account'

Example: Sint qui praesentium.
manualbooleanOptional

Whether the lock is manual (user-initiated). true = manual lock, false = automatic lock (Terraform CLI)

Default: falseExample: true
operationstringRequired

Terraform operation.

Example: OperationTypePlan
orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: kj
pathstringOptional

Path to the state file when applicable.

Default: ""Example: /api/orgs/org1/projects/proj1/workspaces/production/data/fcdf0196-f5b3-49ab-87e3-ff102dfaf58c
projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: yvc
reasonstringOptional

Reason for manual lock (optional, max 1024 chars)

Example: Voluptatem ut voluptas consequuntur amet.
versionstringRequired

Terraform version.

Example: 1.0.0
whostringOptional

The machine user who is performing the operation.

Default: ""Example: user1
workspacestringRequired

Workspace identifier

Example: workspace123
post/api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend/lock
POST /api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend/lock?accountIdentifier=c HTTP/1.1
Host: localhost:80
Content-Type: application/json
Accept: */*
Content-Length: 275

{
  "created": "Nihil modi aut.",
  "id": "1ac4b858-bf0b-8539-9d80-8c521f6423cf",
  "info": "production workspace lock",
  "operation": "OperationTypePlan",
  "path": "/api/orgs/org1/projects/proj1/workspaces/production/data/fcdf0196-f5b3-49ab-87e3-ff102dfaf58c",
  "version": "1.0.0",
  "who": "user1"
}
{
  "account": "z",
  "created": 5836349330442804000,
  "id": "1ac4b858-bf0b-8539-9d80-8c521f6423cf",
  "info": "production workspace lock",
  "locked_by_display_name": "Rerum molestias.",
  "locked_by_principal_id": "Et illo reiciendis inventore atque.",
  "locked_by_principal_type": "Molestiae ut totam sit corporis animi.",
  "manual": true,
  "operation": "OperationTypePlan",
  "org": "k",
  "path": "/api/orgs/org1/projects/proj1/workspaces/production/data/fcdf0196-f5b3-49ab-87e3-ff102dfaf58c",
  "project": "nr3",
  "reason": "Quibusdam quisquam.",
  "version": "1.0.0",
  "who": "user1",
  "workspace": "workspace123"
}

Unlock workspace

delete
Path parameters
orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: j
projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: xn6
workspacestringRequired

Workspace identifier

Example: workspace123
Query parameters
accountIdentifierstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: r
Body
createdstringRequired

Time that the lock was taken.

Example: Doloribus aut.
idstring · min: 1Required

Unique ID for the lock. Generated by the terraform cli.

Example: 1ac4b858-bf0b-8539-9d80-8c521f6423cf
infostringOptional

Extra information to store with the lock.

Default: ""Example: production workspace lock
operationstringRequired

Terraform operation.

Example: OperationTypePlan
pathstringOptional

Path to the state file when applicable.

Default: ""Example: /api/orgs/org1/projects/proj1/workspaces/production/data/fcdf0196-f5b3-49ab-87e3-ff102dfaf58c
versionstringRequired

Terraform version.

Example: 1.0.0
whostringOptional

The machine user who is performing the operation.

Default: ""Example: user1
Responses
200

OK response.

No content
delete/api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend/lock
DELETE /api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend/lock?accountIdentifier=r HTTP/1.1
Host: localhost:80
Content-Type: application/json
Accept: */*
Content-Length: 280

{
  "created": "Labore consequuntur.",
  "id": "1ac4b858-bf0b-8539-9d80-8c521f6423cf",
  "info": "production workspace lock",
  "operation": "OperationTypePlan",
  "path": "/api/orgs/org1/projects/proj1/workspaces/production/data/fcdf0196-f5b3-49ab-87e3-ff102dfaf58c",
  "version": "1.0.0",
  "who": "user1"
}
No content
PreviousSystem
NextUnified Executions

Last updated

Was this helpful?