Sign in
tasks

Execute a task against a resource

This API will create a task that may be long running and may execute against a resource. If the task is long running a 200 code is returned otherwise a 201 code with be returned. The task can be fetched throughout its lifecycle and used to track the progress and completion of the task.<br><br>The following tasks can be executed against an application resource and do not return a result:<br><ul><li>Initiate validation for an application. The validate task will verify each of the application's unverified challenges.</li><li>Start a stopped application.</li><li>Stop a running application.</li><li>Enter an application into maintenance mode.<br><b>parameters</b>:<pre>{"maximum_duration": integer}</pre></li><li>Exit an application from maintenance mode.</li><li>Check a hostname for availability.<br><b>parameters</b>:<pre>{"hostname": string}</pre><b>result</b>:<pre>{"available": boolean}</pre></li></ul>

post/tasks

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Response

The task has been created and is complete.

hrefstring

A reference to the task

typestring

The type of task

targetstring

An object on which a referencing task operates

parametersobject

The parameters used as input to a task

createdstring date-time

Time that the task was created.

startedstring date-time

Time that the task was started. This field will be null if the task has not started.

completedstring date-time

Time at which processing for a task completed, or null if not yet completed.

updatedstring date-time

Time at which the task was last updated.

state'pending' | 'running' | 'success' | 'failed'

The current state of the task. success and failed are final states.

descriptionstring

A description of the task

messagestring

This field may contain a message regarding the current state of the task or it may be null.

Changes