Reference For: developers

API: tasks

Operations of the tasks tag of the native REST API.

Tasks

GET `/v1/tasks`

Lists tasks, oldest first or with order=desc newest first; after takes the next cursor of the previous page.

CLI: kyvernon tasks list

Parameters

Name	In	Type	Required	Description
`target`	query	`string` or `null`		Only tasks on this target.
`recursive`	query	`boolean` or `null`		With `target`: also tasks on the objects below it (a datacenter, cluster, folder).
`state`	query	`string` or `null`		Comma-separated states (`queued,running,success,error,cancelled`).
`operation`	query	`string` or `null`		Comma-separated operations (`descriptionId`, e.g. `VirtualMachine.powerOn`).
`user`	query	`string` or `null`		Only this user.
`chainId`	query	`string` or `null`		Only this chain id.
`since`	query	`string` or `null`		Only tasks queued at or after this time (RFC 3339).
`until`	query	`string` or `null`		Only tasks queued at or before this time (RFC 3339).
`order`	query	`string` or `null`		`asc` (default, oldest first) or `desc` (newest first).
`limit`	query	`integer` or `null`		Maximum items.
`after`	query	`string` or `null`		Cursor: the `next` of the previous page (in the same order).

Responses

Status	Description	Schema
200	OK	`Paged_TaskView`

GET `/v1/tasks/{id}`

One task.

CLI: kyvernon tasks get <id>

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	yes	Id of the task

Responses

Status	Description	Schema
200	OK	`TaskView`
404	Not found (or not visible to the caller)	`ErrorBody`

POST `/v1/tasks/{id}/cancel`

Cancels a task (own tasks, or Global.CancelTask).

CLI: kyvernon tasks cancel <id>

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	yes	Id of the task

Responses

Status	Description	Schema
200	OK	`TaskView`

GET `/v1/tasks/{id}/wait`

Waits until a task is terminal or the timeout passes (long polling). Answers 200 with the task either way: a task still queued or running at the timeout is returned as it is, and the client asks again.

CLI: kyvernon tasks wait <id>

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	yes	Id of the task
`timeout`	query	`integer` (int64) or `null`		Seconds to wait (default 30, maximum 300).

Responses

Status	Description	Schema
200	The task: terminal, or still queued or running when the timeout passed	`TaskView`
404	Not found (or not visible to the caller)	`ErrorBody`

Version 0.1.