--- updatedAt: 2026-05-28T08:16:45.000Z agentTools: projectIndex: https://docs.scalr.io/llms.txt --- # List Runs Queue This endpoint lists Runs Queue on allowed scopes. # OpenAPI definition ```json { "components": { "schemas": { "Run": { "description": "A Run provides details of an entire run operation potentially comprising `plan`, `cost-estimation`,\n`policy-check` and `apply`.", "properties": { "attributes": { "properties": { "actor": { "description": "The category of the principal that created the run, determined by Scalr from the\nrequest credentials and client headers. The identity itself is the `created-by`\nrelationship.", "enum": [ "unknown", "user", "service-account", "ai-agent", "scalr-system" ], "readOnly": true, "type": "string" }, "apply-at": { "description": "The UTC datetime at which the Apply should be queued.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "auto-apply": { "description": "Indicates whether `terraform apply` should automatically run\nwhen terraform plan ends without error.\nDefaults to the current Auto Apply setting in the workspace.\n\nAuto-apply will be disallowed as a safety restriction if the\nworkspace's current state version originates from an open Pull Request\nand the branch of this Pull Request is different from the branch of the\nrun's configuration version. This prevents automatic applies when\nthe current state is potentially based on unmerged code.", "type": "boolean" }, "created-at": { "description": "The resource creation timestamp.", "format": "date-time", "readOnly": true, "type": "string" }, "error-message": { "description": "Contains error message, when the run has finished in `errored` status.", "nullable": true, "readOnly": true, "type": "string" }, "has-changes": { "description": "Specifies whether the plan has proposed resource changes.", "readOnly": true, "type": "boolean" }, "iac-platform": { "default": "terraform", "description": "The IaC platform for the run.", "enum": [ "terraform", "opentofu" ], "readOnly": true, "type": "string" }, "inputs": { "description": "Terraform input variables that were passed into the workspace.", "items": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "sensitive": { "type": "boolean" }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "items": {}, "type": "array" }, { "type": "object" } ], "nullable": true } }, "type": "object" }, "nullable": true, "type": "array" }, "is-destroy": { "description": "Indicates if this run is a destroy that will destroy all provisioned infrastructure\nin the current state.", "type": "boolean" }, "is-dry": { "type": "boolean" }, "message": { "description": "Specifies the explanation message to associate with the run.", "maxLength": 512, "nullable": true, "type": "string" }, "permissions": { "readOnly": true, "type": "object" }, "plan-at": { "description": "The UTC datetime at which the Plan should be queued.", "format": "date-time", "nullable": true, "type": "string" }, "position-in-queue": { "nullable": true, "readOnly": true, "type": "integer" }, "refresh": { "description": "Specifies whether or not to refresh the state before a plan.", "nullable": true, "type": "boolean" }, "refresh-only": { "description": "Specifies whether this run should use the refresh-only plan mode.", "nullable": true, "type": "boolean" }, "replace-addrs": { "description": "Specifies an optional list of resource addresses to force replacement of a particular resource. If the plan would've normally produced an update or no-op action for this instance, Terraform will plan to replace it instead.", "items": { "maxLength": 262143, "type": "string" }, "nullable": true, "type": "array" }, "save-plan": { "description": "The run is a saved plan run that stops at planned_and_saved status.", "nullable": true, "type": "boolean" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/Sources" }, { "type": "string" } ], "description": "The origin of the run." }, "status": { "description": "The Run's current status.\n\nInitial status:\n* `pending` - The initial status of a run once it has been created. Scalr processes each workspace's\nruns in the order they were queued, and a run remains pending until every run before it has completed.\nThe exception are Runs having `is-dry: true`. Such runs don't modify a workspace's state, and could\nrun in a parallel until the account's runs quota limit.\n\nPlan stage:\n* `plan_queued` - The plan is queued and waiting for capacity/and or quota to be available.\n* `planning` - Scalr is currently running `terraform plan`.\n* `planned` - `terraform plan` has finished. Scalr proceeds to any configured post-plan,\ncost-estimate, or policy-check stage. If no later stage remains and apply requires manual\napproval, the run waits in this state for confirmation.\n* `planned_and_saved` - `terraform plan` has finished and the run waits for apply with the saved plan to be confirmed.\n* `confirmed` - Run has been confirmed to apply.\n\nPost-plan run tasks stage (optional):\n* `post_plan_running` - Scalr is currently executing the post-plan run tasks (e.g. the Wiz scan).\n* `post_plan_finished` - The post-plan run tasks have finished. Scalr proceeds to cost\nestimation or policy checks when configured. Otherwise, an apply that requires manual\napproval waits in this state for confirmation.\n\nCost estimate stage (optional):\n* `cost_estimating` - Scalr is currently calculating the cost estimate for the plan.\n* `cost_estimated` - The cost estimation stage has finished.\n\nPolicy check stage (optional):\n* `policy_checking` - Scalr is currently checking the plan against the environment's policies.\n* `policy_checked` - The policy check succeeded, and Policy Engine will allow an apply to proceed.\nScalr sometimes pauses in this state, depending on workspace settings.\n* `policy_override` - The policy check finished, but at least one `soft-mandatory` policy failed, so an\napply cannot proceed without approval from a user having `policy-checks:override` permission.\nThe run pauses in this state.\n\nApply stage:\n* `apply_queued` - The apply is queued and waiting for capacity/and or quota to be available.\n* `applying` - Scalr is currently running `terraform apply`.\n* `applied` - Scalr has successfully finished applying.\n\nEnding statuses:\n* `planned_and_finished` - The plan pipeline and all configured post-plan stages have\nfinished, and no apply is required. This is the final state for plan-only runs and runs\nwithout changes.\n* `planned_and_saved` - Saved plan run's plan has finished and is awaiting confirmation.\nThe plan can be applied later using UI/API or terraform apply with the saved plan file.\n* `errored` - The run has finished with an error. The attribute `error-message` has the details.\n* `discarded` - A user chose not to continue this run from a confirmation state\n* `canceled` - A user interrupted the run from any active stage.", "enum": [ "pending", "pre_plan_queued", "pre_plan_running", "pre_plan_finished", "plan_queued", "planning", "planned", "confirmed", "discarded", "planned_and_finished", "planned_and_saved", "post_plan_running", "post_plan_finished", "cost_estimating", "cost_estimated", "policy_checking", "policy_override", "policy_checked", "pre_apply_queued", "pre_apply_running", "pre_apply_finished", "apply_queued", "applying", "applied", "post_apply_running", "post_apply_finished", "errored", "canceled" ], "readOnly": true, "type": "string" }, "status-timestamps": { "additionalProperties": { "format": "date-time", "type": "string" }, "description": "Timestamps of transition to prior and current statuses.", "readOnly": true, "type": "object" }, "target-addrs": { "description": "If non-empty, requests that Terraform should create a plan including actions only for the given objects (specified using resource address syntax) and the objects they depend on.", "items": { "maxLength": 262143, "type": "string" }, "nullable": true, "type": "array" }, "variables": { "default": [], "description": "Run scope variables.", "items": { "properties": { "category": { "description": "* `terraform` - Values to be passed to terraform input variables of the same name.\n* `env` - shell environment variables. They will be injected via `export` during a terraform run.", "enum": [ "terraform", "shell", "env" ], "type": "string" }, "hcl": { "default": false, "description": "Indicates whether the value of the variable is a string of HCL code.", "type": "boolean" }, "key": { "description": "Variable name. Must correspond to the name of a Terraform input variable in the configuration\nif category is terraform.", "maxLength": 128, "type": "string" }, "sensitive": { "default": false, "description": "Indicates whether the value is sensitive. When set to `true` then the variable is not visible\nafter being written.", "type": "boolean" }, "value": { "default": "", "description": "Variable value. Not visible if sensitive: true is enabled", "maxLength": 65535, "nullable": true, "type": "string" } }, "required": [ "key", "category" ], "type": "object" }, "nullable": true, "type": "array" } }, "type": "object" }, "id": { "readOnly": true, "type": "string" }, "links": { "properties": { "self": { "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object" }, "relationships": { "properties": { "apply": { "description": "Terraform apply phase.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "applies", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "readOnly": true, "required": [ "data" ], "type": "object" }, "configuration-version": { "description": "The Run's configuration version.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "configuration-versions", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "cost-estimate": { "description": "Cost estimation phase.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "cost-estimates", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "readOnly": true, "required": [ "data" ], "type": "object" }, "created-by": { "description": "User that has triggered the run.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "users", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "readOnly": true, "required": [ "data" ], "type": "object" }, "created-by-run": { "description": "Upstream Run that has triggered this run.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "runs", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "environment": { "description": "The environment this run Run belongs to.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "environments", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "readOnly": true, "required": [ "data" ], "type": "object" }, "plan": { "description": "Terraform plan phase.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "plans", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "readOnly": true, "required": [ "data" ], "type": "object" }, "policy-checks": { "description": "Policy check phase.", "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "policy-checks", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "nullable": true, "type": "array" } }, "readOnly": true, "required": [ "data" ], "type": "object" }, "state-versions": { "description": "The run's state versions.", "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "state-versions", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "nullable": true, "type": "array" } }, "readOnly": true, "required": [ "data" ], "type": "object" }, "status-transitions": { "description": "Date/Time of transition to each status that has occurred.", "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "status-transitions", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "nullable": true, "type": "array" } }, "readOnly": true, "required": [ "data" ], "type": "object" }, "tags": { "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "tags", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "nullable": true, "type": "array" } }, "readOnly": true, "required": [ "data" ], "type": "object" }, "vcs-revision": { "description": "Relation to the Git commit information, when the run's `configuration-version` source is `vcs`", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "vcs-revisions", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "readOnly": true, "required": [ "data" ], "type": "object" }, "workspace": { "description": "The workspace this Run belongs to.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "workspaces", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "enum": [ "runs" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "RunListingDocument": { "description": "JSON:API Document Listing\n\nsee: https://jsonapi.org/format/#document-structure", "properties": { "data": { "items": { "$ref": "#/components/schemas/Run" }, "type": "array" }, "included": { "items": { "type": "object" }, "readOnly": true, "type": "array" }, "links": { "additionalProperties": { "type": "string" }, "readOnly": true, "type": "object" }, "meta": { "readOnly": true, "type": "object" } }, "type": "object" }, "Sources": { "enum": [ "api", "cli", "scalr-cli", "configuration-version", "service-catalog", "ui", "vcs", "vcs-task", "run-trigger", "schedule", "restart", "restart-ci", "assistant", "dashboard-run", "dashboard-workspace", "workspaces-environment", "workspaces-environment-bulk", "workspaces-account", "workspaces-account-bulk", "reports-iac-versions", "reports-stale-workspaces", "auto-destroy", "comment-github", "comment-azure", "comment-gitlab", "check-github", "vscode", "drift-detection", "mcp" ], "type": "string" } }, "securitySchemes": { "API-Key": { "scheme": "bearer", "type": "http" } } }, "info": { "description": "Scalr IACP API", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "title": "Scalr IACP API", "version": "unversioned" }, "openapi": "3.0.0", "paths": { "/runs": { "get": { "description": "This endpoint lists runs for a specific workspace.", "operationId": "get_runs", "parameters": [ { "description": "Page number", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "string" } }, { "description": "Page size", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "string" } }, { "description": "The comma-separated list of relationship paths.", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "apply", "configuration-version", "cost-estimate", "created-by", "created-by-run", "environment", "plan", "policy-checks", "status-transitions", "tags", "vcs-revision", "workspace" ], "type": "string" }, "type": "array" } }, { "description": "The workspace ID to list runs for.", "in": "query", "name": "filter[workspace]", "required": false, "schema": { "type": "string" } }, { "description": "The account ID to list runs for.", "in": "query", "name": "filter[account]", "required": false, "schema": { "type": "string" } }, { "description": "The environment ID to list runs for.", "in": "query", "name": "filter[environment]", "required": false, "schema": { "type": "string" } }, { "description": "The comma-separated list of run IDs.", "in": "query", "name": "filter[run]", "required": false, "schema": { "type": "string" } }, { "description": "The run status filter.", "in": "query", "name": "filter[status]", "required": false, "schema": { "type": "string" } }, { "description": "The run source filter.", "in": "query", "name": "filter[source]", "required": false, "schema": { "type": "string" } }, { "description": "Filter runs by who created them, e.g. `in:ai-agent,service-account`.", "in": "query", "name": "filter[actor]", "required": false, "schema": { "type": "string" } }, { "description": "Commit sha that affected runs", "in": "query", "name": "filter[vcs-revision]", "required": false, "schema": { "type": "string" } }, { "description": "The ID of the User who triggered this run", "in": "query", "name": "filter[created-by]", "required": false, "schema": { "type": "string" } }, { "description": "The ID of the Run which triggered this run", "in": "query", "name": "filter[created-by-run]", "required": false, "schema": { "type": "string" } }, { "description": "The list of environment or workspaces IDs to match", "in": "query", "name": "filter[env-or-ws]", "required": false, "schema": { "type": "string" } }, { "description": "The run created at filter.", "in": "query", "name": "filter[created-at]", "required": false, "schema": { "type": "string" } }, { "description": "Query string", "in": "query", "name": "query", "required": false, "schema": { "type": "string" } }, { "description": "The is dry runs filter.", "in": "query", "name": "filter[is-dry]", "required": false, "schema": { "type": "string" } }, { "description": "List only runs that are scheduled.", "in": "query", "name": "scheduled", "required": false, "schema": { "type": "string" } }, { "description": "Filter runs by tags.", "in": "query", "name": "filter[tag]", "required": false, "schema": { "type": "string" } }, { "description": "Filter the runs by drifted resources count.", "in": "query", "name": "filter[resource-drifts]", "required": false, "schema": { "type": "string" } }, { "description": "The value of the fields[resource-type] parameter is a comma-separated list that refers to the name of the fields to be returned for the resource. An empty value indicates that no fields should be returned.", "explode": true, "in": "query", "name": "fields", "required": false, "schema": { "properties": { "applies": { "description": "The comma-separated list of fields to return in response for Apply resource.", "type": "string" }, "configuration-versions": { "description": "The comma-separated list of fields to return in response for ConfigurationVersion resource.", "type": "string" }, "cost-estimates": { "description": "The comma-separated list of fields to return in response for CostEstimate resource.", "type": "string" }, "environments": { "description": "The comma-separated list of fields to return in response for Environment resource.", "type": "string" }, "plans": { "description": "The comma-separated list of fields to return in response for Plan resource.", "type": "string" }, "policy-checks": { "description": "The comma-separated list of fields to return in response for PolicyCheck resource.", "type": "string" }, "runs": { "description": "The comma-separated list of fields to return in response for Run resource.", "type": "string" }, "status-transitions": { "description": "The comma-separated list of fields to return in response for StatusTransition resource.", "type": "string" }, "tags": { "description": "The comma-separated list of fields to return in response for Tag resource.", "type": "string" }, "users": { "description": "The comma-separated list of fields to return in response for User resource.", "type": "string" }, "vcs-revisions": { "description": "The comma-separated list of fields to return in response for VcsRevision resource.", "type": "string" }, "workspaces": { "description": "The comma-separated list of fields to return in response for Workspace resource.", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "examples": { "default": { "value": "{\n \"data\": [\n {\n \"attributes\": {\n \"created-at\": \"2020-11-06T16:42:18Z\",\n \"error-message\": null,\n \"has-changes\": true,\n \"inputs\": [\n {\n \"description\": \"The branch or revision of the scalr repository to pull changes from.\",\n \"name\": \"revision\",\n \"sensitive\": false,\n \"value\": \"master\"\n },\n {\n \"description\": \"The machine type of the Scalr node\",\n \"name\": \"machine_type\",\n \"sensitive\": false,\n \"value\": \"n1-standard-2\"\n }\n ],\n \"is-destroy\": false,\n \"message\": \"Deploy test environment to work on CORE-17409\",\n \"position-in-queue\": null,\n \"source\": \"ui\",\n \"actor\": \"user\",\n \"status\": \"applied\",\n \"status-timestamps\": {\n \"applied-at\": \"2020-11-06T16:44:23Z\",\n \"apply-queued-at\": \"2020-11-06T16:43:00Z\",\n \"applying-at\": \"2020-11-06T16:43:01Z\",\n \"confirmed-at\": \"2020-11-06T16:43:00Z\",\n \"cost-estimated-at\": \"2020-11-06T16:42:55Z\",\n \"cost-estimating-at\": \"2020-11-06T16:42:54Z\",\n \"plan-queueable-at\": \"2020-11-06T16:42:18Z\",\n \"plan-queued-at\": \"2020-11-06T16:42:19Z\",\n \"planned-at\": \"2020-11-06T16:42:53Z\",\n \"planning-at\": \"2020-11-06T16:42:19Z\",\n \"policy-checked-at\": \"2020-11-06T16:42:56Z\",\n \"policy-checking-at\": \"2020-11-06T16:42:55Z\"\n }\n },\n \"id\": \"run-t61gbtqgg8553h8\",\n \"links\": {\n \"self\": \"https://my.scalr.io/api/iacp/v3/runs/run-t61gbtqgg8553h8\"\n },\n \"relationships\": {\n \"apply\": {\n \"data\": {\n \"id\": \"apply-t61gbtquugkhm40\",\n \"type\": \"applies\"\n }\n },\n \"configuration-version\": {\n \"data\": {\n \"id\": \"cv-t61g5phg8e4f49o\",\n \"type\": \"configuration-versions\"\n }\n },\n \"cost-estimate\": {\n \"data\": {\n \"id\": \"ce-t61gbtr3grklu2g\",\n \"type\": \"cost-estimates\"\n }\n },\n \"created-by\": {\n \"data\": {\n \"id\": \"user-stp8qjfonavseg0\",\n \"type\": \"users\"\n }\n },\n \"plan\": {\n \"data\": {\n \"id\": \"plan-t61gbtqutu417p0\",\n \"type\": \"plans\"\n }\n },\n \"policy-checks\": {\n \"data\": [\n {\n \"id\": \"pchk-t61gbtus33m5eu8\",\n \"type\": \"policy-checks\"\n }\n ]\n },\n \"status-transitions\": {\n \"data\": [\n {\n \"id\": \"23a18e19-23f2-64ec-9f10-f0dbf8e26a7b\",\n \"type\": \"status-transitions\"\n },\n {\n \"id\": \"23a18e19-7773-64f4-681c-ffe2004fec87\",\n \"type\": \"status-transitions\"\n },\n {\n \"id\": \"23a18e19-8635-617c-ea8d-d30a826a50e5\",\n \"type\": \"status-transitions\"\n },\n {\n \"id\": \"23a18e26-19b6-673c-64ea-4cb71181b9f6\",\n \"type\": \"status-transitions\"\n },\n {\n \"id\": \"23a18e26-614d-6618-9c16-e88f9aa13a7c\",\n \"type\": \"status-transitions\"\n },\n {\n \"id\": \"23a18e26-afc6-67e0-e8b3-f9401c85c7b3\",\n \"type\": \"status-transitions\"\n },\n {\n \"id\": \"23a18e26-b111-65a0-dc08-39a9dec9301a\",\n \"type\": \"status-transitions\"\n },\n {\n \"id\": \"23a18e27-2b5e-6560-a187-65e87a51859c\",\n \"type\": \"status-transitions\"\n },\n {\n \"id\": \"23a18e28-d12d-6904-5ce7-f83e7125a812\",\n \"type\": \"status-transitions\"\n },\n {\n \"id\": \"23a18e28-d73b-6454-83af-59e8ceda6f65\",\n \"type\": \"status-transitions\"\n },\n {\n \"id\": \"23a18e28-e309-6510-dfbd-33d68862ddf0\",\n \"type\": \"status-transitions\"\n },\n {\n \"id\": \"23a18e47-aa61-6284-bc8e-9ee876c9bbc9\",\n \"type\": \"status-transitions\"\n }\n ]\n },\n \"vcs-revision\": {\n \"data\": {\n \"id\": \"vrb-t61g5pftks1ibl0\",\n \"type\": \"vcs-revisions\"\n }\n },\n \"workspace\": {\n \"data\": {\n \"id\": \"ws-t61fnk5nffoujpg\",\n \"type\": \"workspaces\"\n }\n }\n },\n \"type\": \"runs\"\n },\n {\"...\": \"...\"}\n ],\n \"included\": null,\n \"links\": {\n \"first\": \"https://my.scalr.io/api/iacp/v3/runs?filter%5Bworkspace%5D=ws-t61fnk5nffoujpg?page%5Bnumber%5D=1&page%5Bsize%5D=20\",\n \"last\": \"https://my.scalr.io/api/iacp/v3/runs?filter%5Bworkspace%5D=ws-t61fnk5nffoujpg?page%5Bnumber%5D=1&page%5Bsize%5D=20\",\n \"next\": null,\n \"prev\": null,\n \"self\": \"https://my.scalr.io/api/iacp/v3/runs?filter%5Bworkspace%5D=ws-t61fnk5nffoujpg?page%5Bnumber%5D=1&page%5Bsize%5D=20\"\n },\n \"meta\": {\n \"pagination\": {\n \"current-page\": 1,\n \"next-page\": null,\n \"prev-page\": null,\n \"total-count\": 4,\n \"total-pages\": 1\n }\n }\n}" } }, "schema": { "$ref": "#/components/schemas/RunListingDocument" } } }, "description": "Success." }, "404": { "description": "Workspace not found, or user unauthorized to perform action." }, "4XX": { "description": "Client error." }, "5XX": { "description": "Server error." } }, "summary": "List Runs", "tags": [ "runs" ], "x-mcp-tool": true, "x-resource": "Run", "x-service": "tf-api" } }, "/runs-queue": { "get": { "description": "This endpoint lists Runs Queue on allowed scopes.\n", "operationId": "get_runs_queue", "parameters": [ { "description": "Page number", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "string" } }, { "description": "Page size", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "string" } }, { "description": "The comma-separated list of relationship paths.", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "apply", "configuration-version", "cost-estimate", "created-by", "created-by-run", "environment", "plan", "policy-checks", "status-transitions", "tags", "vcs-revision", "workspace" ], "type": "string" }, "type": "array" } }, { "description": "The workspace ID to list runs for.", "in": "query", "name": "filter[workspace]", "required": false, "schema": { "type": "string" } }, { "description": "The account ID to list runs for.", "in": "query", "name": "filter[account]", "required": false, "schema": { "type": "string" } }, { "description": "The environment ID to list runs for.", "in": "query", "name": "filter[environment]", "required": false, "schema": { "type": "string" } }, { "description": "The comma-separated list of run IDs.", "in": "query", "name": "filter[run]", "required": false, "schema": { "type": "string" } }, { "description": "The run status filter.", "in": "query", "name": "filter[status]", "required": false, "schema": { "type": "string" } }, { "description": "The run source filter.", "in": "query", "name": "filter[source]", "required": false, "schema": { "type": "string" } }, { "description": "Filter runs by who created them, e.g. `in:ai-agent,service-account`.", "in": "query", "name": "filter[actor]", "required": false, "schema": { "type": "string" } }, { "description": "Commit sha that affected runs", "in": "query", "name": "filter[vcs-revision]", "required": false, "schema": { "type": "string" } }, { "description": "The ID of the User who triggered this run", "in": "query", "name": "filter[created-by]", "required": false, "schema": { "type": "string" } }, { "description": "The ID of the Run which triggered this run", "in": "query", "name": "filter[created-by-run]", "required": false, "schema": { "type": "string" } }, { "description": "The list of environment or workspaces IDs to match", "in": "query", "name": "filter[env-or-ws]", "required": false, "schema": { "type": "string" } }, { "description": "The run created at filter.", "in": "query", "name": "filter[created-at]", "required": false, "schema": { "type": "string" } }, { "description": "Query string", "in": "query", "name": "query", "required": false, "schema": { "type": "string" } }, { "description": "The is dry runs filter.", "in": "query", "name": "filter[is-dry]", "required": false, "schema": { "type": "string" } }, { "description": "List only runs that are scheduled.", "in": "query", "name": "scheduled", "required": false, "schema": { "type": "string" } }, { "description": "Filter runs by tags.", "in": "query", "name": "filter[tag]", "required": false, "schema": { "type": "string" } }, { "description": "Filter the runs by drifted resources count.", "in": "query", "name": "filter[resource-drifts]", "required": false, "schema": { "type": "string" } }, { "description": "The value of the fields[resource-type] parameter is a comma-separated list that refers to the name of the fields to be returned for the resource. An empty value indicates that no fields should be returned.", "explode": true, "in": "query", "name": "fields", "required": false, "schema": { "properties": { "applies": { "description": "The comma-separated list of fields to return in response for Apply resource.", "type": "string" }, "configuration-versions": { "description": "The comma-separated list of fields to return in response for ConfigurationVersion resource.", "type": "string" }, "cost-estimates": { "description": "The comma-separated list of fields to return in response for CostEstimate resource.", "type": "string" }, "environments": { "description": "The comma-separated list of fields to return in response for Environment resource.", "type": "string" }, "plans": { "description": "The comma-separated list of fields to return in response for Plan resource.", "type": "string" }, "policy-checks": { "description": "The comma-separated list of fields to return in response for PolicyCheck resource.", "type": "string" }, "runs": { "description": "The comma-separated list of fields to return in response for Run resource.", "type": "string" }, "status-transitions": { "description": "The comma-separated list of fields to return in response for StatusTransition resource.", "type": "string" }, "tags": { "description": "The comma-separated list of fields to return in response for Tag resource.", "type": "string" }, "users": { "description": "The comma-separated list of fields to return in response for User resource.", "type": "string" }, "vcs-revisions": { "description": "The comma-separated list of fields to return in response for VcsRevision resource.", "type": "string" }, "workspaces": { "description": "The comma-separated list of fields to return in response for Workspace resource.", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "examples": { "default": { "$ref": "#/paths/~1runs/get/responses/200/content/application~1vnd.api+json/examples/default" } }, "schema": { "$ref": "#/components/schemas/RunListingDocument" } } }, "description": "Success." }, "404": { "description": "User unauthorized to perform action." }, "4XX": { "description": "Client error." }, "5XX": { "description": "Server error." } }, "summary": "List Runs Queue", "tags": [ "runs" ], "x-resource": "Run", "x-service": "tf-api" } } }, "security": [ { "API-Key": [] } ], "servers": [ { "url": "https://{Domain}/api/iacp/v3", "variables": { "Domain": { "default": "example.scalr.io", "description": "Domain where Scalr is hosted" } } } ] } ``` # Sibling pages * [List Runs](https://docs.scalr.io/scalr/reference/get_runs.md) * [Create a Run](https://docs.scalr.io/scalr/reference/create_run.md) * [Get a Run](https://docs.scalr.io/scalr/reference/get_run.md) * [Apply a Run](https://docs.scalr.io/scalr/reference/confirm_run.md) * [Cancel a Run](https://docs.scalr.io/scalr/reference/cancel_run.md) * [Discard a Run](https://docs.scalr.io/scalr/reference/discard_run.md) * [Force Run](https://docs.scalr.io/scalr/reference/force_run.md) * [Download a Policy Input](https://docs.scalr.io/scalr/reference/download_policy_input.md)