Organisations

Change what the HCP Terraform run task reports

failOnError true reports a run Plotwork cannot draw or keep as failed; false, the default, reports it as passed with a sentence.

PATCH/orgs/{org}/hcp-terraform/run-task

TL;DR

Question	Answer
What does it do?	Change what the HCP Terraform run task reports.
What does it take?	A JSON body of type `RunTaskOptions`.
What does it return?	Status 200 with a body of type `RunTask`.
What can go wrong?	`400` the body is not valid; `401` not signed in; `403` the plan has no run task (plan.run_task_not_included), 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

failOnError true reports a run Plotwork cannot draw or keep as failed; false, the default, reports it as passed with a sentence. The owner and an admin, on Pro and Enterprise.

Path parameters

Field	Type	Required	Description
`org`	`string`	yes	The organisation's id or its slug.

Request body

The body has the type RunTaskOptions.

Field	Type	Required	Description
`failOnError`	`boolean`	yes	Report a run Plotwork cannot draw or keep as failed. With an advisory run task the run still goes on.

Responses

Status	Meaning	Body
200	The run task as it is now.	`RunTask`
400	The body is not valid.	`ErrorResponse`
401	Not signed in.	`ErrorResponse`
403	The plan has no run task (plan.run_task_not_included), 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`

Response body

A 200 answer has the type RunTask.

Field	Type	Required	Description
`active`	`boolean`	yes	Whether the owner's plan includes the run task (Pro and Enterprise). While it does not, each run is reported as passed with a sentence, and nothing is drawn.
`plan`	`"free" \| "pro" \| "enterprise"`	yes
`enabled`	`boolean`	yes	Whether the run task is on.
`endpoint`	`string \| null`	yes	The endpoint URL to give HCP Terraform, by the organisation id. Null on a server with no `API_URL`.
`keyLast4`	`string \| null`	yes	The HMAC key's last four characters, or null while the run task is off.
`failOnError`	`boolean`	yes	True when a run Plotwork cannot draw or keep is reported as failed. False (the default) reports it as passed, with a sentence.
`enabledAt`	`integer \| null`	yes	When it was turned on, in milliseconds since the epoch.
`enabledBy`	`object \| null`	yes	Who turned it on, or null when that account is gone.
`enabledBy.id`	`string`	yes
`enabledBy.email`	`string`	yes
`lastRunAt`	`integer \| null`	yes	When HCP Terraform last called it for a run, in milliseconds since the epoch, or null for never.
`lastStatus`	`"passed" \| "failed" \| null`	yes	The status sent back to the last run.

Doc	Why
API reference	Every endpoint, and the error envelope
Schemas	Every request and response type
Tool reference	The operations as callable tools