Type '/' to Search

»Admin Runs API

Terraform Enterprise feature: The admin API is exclusive to Terraform Enterprise, and can only be used by the admins and operators who install and maintain their organization's Terraform Enterprise instance.

These API endpoints are available in Terraform Enterprise as of version 201807-1.

The Runs Admin API contains endpoints to help site administrators manage runs.

»List all runs

GET /api/v2/admin/runs

This endpoint lists all runs in the Terraform Enterprise installation.

StatusResponseReason
200JSON API document (type: "runs")Successfully listed runs
404JSON API error objectClient is not an administrator.

»Query Parameters

These are standard URL query parameters. Remember to percent-encode [ as %5B and ] as %5D if your tooling doesn't automatically encode URLs.

ParameterDescription
qOptional. A search query string. Runs are searchable by ID, workspace name, organization name or email, and VCS repository identifier.
filter[status]Optional. A comma-separated list of Run statuses to restrict results to, which can include any of the following: "pending", "plan_queued", "planning", "planned", "confirmed", "apply_queued", "applying", "applied", "discarded", "errored", "canceled", "cost_estimating", "cost_estimated", "policy_checking", "policy_override", "policy_soft_failed", "policy_checked", and "planned_and_finished".
page[number]Optional. If omitted, the endpoint will return the first page.
page[size]Optional. If omitted, the endpoint will return 20 runs per page.

A VCS repository identifier is a reference to a VCS repository in the format :org/:repo, where :org and :repo refer to the organization (or project) and repository in your VCS provider.

»Available Related Resources

This GET endpoint can optionally return related resources, if requested with the include query parameter. The following resource types are available:

Resource NameDescription
workspaceThe workspace this run belongs in.
workspace.organizationThe organization of the associated workspace.

»Sample Request

curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  "https://app.terraform.io/api/v2/admin/runs"

curl \  --header "Authorization: Bearer $TOKEN" \  --header "Content-Type: application/vnd.api+json" \  "https://app.terraform.io/api/v2/admin/runs"

»Sample Response

{
  "data": [
    {
      "id": "run-VCsNJXa59eUza53R",
      "type": "runs",
      "attributes": {
        "status": "pending",
        "status-timestamps": {
          "planned-at": "2018-03-02T23:42:06+00:00",
          "discarded-at": "2018-03-02T23:42:06+00:00"
        },
        "has-changes": true,
        "created-at": "2018-03-02T23:42:06.651Z"
      },
      "relationships": {
        "workspace": {
          "data": {
            "id": "ws-mJtb6bXGybq5zbf3",
            "type": "workspaces"
          }
        }
      },
      "links": {
        "self": "/api/v2/runs/run-VCsNJXa59eUza53R"
      }
    }
  ],
  "links": {
    "self": "https://app.terraform.io/api/v2/admin/runs?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "first": "https://app.terraform.io/api/v2/admin/runs?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "prev": null,
    "next": null,
    "last": "https://app.terraform.io/api/v2/admin/runs?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  },
  "meta": {
    "pagination": {
      "current-page": 1,
      "prev-page": null,
      "next-page": null,
      "total-pages": 1,
      "total-count": 1
    },
    "status-counts": {
      "pending": 1,
      "planning": 0,
      "planned": 0,
      "confirmed": 0,
      "applying": 0,
      "applied": 0,
      "discarded": 0,
      "errored": 0,
      "canceled": 0,
      "policy-checking": 0,
      "policy-override": 0,
      "policy-checked": 0,
      "total": 1
    }
  }
}

{  "data": [    {      "id": "run-VCsNJXa59eUza53R",      "type": "runs",      "attributes": {        "status": "pending",        "status-timestamps": {          "planned-at": "2018-03-02T23:42:06+00:00",          "discarded-at": "2018-03-02T23:42:06+00:00"        },        "has-changes": true,        "created-at": "2018-03-02T23:42:06.651Z"      },      "relationships": {        "workspace": {          "data": {            "id": "ws-mJtb6bXGybq5zbf3",            "type": "workspaces"          }        }      },      "links": {        "self": "/api/v2/runs/run-VCsNJXa59eUza53R"      }    }  ],  "links": {    "self": "https://app.terraform.io/api/v2/admin/runs?page%5Bnumber%5D=1&page%5Bsize%5D=20",    "first": "https://app.terraform.io/api/v2/admin/runs?page%5Bnumber%5D=1&page%5Bsize%5D=20",    "prev": null,    "next": null,    "last": "https://app.terraform.io/api/v2/admin/runs?page%5Bnumber%5D=1&page%5Bsize%5D=20"  },  "meta": {    "pagination": {      "current-page": 1,      "prev-page": null,      "next-page": null,      "total-pages": 1,      "total-count": 1    },    "status-counts": {      "pending": 1,      "planning": 0,      "planned": 0,      "confirmed": 0,      "applying": 0,      "applied": 0,      "discarded": 0,      "errored": 0,      "canceled": 0,      "policy-checking": 0,      "policy-override": 0,      "policy-checked": 0,      "total": 1    }  }}

»Force a run into the "cancelled" state

POST /admin/runs/:id/actions/force-cancel

ParameterDescription
:idThe ID of the run to cancel.

This endpoint forces a run (and its plan/apply, if applicable) into the "canceled" state. This action should only be performed for runs that are stuck and no longer progressing normally, as there is a risk of lost state data if a progressing apply is force-canceled. Healthy runs can be requested for cancellation by end-users.

StatusResponseReason
200JSON API document (type: "runs")Successfully canceled the run.
404JSON API error objectRun not found, or client is not an administrator.

»Request body

This POST endpoint allows an optional JSON object with the following properties as a request payload.

Key pathTypeDefaultDescription
commentstringnullAn optional explanation for why the run was force-canceled.

»Sample Payload

{
  "comment": "This run was stuck and would never finish."
}

{  "comment": "This run was stuck and would never finish."}

»Sample Request

curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  --request POST \
  --data @payload.json \
  "https://app.terraform.io/api/v2/admin/runs/run-VCsNJXa59eUza53R/actions/force-cancel"

curl \  --header "Authorization: Bearer $TOKEN" \  --header "Content-Type: application/vnd.api+json" \  --request POST \  --data @payload.json \  "https://app.terraform.io/api/v2/admin/runs/run-VCsNJXa59eUza53R/actions/force-cancel"

»Sample Response

{
  "data": {
    "id": "run-VCsNJXa59eUza53R",
    "type": "runs",
    "attributes": {
      "status": "errored",
      "status-timestamps": {
        "planned-at": "2018-03-02T23:42:06Z"
      },
      "has-changes": true,
      "created-at": "2018-03-02T23:42:06.651Z"
    },
    "relationships": {
      "workspace": {
        "data": {
          "id": "ws-mJtb6bXGybq5zbf3",
          "type": "workspaces"
        }
      }
    },
    "links": {
      "self": "/api/v2/runs/run-VCsNJXa59eUza53R"
    }
  }
}

{  "data": {    "id": "run-VCsNJXa59eUza53R",    "type": "runs",    "attributes": {      "status": "errored",      "status-timestamps": {        "planned-at": "2018-03-02T23:42:06Z"      },      "has-changes": true,      "created-at": "2018-03-02T23:42:06.651Z"    },    "relationships": {      "workspace": {        "data": {          "id": "ws-mJtb6bXGybq5zbf3",          "type": "workspaces"        }      }    },    "links": {      "self": "/api/v2/runs/run-VCsNJXa59eUza53R"    }  }}