Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.0",
"info": {
"title": "Task Management API",
"version": "v2"
},
"paths": {
"/tasks": {
"get": {
"operationId": "Fetch a list of tasks",
"description": "Fetches a list of tasks.\n\n# Sustainable behavior (informative):\nIf `sustainable=true` and a task is returned to the queue, its sustainable activities are moved to `enqueued`\nand must be restarted via `PUT /activities/{id}/started`. If not restarted by task completion, they will be marked `abandoned`.\n",
"x-AllowedTo": [
"task_manager::admin",
"task_manager::viewer"
],
"parameters": [
{
"name": "lod",
"in": "query",
"schema": {
"$ref": "#/components/schemas/levelOfDetail"
}
},
{
"name": "limit",
"description": "A number of tasks to return in one page. This parameter restricts usage of the query string parameters to `after`.",
"in": "query",
"schema": {
"description": "A number of tasks to return in one page. This parameter restricts usage of the query string parameters to `after`.",
"type": "integer"
}
},
{
"name": "after",
"description": "The page token with the next page of the results. Can be used only with the `limit` query string parameter.",
"in": "query",
"schema": {
"description": "The page token with the next page of the results. Can be used only with the `limit` query string parameter.",
"type": "string"
}
},
{
"name": "order",
"description": "A position-dependent ordering filter.\n\nAvailable ordering operators are:\n- `asc(field)` - ascending order\n- `desc(field)` - descending order\n\nWhere \"field\" is one of the following values: `id`, `uuid`, `type`, `priority`,\n`startedByUser`, `state`, `enqueuedAt`, `assignedAt`, `startedAt`, `updatedAt`, `completedAt`.\n",
"in": "query",
"schema": {
"description": "A position-dependent ordering filter.\n\nAvailable ordering operators are:\n- `asc(field)` - ascending order\n- `desc(field)` - descending order\n\nWhere \"field\" is one of the following values: `id`, `uuid`, `type`, `priority`,\n`startedByUser`, `state`, `enqueuedAt`, `assignedAt`, `startedAt`, `updatedAt`, `completedAt`.\n",
"type": "string"
}
},
{
"name": "executorId",
"description": "filter per task executor ID.",
"in": "query",
"schema": {
"description": "filter per task executor ID.",
"type": "string"
}
},
{
"name": "id",
"description": "An ID filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "An ID filter. Multiple entries are accepted.",
"type": "integer"
}
},
{
"name": "uuid",
"description": "A UUID filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A UUID filter. Multiple entries are accepted.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
}
},
{
"name": "type",
"description": "A type filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A type filter. Multiple entries are accepted.",
"type": "string"
}
},
{
"name": "queue",
"description": "Queue filter, multiple entries are accepted",
"in": "query",
"schema": {
"description": "Queue filter, multiple entries are accepted",
"type": "string"
}
},
{
"name": "priority",
"description": "Priority filter, multiple entries are accepted",
"in": "query",
"schema": {
"description": "Priority filter, multiple entries are accepted",
"enum": [
"low",
"belowNormal",
"normal",
"aboveNormal",
"high"
],
"type": "string"
}
},
{
"name": "startedBy",
"description": "Started by user filter, multiple entries are accepted, 'like' is supported in the form 'like(value)'",
"in": "query",
"schema": {
"description": "Started by user filter, multiple entries are accepted, 'like' is supported in the form 'like(value)'",
"type": "string"
}
},
{
"name": "policyId",
"description": "A policy ID filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A policy ID filter. Multiple entries are accepted.",
"type": "string"
}
},
{
"name": "policyName",
"description": "A policy name filter. Multiple entries are accepted.\n\nThe 'like' operator can be used to find a policy name by a sequence of characters. Usage: `like(value)` where \"value\" is a sequence of characters.\n",
"in": "query",
"schema": {
"description": "A policy name filter. Multiple entries are accepted.\n\nThe 'like' operator can be used to find a policy name by a sequence of characters. Usage: `like(value)` where \"value\" is a sequence of characters.\n",
"type": "string"
}
},
{
"name": "policyType",
"description": "A policy type filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A policy type filter. Multiple entries are accepted.",
"type": "string"
}
},
{
"name": "resourceId",
"description": "A resource ID filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A resource ID filter. Multiple entries are accepted.",
"type": "string"
}
},
{
"name": "resourceName",
"description": "A resource name filter. Multiple entries are accepted.\n\nThe 'like' operator can be used to find a resource name by a sequence of characters. Usage: `like(value)` where \"value\" is a sequence of characters.\n",
"in": "query",
"schema": {
"description": "A resource name filter. Multiple entries are accepted.\n\nThe 'like' operator can be used to find a resource name by a sequence of characters. Usage: `like(value)` where \"value\" is a sequence of characters.\n",
"type": "string"
}
},
{
"name": "resourceType",
"description": "A resource type filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A resource type filter. Multiple entries are accepted.",
"type": "string"
}
},
{
"name": "workflowId",
"description": "A workflow ID filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A workflow ID filter. Multiple entries are accepted.",
"type": "integer"
}
},
{
"name": "state",
"description": "A state filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A state filter. Multiple entries are accepted.",
"enum": [
"enqueued",
"assigned",
"started",
"paused",
"completed"
],
"type": "string"
}
},
{
"name": "resultCode",
"description": "A code filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A code filter. Multiple entries are accepted.",
"enum": [
"ok",
"error",
"warning",
"cancelled",
"abandoned",
"timedout"
],
"type": "string"
}
},
{
"name": "enqueuedAt",
"description": "A time filter. Single entry is accepted.",
"in": "query",
"schema": {
"description": "A time filter. Single entry is accepted.",
"type": "string"
}
},
{
"name": "assignedAt",
"description": "A time filter. Single entry is accepted.",
"in": "query",
"schema": {
"description": "A time filter. Single entry is accepted.",
"type": "string"
}
},
{
"name": "startedAt",
"description": "A time filter. Single entry is accepted.",
"in": "query",
"schema": {
"description": "A time filter. Single entry is accepted.",
"type": "string"
}
},
{
"name": "updatedAt",
"description": "A time filter. Single entry is accepted.",
"in": "query",
"schema": {
"description": "A time filter. Single entry is accepted.",
"type": "string"
}
},
{
"name": "completedAt",
"description": "A time filter. Single entry is accepted.",
"in": "query",
"schema": {
"description": "A time filter. Single entry is accepted.",
"type": "string"
}
},
{
"name": "tag",
"description": "A tag filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A tag filter. Multiple entries are accepted.",
"type": "string"
}
},
{
"name": "affinityAgentId",
"description": "The ID of the agent that is bound to the task.",
"in": "query",
"schema": {
"description": "The ID of the agent that is bound to the task.",
"type": "string"
}
},
{
"name": "affinityClusterId",
"description": "The ID of the cluster that is bound to the task.",
"in": "query",
"schema": {
"description": "The ID of the cluster that is bound to the task.",
"type": "string"
}
},
{
"name": "allow_deleted",
"description": "If true, allows to work with deleted entities.",
"required": false,
"in": "query",
"schema": {
"description": "If true, allows to work with deleted entities.",
"example": true,
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"description": "A collection of tasks.",
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/task"
}
},
"cursors": {
"type": "object",
"properties": {
"after": {
"description": "The page token that points to the next page",
"type": "string"
},
"before": {
"description": "The page token that points to the previous page.",
"type": "string"
}
}
}
}
}
}
}
},
"400": {
"description": "Bad user input.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/domainError"
}
}
}
},
"500": {
"description": "Server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/domainError"
}
}
}
}
},
"security": [
{
"oauth2": [
"urn:acronis.com::task_manager::admin",
"urn:acronis.com::task_manager::viewer"
]
}
]
}
},
"/tasks/{task-id}": {
"get": {
"operationId": "Fetch a task",
"description": "Fetches a task by provided task ID.",
"x-AllowedTo": [
"task_manager::admin",
"task_manager::viewer"
],
"parameters": [
{
"name": "lod",
"in": "query",
"schema": {
"$ref": "#/components/schemas/levelOfDetailSingleEntity"
}
},
{
"name": "allow_deleted",
"description": "If true, allows to work with deleted entities.",
"required": false,
"in": "query",
"schema": {
"description": "If true, allows to work with deleted entities.",
"example": true,
"type": "boolean"
}
},
{
"name": "task-id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/task_1"
}
}
}
},
"400": {
"description": "Bad user input.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/domainError"
}
}
}
},
"404": {
"description": "The task does not exist.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/domainError"
}
}
}
},
"500": {
"description": "Server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/domainError"
}
}
}
}
},
"security": [
{
"oauth2": [
"urn:acronis.com::task_manager::admin",
"urn:acronis.com::task_manager::viewer"
]
}
]
}
},
"/activities": {
"get": {
"operationId": "Fetch a list of activities",
"description": "Fetches a list of activities.\n\n# Sustainable behavior (informative):\nSustainable activities move to `enqueued` when their task is requeued and must be restarted with `PUT /activities/{id}/started`.\nIf not restarted by task completion, they will be marked `abandoned`.\n",
"x-AllowedTo": [
"task_manager::admin",
"task_manager::viewer"
],
"parameters": [
{
"name": "lod",
"in": "query",
"schema": {
"$ref": "#/components/schemas/levelOfDetail"
}
},
{
"name": "limit",
"description": "A number of activities to return in one page. This parameter restricts usage of the query string parameters to `after`.",
"in": "query",
"schema": {
"description": "A number of activities to return in one page. This parameter restricts usage of the query string parameters to `after`.",
"type": "integer"
}
},
{
"name": "after",
"description": "The page token with the next page of the results. Can be used only with the `limit` query string parameter.",
"in": "query",
"schema": {
"description": "The page token with the next page of the results. Can be used only with the `limit` query string parameter.",
"type": "string"
}
},
{
"name": "order",
"description": "An ordering filter (position-dependent).\n\nAvailable ordering operators are:\n- `asc(field)` - ascending order\n- `desc(field)` - descending order\n\nWhere \"field\" is one of the following values: `id`, `uuid`, `type`, `startedByUser`,\n`state`, `createdAt`, `startedAt`, `updatedAt`, `completedAt`.\n",
"in": "query",
"schema": {
"description": "An ordering filter (position-dependent).\n\nAvailable ordering operators are:\n- `asc(field)` - ascending order\n- `desc(field)` - descending order\n\nWhere \"field\" is one of the following values: `id`, `uuid`, `type`, `startedByUser`,\n`state`, `createdAt`, `startedAt`, `updatedAt`, `completedAt`.\n",
"type": "string"
}
},
{
"name": "id",
"description": "An ID filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "An ID filter. Multiple entries are accepted.",
"type": "integer"
}
},
{
"name": "uuid",
"description": "A UUID filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A UUID filter. Multiple entries are accepted.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
}
},
{
"name": "type",
"description": "A type filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A type filter. Multiple entries are accepted.",
"type": "string"
}
},
{
"name": "startedBy",
"description": "A filter by a user who started the activity. Multiple entries are accepted.\n\nThe 'like' operator can be used to find a policy name by a sequence of characters. Usage: `like(value)` where \"value\" is a sequence of characters.\n",
"in": "query",
"schema": {
"description": "A filter by a user who started the activity. Multiple entries are accepted.\n\nThe 'like' operator can be used to find a policy name by a sequence of characters. Usage: `like(value)` where \"value\" is a sequence of characters.\n",
"type": "string"
}
},
{
"name": "policyId",
"description": "A policy ID filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A policy ID filter. Multiple entries are accepted.",
"type": "string"
}
},
{
"name": "policyName",
"description": "A policy name filter. Multiple entries are accepted.\n\nThe 'like' operator can be used to find a policy name by a sequence of characters. Usage: `like(value)` where \"value\" is a sequence of characters.\n",
"in": "query",
"schema": {
"description": "A policy name filter. Multiple entries are accepted.\n\nThe 'like' operator can be used to find a policy name by a sequence of characters. Usage: `like(value)` where \"value\" is a sequence of characters.\n",
"type": "string"
}
},
{
"name": "policyType",
"description": "A policy type filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A policy type filter. Multiple entries are accepted.",
"type": "string"
}
},
{
"name": "resourceId",
"description": "A resource ID filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A resource ID filter. Multiple entries are accepted.",
"type": "string"
}
},
{
"name": "resourceName",
"description": "A resource name filter. Multiple entries are accepted.\n\nThe 'like' operator can be used to find a resource name by a sequence of characters. Usage: `like(value)` where \"value\" is a sequence of characters.\n",
"in": "query",
"schema": {
"description": "A resource name filter. Multiple entries are accepted.\n\nThe 'like' operator can be used to find a resource name by a sequence of characters. Usage: `like(value)` where \"value\" is a sequence of characters.\n",
"type": "string"
}
},
{
"name": "resourceType",
"description": "A resource type filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A resource type filter. Multiple entries are accepted.",
"type": "string"
}
},
{
"name": "taskId",
"description": "A task ID filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A task ID filter. Multiple entries are accepted.",
"type": "integer"
}
},
{
"name": "workflowId",
"description": "A workflow ID filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A workflow ID filter. Multiple entries are accepted.",
"type": "integer"
}
},
{
"name": "parentActivityId",
"description": "A parent activity ID filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A parent activity ID filter. Multiple entries are accepted.",
"type": "integer"
}
},
{
"name": "state",
"description": "A state filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A state filter. Multiple entries are accepted.",
"enum": [
"enqueued",
"assigned",
"started",
"paused",
"completed"
],
"type": "string"
}
},
{
"name": "resultCode",
"description": "A code filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A code filter. Multiple entries are accepted.",
"enum": [
"ok",
"error",
"warning",
"cancelled",
"abandoned",
"timedout"
],
"type": "string"
}
},
{
"name": "createdAt",
"description": "A time filter. Single entry is accepted.",
"in": "query",
"schema": {
"description": "A time filter. Single entry is accepted.",
"type": "string"
}
},
{
"name": "startedAt",
"description": "A time filter. Single entry is accepted.",
"in": "query",
"schema": {
"description": "A time filter. Single entry is accepted.",
"type": "string"
}
},
{
"name": "updatedAt",
"description": "A time filter. Single entry is accepted.",
"in": "query",
"schema": {
"description": "A time filter. Single entry is accepted.",
"type": "string"
}
},
{
"name": "completedAt",
"description": "A time filter. Single entry is accepted.",
"in": "query",
"schema": {
"description": "A time filter. Single entry is accepted.",
"type": "string"
}
},
{
"name": "tag",
"description": "A tag filter. Multiple entries are accepted.",
"in": "query",
"schema": {
"description": "A tag filter. Multiple entries are accepted.",
"type": "string"
}
},
{
"name": "sustainable",
"description": "Filter by sustainable activities.",
"in": "query",
"schema": {
"description": "Filter by sustainable activities.",
"type": "boolean"
}
},
{
"name": "allow_deleted",
"description": "If true, allows to work with deleted entities.",
"required": false,
"in": "query",
"schema": {
"description": "If true, allows to work with deleted entities.",
"example": true,
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"description": "A collection of activities.",
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/activity"
}
},
"cursors": {
"type": "object",
"properties": {
"after": {
"description": "The page token that points to the next page",
"type": "string"
},
"before": {
"description": "The page token that points to the previous page.",
"type": "string"
}
}
}
}
}
}
}
},
"400": {
"description": "Bad user input.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/domainError"
}
}
}
},
"500": {
"description": "Server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/domainError"
}
}
}
}
},
"security": [
{
"oauth2": [
"urn:acronis.com::task_manager::admin",
"urn:acronis.com::task_manager::viewer"
]
}
]
}
},
"/activities/{activity-id}": {
"get": {
"operationId": "Fetch an activity",
"description": "Fetches an activity by provided activity ID.",
"x-AllowedTo": [
"task_manager::admin",
"task_manager::viewer"
],
"parameters": [
{
"name": "lod",
"in": "query",
"schema": {
"$ref": "#/components/schemas/levelOfDetailSingleEntity"
}
},
{
"name": "allow_deleted",
"description": "If true, allows to work with deleted entities.",
"required": false,
"in": "query",
"schema": {
"description": "If true, allows to work with deleted entities.",
"example": true,
"type": "boolean"
}
},
{
"name": "activity-id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/activity_2"
}
}
}
},
"400": {
"description": "Bad user input.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/domainError"
}
}
}
},
"404": {
"description": "The activity does not exist.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/domainError"
}
}
}
},
"500": {
"description": "Server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/domainError"
}
}
}
}
},
"security": [
{
"oauth2": [
"urn:acronis.com::task_manager::admin",
"urn:acronis.com::task_manager::viewer"
]
}
]
}
}
},
"x-roles": [
{
"name": "public",
"id": "1",
"description": "public role",
"x-tags": [
"public"
]
},
{
"name": "private",
"id": "2",
"description": "private role",
"x-tags": [
"private"
]
}
],
"components": {
"schemas": {
"levelOfDetail": {
"enum": [
"tiny",
"short",
"long",
"full",
"debug",
"count"
],
"type": "string"
},
"task": {
"description": "The task object.",
"type": "object",
"required": [
"state",
"id",
"issuer",
"cancelRequested",
"enqueuedAt",
"updatedAt",
"assignCount"
],
"properties": {
"state": {
"$ref": "#/components/schemas/executionState"
},
"result": {
"$ref": "#/components/schemas/executionResult"
},
"id": {
"description": "Server-generated unique numeric identifier for the task object.",
"type": "integer"
},
"startedAt": {
"$ref": "#/components/schemas/time"
},
"completedAt": {
"$ref": "#/components/schemas/time"
},
"issuer": {
"description": "The entity that created the task.",
"type": "object",
"required":
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acronis/refs/heads/main/openapi/_original/acronis-tasks-v2-openapi.json