Reference For: developers
API: scheduled-tasks
Operations of the scheduled-tasks tag of the native REST API.
Scheduled power tasks (Once/Hourly/Daily/Weekly/Monthly*)
GET /v1/scheduled-tasks
Lists scheduled tasks visible to the caller.
- CLI
kyvernon scheduled-tasks list
Parameters
| Name | In | Type | Required | Description |
|---|
entity | query | string or null | | Only tasks for this VM entity. |
|---|
Responses
POST /v1/scheduled-tasks
Creates a scheduled power task on a VM.
- CLI
kyvernon scheduled-tasks create --body <json>
Request body
application/json: CreateScheduledTaskRequest
| Name | Type | Required | Description |
|---|
action | ScheduledAction | yes | Power action. |
|---|
activeTime | string or null | | Optional scheduler active time. |
|---|
description | string | | Description. |
|---|
enabled | boolean | | Enabled (default true). |
|---|
entityId | string | yes | Target VM id. |
|---|
expireTime | string or null | | Optional scheduler expire time. |
|---|
name | string | yes | Display name. |
|---|
notification | string or null | | Optional notification address (SMTP send when [smtp] enabled). |
|---|
recurrence | ScheduledRecurrence | | Scheduler cadence (default once). |
|---|
runAt | string or null | | One-shot run time / create-time anchor (RFC 3339). Defaults to now. |
|---|
Responses
GET /v1/scheduled-tasks/{id}
One scheduled task.
- CLI
kyvernon scheduled-tasks get <id>
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | string | yes | Id of the scheduled task |
|---|
Responses
Reconfigures a scheduled task (entity stays fixed).
- CLI
kyvernon scheduled-tasks reconfigure <id> --body <json>
| Name | In | Type | Required | Description |
|---|
id | path | string | yes | Id of the scheduled task |
|---|
Request body
application/json: ReconfigureScheduledTaskRequest
| Name | Type | Required | Description |
|---|
action | ScheduledAction | yes | Power action. |
|---|
activeTime | string or null | | Optional scheduler active time. |
|---|
description | string | | Description. |
|---|
enabled | boolean | | Enabled. |
|---|
expireTime | string or null | | Optional scheduler expire time. |
|---|
name | string | yes | Display name. |
|---|
notification | string or null | | Optional notification address (SMTP send when [smtp] enabled). |
|---|
recurrence | ScheduledRecurrence | | Scheduler cadence. |
|---|
runAt | string or null | | One-shot run time / create-time anchor (RFC 3339). Defaults to now. |
|---|
DELETE /v1/scheduled-tasks/{id}
Deletes a scheduled task.
- CLI
kyvernon scheduled-tasks delete <id>
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | string | yes | Id of the scheduled task |
|---|
Responses
| Status | Description | Schema |
|---|
| 204 | Done; no body | |
|---|
POST /v1/scheduled-tasks/{id}/run
Runs a scheduled task immediately (same privilege as SOAP RunScheduledTask).
- CLI
kyvernon scheduled-tasks run <id>
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | string | yes | Id of the scheduled task |
|---|
Responses
| Status | Description | Schema |
|---|
| 204 | Done; no body | |
|---|
Version 0.1.