Organisations
Turn the HCP Terraform run task off
Deletes the HMAC key, so every request HCP Terraform sends is refused, and revokes the run task's own key.
DELETE
/orgs/{org}/hcp-terraform/run-taskTL;DR
| Question | Answer |
|---|---|
| What does it do? | Turn the HCP Terraform run task off. |
| What does it take? | org in the path. |
| What does it return? | Status 204 with no body. |
| What can go wrong? | 401 not signed in; 403 a member may not (orgs.forbidden), or the request came from an origin that may not make changes; 404 no such organisation, the caller is not a member of it, or the run task is off (run_task.not_found); 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
Deletes the HMAC key, so every request HCP Terraform sends is refused, and revokes the run task's own key. Its diagrams stay in the library. The owner and an admin.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 204 | Turned off. | none |
| 401 | Not signed in. | ErrorResponse |
| 403 | A member may not (orgs.forbidden), or the request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation, the caller is not a member of it, or the run task is off (run_task.not_found). | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |