tasks/run

POST/scheduled-agents/{scheduled_agent_id}/run

Run a Task now, once. A disabled Task stays disabled. Requires 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.
No response body.

202Task run queued.

401Unauthorized.

FieldTypeDescription
errorrequiredstring

403Forbidden or feature unavailable.

FieldTypeDescription
errorrequiredstring

404Task not found.

FieldTypeDescription
errorrequiredstring

409Task is already running.

FieldTypeDescription
errorrequiredstring

500Internal server error.

FieldTypeDescription
errorrequiredstring