Atlas
Scheduled Tasks

Trigger immediate execution

Triggers an immediate execution of a scheduled task. Requires admin role.

POST
/api/v1/scheduled-tasks/{id}/run

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3001/api/v1/scheduled-tasks/00000000-0000-0000-0000-000000000000/run"
{
  "message": "string",
  "taskId": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}