Federation > Infra > Onboarding

Get Onboarding status

Get onboarding status for a site.

Request:

Method:
GET
URI Path(s):
/global-manager/api/v1/global-infra/sites/<site-id>/onboarding/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request:

GET /global-infra/sites/site-1/onboarding/status

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ConfigOnboardingStatus+

Example Response:

{ "site_id": "site-1", "status": "IN_PROGRESS", "details": { "import_progress": { "feature": { "name": "SERVICE" }, "stage": "LM_MIGRATION", "current_step": 1, "total_steps": 5 }, "site_backup_reference": "2020-01-28-Site-1-backup" }, "timestamp": 1581550365276 }

Required Permissions:

read

Feature:

federated_site_onboarding

Additional Errors: