{"openapi":"3.1.0","info":{"title":"HCP Terraform Run Tasks (BYOK) API","version":"0.1.0","description":"HCP Terraform Run Tasks (BYOK) lets an AI assistant read your own HCP Terraform Run Tasks data through the HCP Terraform Run Tasks API with a key you supply (user, team or organization API token). Read-only: 7 tools (list_run_tasks, get_run_task, list_workspace_run_tasks, get_workspace_run_task, list_run_task_stages, get_task_stage, get_task_result). The BYOK key travels with each request, is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-hcp-terraform-run-tasks.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-hcp-terraform-run-tasks/docs"},"termsOfService":"https://connectorbay.com/byok-hcp-terraform-run-tasks/terms"},"servers":[{"url":"https://byok-hcp-terraform-run-tasks.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-hcp-terraform-run-tasks/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_run_tasks":{"post":{"operationId":"list_run_tasks","summary":"List an organization's run tasks (integrations that check plans and applies) with name, category, description and enable","description":"List an organization's run tasks (integrations that check plans and applies) with name, category, description and enabled flag. The task URL and HMAC key are left out. Use for \"Which run tasks are configured in my HCP Terraform organization\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"HCP Terraform organization name, as returned by list_organizations in the HCP Terraform connector.","maxLength":100,"title":"Organization","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Items per page (1 to 100, default 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"required":["organization"],"title":"list_run_tasksArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_run_task":{"post":{"operationId":"get_run_task","summary":"Get one organization run task: name, category, description and whether it is enabled. Use for \"Show HCP Terraform run ta","description":"Get one organization run task: name, category, description and whether it is enabled. Use for \"Show HCP Terraform run task task-7oD7doVTQdAFnMLV\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"task_id":{"description":"Run task id (task-...), as returned by list_run_tasks.","maxLength":60,"title":"Task Id","type":"string"}},"required":["task_id"],"title":"get_run_taskArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_workspace_run_tasks":{"post":{"operationId":"list_workspace_run_tasks","summary":"List the run tasks attached to a workspace with enforcement level (advisory or mandatory) and the stage they run in. Use","description":"List the run tasks attached to a workspace with enforcement level (advisory or mandatory) and the stage they run in. Use for \"Which run tasks apply to HCP Terraform workspace ws-kRsDRPtTmtcEme4t\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id (ws-...), as returned by list_workspaces in the HCP Terraform connector.","maxLength":60,"title":"Workspace Id","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Items per page (1 to 100, default 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"required":["workspace_id"],"title":"list_workspace_run_tasksArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_workspace_run_task":{"post":{"operationId":"get_workspace_run_task","summary":"Get one workspace run task: enforcement level, stage and the task and workspace it links. Use for \"Is run task wstask-tB","description":"Get one workspace run task: enforcement level, stage and the task and workspace it links. Use for \"Is run task wstask-tBXYu8GVAFBpcmPm mandatory on workspace ws-kRsDRPtTmtcEme4t\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id (ws-...), as returned by list_workspaces in the HCP Terraform connector.","maxLength":60,"title":"Workspace Id","type":"string"},"workspace_task_id":{"description":"Workspace task id (wstask-...), as returned by list_workspace_run_tasks.","maxLength":60,"title":"Workspace Task Id","type":"string"}},"required":["workspace_id","workspace_task_id"],"title":"get_workspace_run_taskArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_run_task_stages":{"post":{"operationId":"list_run_task_stages","summary":"List the task stages of one run (pre-plan, post-plan, pre-apply, post-apply) with status and duration. Use for \"Did the ","description":"List the task stages of one run (pre-plan, post-plan, pre-apply, post-apply) with status and duration. Use for \"Did the run tasks pass for HCP Terraform run run-XdgtChJuuUwLoSmw\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"run_id":{"description":"Run id (run-...), as returned by list_workspace_runs in the HCP Terraform connector.","maxLength":60,"title":"Run Id","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Items per page (1 to 100, default 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"required":["run_id"],"title":"list_run_task_stagesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_task_stage":{"post":{"operationId":"get_task_stage","summary":"Get one task stage: status, stage name, duration and timestamps. Use for \"Show HCP Terraform task stage ts-rL5ZsuwfjqfPJ","description":"Get one task stage: status, stage name, duration and timestamps. Use for \"Show HCP Terraform task stage ts-rL5ZsuwfjqfPJcdi\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"task_stage_id":{"description":"Task stage id (ts-...), as returned by list_run_task_stages.","maxLength":60,"title":"Task Stage Id","type":"string"}},"required":["task_stage_id"],"title":"get_task_stageArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_task_result":{"post":{"operationId":"get_task_result","summary":"Get the result one run task returned for a stage: status, the message it reported, duration, task name and enforcement l","description":"Get the result one run task returned for a stage: status, the message it reported, duration, task name and enforcement level. Use for \"What did run task result taskrs-EmnmsEDL1jgd1GZz report\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"task_result_id":{"description":"Task result id (taskrs-...), as listed in a task stage's relationships.","maxLength":60,"title":"Task Result Id","type":"string"}},"required":["task_result_id"],"title":"get_task_resultArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}