GET /backup_and_restore/prechecks/connectivity/tasks/{task_id}

Retrieves async connectivity test task status and results

Retrieves the status and results of an async connectivity test task. Poll this endpoint to get real-time progress and results as hosts are tested.

Note: Tasks are automatically deleted by a background cleanup job after the configured retention period (default: 30 days). If a task doesn't exist (never created or already deleted), this endpoint returns 404 Not Found.
Table 1. GET /backup_and_restore/prechecks/connectivity/tasks/{task_id} resource details
MIME Type

application/json

Table 2. GET /backup_and_restore/prechecks/connectivity/tasks/{task_id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

task_id

path

Required

String

text/plain

The unique task identifier returned from the POST request

Table 3. GET /backup_and_restore/prechecks/connectivity/tasks/{task_id} response codes
HTTP Response Code Unique Code Description

200

The task status was successfully retrieved

404

1007

Task not found (never existed or was deleted by cleanup job)

500

1002

Internal error

Response Description

Task status response containing:
  • task_id - String - UUID of the task
  • status - String - Current task status (PENDING, IN_PROGRESS, COMPLETED, FAILED, CANCELLED)
  • total_hosts - Integer - Total number of hosts to test
  • completed_hosts - Integer - Number of hosts tested so far
  • started_at - String - Timestamp when task started
  • updated_at - String - Timestamp of last update
  • completed_at - String - Timestamp when task completed (if applicable)
  • error_message - String - Error message if task failed
  • results - Array - List of connectivity test results for completed hosts

Response Sample


{
    "completed_at": "String",
    "completed_hosts": 42,
    "error_message": "String",
    "results": [
        {
            "connection_result": "String <one of: SUCCESS, UNREACHABLE, TIMEOUT, DNS_FAILURE, NETWORK_ERROR>",
            "error_message": "String",
            "host_presence_result": "String <one of: VALID_UNPAIRED_HOST, MISSING_FROM_BACKUP, MISSING_FROM_DEPLOYMENT, REMOTE_SITE_UNREACHABLE, CERTIFICATE_ERROR, LOOKUP_FAILED>",
            "managed_host_id": 42,
            "response_time_ms": 42,
            "target_host": "String",
            "target_hostname": "String",
            "tested_at": "String"
        }
    ],
    "started_at": "String",
    "status": "String <one of: PENDING, IN_PROGRESS, COMPLETED, FAILED, CANCELLED>",
    "task_id": "String",
    "total_hosts": 42,
    "updated_at": "String"
}