{"openapi":"3.1.0","info":{"title":"HCP Terraform Run Details (BYOK) API","version":"0.1.0","description":"HCP Terraform Run Details (BYOK) lets an AI assistant read your own HCP Terraform Run Details data through the HCP Terraform Run Details API with a key you supply (user, team or organization API token). Read-only: 7 tools (get_plan, get_apply, get_cost_estimate, list_run_triggers, get_run_trigger, list_workspace_resources, get_current_state_version). 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-details.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-hcp-terraform-run-details/docs"},"termsOfService":"https://connectorbay.com/byok-hcp-terraform-run-details/terms"},"servers":[{"url":"https://byok-hcp-terraform-run-details.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-hcp-terraform-run-details/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/get_plan":{"post":{"operationId":"get_plan","summary":"Get a plan result: status, whether it has changes, counts of resources to add, change, destroy and import, and timestamp","description":"Get a plan result: status, whether it has changes, counts of resources to add, change, destroy and import, and timestamps. The plan log link is not returned. Use for \"What did HCP Terraform plan plan-8F5JFydVYAmtTjET change\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"plan_id":{"description":"Plan id (plan-...), from a run's plan relationship (get_run in the HCP Terraform connector).","maxLength":60,"title":"Plan Id","type":"string"}},"required":["plan_id"],"title":"get_planArguments","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_apply":{"post":{"operationId":"get_apply","summary":"Get an apply result: status, counts of resources added, changed, destroyed and imported, and timestamps. The apply log l","description":"Get an apply result: status, counts of resources added, changed, destroyed and imported, and timestamps. The apply log link is not returned. Use for \"What did HCP Terraform apply apply-47MBvjwzBG8YKc2v do\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"apply_id":{"description":"Apply id (apply-...), from a run's apply relationship (get_run in the HCP Terraform connector).","maxLength":60,"title":"Apply Id","type":"string"}},"required":["apply_id"],"title":"get_applyArguments","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_cost_estimate":{"post":{"operationId":"get_cost_estimate","summary":"Get a run's cost estimate: status, resource counts and prior, proposed and delta monthly cost. Use for \"How much will HC","description":"Get a run's cost estimate: status, resource counts and prior, proposed and delta monthly cost. Use for \"How much will HCP Terraform cost estimate ce-BPvFFrYCqRV6qVBK change my monthly bill\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cost_estimate_id":{"description":"Cost estimate id (ce-...), from a run's cost-estimate relationship.","maxLength":60,"title":"Cost Estimate Id","type":"string"}},"required":["cost_estimate_id"],"title":"get_cost_estimateArguments","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_triggers":{"post":{"operationId":"list_run_triggers","summary":"List a workspace's run triggers: inbound (workspaces that trigger it) or outbound (workspaces it triggers). Use for \"Whi","description":"List a workspace's run triggers: inbound (workspaces that trigger it) or outbound (workspaces it triggers). Use for \"Which workspaces trigger runs in HCP Terraform workspace ws-6jrRyVDv1J8zQMB5\".","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"},"type":{"description":"Which triggers to list.","enum":["inbound","outbound"],"title":"Type","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","type"],"title":"list_run_triggersArguments","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_trigger":{"post":{"operationId":"get_run_trigger","summary":"Get one run trigger: the workspace it fires and the source workspace. Use for \"Show HCP Terraform run trigger rt-3yVQZvH","description":"Get one run trigger: the workspace it fires and the source workspace. Use for \"Show HCP Terraform run trigger rt-3yVQZvHzf5j3WRJ1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"run_trigger_id":{"description":"Run trigger id (rt-...), as returned by list_run_triggers.","maxLength":60,"title":"Run Trigger Id","type":"string"}},"required":["run_trigger_id"],"title":"get_run_triggerArguments","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_resources":{"post":{"operationId":"list_workspace_resources","summary":"List the resources Terraform manages in a workspace's current state: address, provider, module and last modifying state ","description":"List the resources Terraform manages in a workspace's current state: address, provider, module and last modifying state version. Use for \"Which resources does HCP Terraform workspace ws-6jrRyVDv1J8zQMB5 manage\".","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_resourcesArguments","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_current_state_version":{"post":{"operationId":"get_current_state_version","summary":"Get the metadata of a workspace's current state version: serial, Terraform version, status, size, module and resource su","description":"Get the metadata of a workspace's current state version: serial, Terraform version, status, size, module and resource summary. State contents and download links are not returned. Use for \"What is the latest state serial and Terraform version of HCP Terraform workspace ws-6jrRyVDv1J8zQMB5\".","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"}},"required":["workspace_id"],"title":"get_current_state_versionArguments","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}}}}