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
+
ConfigOnboardingStatus
(
schema
)
Name
Description
Type
Notes
details
ConfigOnboardingStatusDetails
Readonly
site_id
Site Id
Site identifier of the site being onboarded.
string
Required
Readonly
status
OnboardingStatus
Required
Readonly
supported_features
List of supported features
List of supported features on global manager.
array of
OnboardingFeatureInfo
Readonly
timestamp
Status Timestamp
Onboarding status as of current timestamp.
EpochMsTimestamp
Required
unsupported_features
List of unsupported features
List of unsupported features on global manager.
array of
OnboardingFeatureInfo
Readonly
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:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable