--- updatedAt: 2025-08-14T13:36:22.000Z agentTools: siteIndex: https://developer.n-able.com/llms.txt projectIndex: https://developer.n-able.com/n-central/llms.txt --- # PREVIEW : Retrieves the appliance-task information. Retrieves the appliance-task information for a given taskId.

NOTE: This endpoint is currently in a preview stage. # 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": "Devices", "description": "Device operations" } ], "paths": { "/api/appliance-tasks/{taskId}": { "get": { "tags": [ "Devices" ], "summary": "PREVIEW : Retrieves the appliance-task information.", "description": "Retrieves the appliance-task information for a given taskId.

NOTE: This endpoint is currently in a preview stage.", "operationId": "getApplianceTaskInformationDetails", "parameters": [ { "name": "taskId", "in": "path", "description": "ID of the appliance-task for which information needs to be fetched.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful retrieval of appliance-task information.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ApplianceTaskInformation" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "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" } } }, "ApplianceTaskInformation": { "type": "object", "properties": { "scanTime": { "type": "string" }, "state": { "type": "string", "enum": [ "NO_STATE", "NO_DATA", "STALE", "NORMAL", "WARNING", "FAILED", "MISCONFIGURED", "DISCONNECTED", "DISABLED" ] }, "errorMessage": { "type": "string" }, "serviceDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ApplianceTaskStatusDetail" } } }, "description": "The appliance task information", "example": { "scanTime": "2024-05-23 11:28:09.55", "state": "NORMAL", "errorMessage": "", "serviceDetails": [ { "scanDetailId": 3262200, "detailName": "agent_chkinintvl", "description": "Agent check-in interval (sec)", "detailValue": "32", "state": "NORMAL", "monitoringType": "Normal", "thresholds": [ { "state": "NORMAL", "lowValue": 0, "highValue": 300 }, { "state": "WARNING", "lowValue": 300, "highValue": 600 }, { "state": "FAILED", "lowValue": 600, "highValue": 4294967295 } ] } ] } }, "ApplianceTaskStatusDetail": { "type": "object", "properties": { "scanDetailId": { "type": "integer", "format": "int32" }, "detailName": { "type": "string" }, "description": { "type": "string" }, "detailValue": { "type": "string" }, "state": { "type": "string", "enum": [ "NO_STATE", "NO_DATA", "STALE", "NORMAL", "WARNING", "FAILED", "MISCONFIGURED", "DISCONNECTED", "DISABLED" ] }, "monitoringType": { "type": "string" }, "thresholds": { "type": "array", "items": { "$ref": "#/components/schemas/ApplianceTaskThresholdBasic" } } } }, "ApplianceTaskThresholdBasic": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "NO_STATE", "NO_DATA", "STALE", "NORMAL", "WARNING", "FAILED", "MISCONFIGURED", "DISCONNECTED", "DISABLED" ] }, "lowValue": { "type": "integer" }, "highValue": { "type": "integer" } } } }, "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 } } ```