tasks/run

POST/scheduled-agents/{scheduled_agent_id}/run

Run an enabled Task now. Requires the scheduled-agents feature, editor access, and the configuration:write permission.

Request

cURL
curl -X POST "https://provisioning.cloudx.io/api/v1/scheduled-agents/{scheduled_agent_id}/run" \
  -H "Authorization: Bearer $CLOUDX_API_KEY"

Path parameters

NameTypeDescription
scheduled_agent_idrequiredstringTask ID.

Responses

Task run queued.
null

202 Task run queued.

401 Unauthorized.

FieldTypeDescription
errorrequiredstring

403 Forbidden or feature unavailable.

FieldTypeDescription
errorrequiredstring

404 Task not found.

FieldTypeDescription
errorrequiredstring

409 Task is disabled or already running.

FieldTypeDescription
errorrequiredstring

500 Internal server error.

FieldTypeDescription
errorrequiredstring