tf-standard-backend

HTTP standard backend for Terraform

pull-terraform-state tf-standard-backend

Securityx-api-key
Request
path Parameters
org
required
string [ 1 .. 128 ] characters

Org is the organisation identifier.

Example: ro
project
required
string [ 1 .. 128 ] characters

Project is the project identifier.

Example: k
workspace
required
string

Workspace identifier

Example: workspace123
query Parameters
accountIdentifier
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: accountIdentifier=oq
Responses
200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend
Request samples
Response samples
application/json
"string"

push-terraform-state tf-standard-backend

Securityx-api-key
Request
path Parameters
org
required
string [ 1 .. 128 ] characters

Org is the organisation identifier.

Example: y
project
required
string [ 1 .. 128 ] characters

Project is the project identifier.

Example: 0
workspace
required
string

Workspace identifier

Example: workspace123
query Parameters
accountIdentifier
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: accountIdentifier=85
ID
string

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

Example: ID=1ac4b858-bf0b-8539-9d80-8c521f6423cf
Responses
200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

post/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend
Request samples

unlock-workspace tf-standard-backend

Securityx-api-key
Request
path Parameters
org
required
string [ 1 .. 128 ] characters

Org is the organisation identifier.

Example: p
project
required
string [ 1 .. 128 ] characters

Project is the project identifier.

Example: etw
workspace
required
string

Workspace identifier

Example: workspace123
query Parameters
accountIdentifier
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: accountIdentifier=asm
Request Body schema: application/json
required
created
required
string

Time that the lock was taken.

id
required
string non-empty

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

info
string
Default: ""

Extra information to store with the lock.

operation
required
string

Terraform operation.

path
string
Default: ""

Path to the state file when applicable.

version
required
string

Terraform version.

who
string
Default: ""

The machine user who is performing the operation.

Responses
200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

delete/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend/lock
Request samples
application/json
{
  • "created": "2023-07-03T20:16:18.382839Z",
  • "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"
}

lock-workspace tf-standard-backend

Securityx-api-key
Request
path Parameters
org
required
string [ 1 .. 128 ] characters

Org is the organisation identifier.

Example: kyw
project
required
string [ 1 .. 128 ] characters

Project is the project identifier.

Example: 0f
workspace
required
string

Workspace identifier

Example: workspace123
query Parameters
accountIdentifier
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: accountIdentifier=6
Request Body schema: application/json
required
created
required
string

Time that the lock was taken.

id
required
string non-empty

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

info
string
Default: ""

Extra information to store with the lock.

operation
required
string

Terraform operation.

path
string
Default: ""

Path to the state file when applicable.

version
required
string

Terraform version.

who
string
Default: ""

The machine user who is performing the operation.

Responses
200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

post/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend/lock
Request samples
application/json
{
  • "created": "2023-07-03T20:16:18.382839Z",
  • "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"
}
Response samples
application/json
{
  • "account": "xd",
  • "created": "2023-07-03T20:16:18.382839Z",
  • "id": "1ac4b858-bf0b-8539-9d80-8c521f6423cf",
  • "info": "production workspace lock",
  • "operation": "OperationTypePlan",
  • "org": "i",
  • "path": "/api/orgs/org1/projects/proj1/workspaces/production/data/fcdf0196-f5b3-49ab-87e3-ff102dfaf58c",
  • "project": "6e",
  • "version": "1.0.0",
  • "who": "user1",
  • "workspace": "workspace123"
}