POST /backup_and_restore/prechecks/connectivity/unpaired_hosts

Edit online

Initiates async connectivity tests for unpaired managed hosts

Initiates asynchronous connectivity tests for unpaired managed hosts. Returns immediately with a task ID that can be used to poll for results. This allows for non-blocking testing of multiple hosts with real-time progress updates. The API automatically identifies unpaired managed hosts from the database and tests connectivity to each. The paired site IP and authentication token are automatically retrieved from the paired_site database table (configured via the DR Config API).

Backup Fallback Mechanism:

  • If the paired site is unavailable, the API automatically falls back to querying the latest transfer_initiator backup database to retrieve managed host information.
  • If the paired site is available, the API validates that the latest backup is consistent with the current deployment. If a mismatch is detected, error code 1004 is returned indicating that a new backup should be taken.

No Hosts Scenario:

If there are no unpaired managed hosts to test, the API returns 204 No Content with no response body.

This indicates that all managed hosts are already paired and no connectivity testing is needed.

Table 1. POST /backup_and_restore/prechecks/connectivity/unpaired_hosts resource details
MIME Type

application/json

There are no parameters for this endpoint.

Table 2. POST /backup_and_restore/prechecks/connectivity/unpaired_hosts response codes
HTTP Response Code Unique Code Description

202

The connectivity test task was successfully initiated

204

No unpaired hosts found - no connectivity testing needed

409

1006

A task is already running

409

1005

Paired site configuration not found

500

1002

Internal error

Response Description

Task initiation response containing:
  • task_id - String - UUID of the created task for polling
  • status - String - Current task status (IN_PROGRESS)
  • 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

Response Sample


{
    "completed_hosts": 42,
    "started_at": "String",
    "status": "String <one of: PENDING, IN_PROGRESS, COMPLETED, FAILED, CANCELLED>",
    "task_id": "String",
    "total_hosts": 42
}