--- updatedAt: 2025-08-14T13:36:36.000Z agentTools: siteIndex: https://developer.n-able.com/llms.txt projectIndex: https://developer.n-able.com/n-central/llms.txt --- # Retrieves aggregated status for a given task. Retrieves the aggregated status associated with a given task using the task ID. # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "N-central API-Service", "description": "

API Access

\n

In order to use the API-Service endpoints, ensure the following prerequisites are met:

\n
    \n
  1. User is created in N-central with appropriate permissions and configuration\n (roles, access groups, MFA disabled, 2FA disabled).
    2. \n
  2. API access is set up in N-central by having a JWT\n (Json Web Token, referred to as \"N-central User-API Token\") generated,\n acting as the permanent secret solely used for fetching access and refresh tokens.
    3. \n
\n

To access the API-Service endpoints, the JWT must first be exchanged with access and refresh tokens:

\n\n

API Pagination & Sorting

\n

Certain API-Service query endpoints support pagination and sorting through the use of query parameters.

\n

Pagination query parameters:

\n\n

A paginated response contains several related fields, such as pageSize, pageNumber, itemCount, totalItems,\n totalPages, _links (first, last, previous and next pages) and _warning (containing any warning messages,\n if present).

\n

Sorting query parameters:

\n\n

API Rate Limiting

\n

The API-Service endpoints are rate limited to ensure the stability, availability and performance of\n the overall system.

\n

Upon reaching such a rate limit, the endpoints return HTTP Status 429 - Too Many Requests.

\n

The system will accept further requests once existing in-flight requests are completed.

\n", "version": "1.0" }, "servers": [ { "url": "https://{custom-server}/", "description": "Default Server URL" } ], "tags": [ { "name": "Scheduled Tasks", "description": "Scheduled tasks operations" } ], "paths": { "/api/scheduled-tasks/{taskId}/status": { "get": { "tags": [ "Scheduled Tasks" ], "summary": "Retrieves aggregated status for a given task.", "description": "Retrieves the aggregated status associated with a given task using the task ID.", "operationId": "getTaskStatus", "parameters": [ { "name": "taskId", "in": "path", "description": "ID of the task for which aggregated status needs to be fetched.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful retrieval of aggregated status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledTaskAggregatedStatusResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Authentication Failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Device Id not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "API-Access_Token": [] } ] } } }, "components": { "schemas": { "ErrorResponse": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationError" } } }, "description": "Error response", "example": { "status": 400, "message": "[ID=2b85998f-26a3-467a] BAD REQUEST: InvalidInputFormatException: Invalid customerId format: 'null'." } }, "ValidationError": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } } }, "ScheduledTaskAggregatedStatusResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaskAggregatedStatus" }, "_links": { "type": "object", "additionalProperties": { "type": "string", "description": "Links to related endpoints." }, "description": "Links to related endpoints." } }, "description": "Aggregated status response.", "example": { "data": { "taskName": "Task Name", "statusCounts": { "Completed": 3, "In Pending": 2 } }, "_links": { "details": "/api/scheduled-tasks/{taskId}/status/details" } } }, "TaskAggregatedStatus": { "type": "object", "properties": { "taskName": { "type": "string", "description": "Name of the task." }, "statusCounts": { "type": "object", "additionalProperties": { "type": "integer", "description": "Map of status counts where keys are status names and values are status counts.", "format": "int32" }, "description": "Map of status counts where keys are status names and values are status counts." } }, "description": "Aggregated status response.", "example": { "taskName": "Task Name", "statusCounts": { "Completed": 3, "In Pending": 2 } } } }, "securitySchemes": { "API-Access_Token": { "type": "http", "description": "Access token for API. You can get the token by authenticating. See \"POST - /api/auth/authenticate\".", "scheme": "bearer", "bearerFormat": "JWT" } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```