Federation >
Infra
>
Onboarding
Start or Check on-boarding for a Site
Initiate config on-boarding of a Site. The entire on-boarding is async
workflow controlled by API.
Request:
Method:
POST
URI Path(s):
/global-manager/api/v1/global-infra/sites/<site-id>/onboarding?action=start_onboarding
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
ConfigOnboardingRequest
+
ConfigOnboardingRequest
(
schema
)
Name
Description
Type
Notes
prefix
Prefix string
User provided prefix string to resolve conflicting site entities.
string
Readonly
site_backup_reference
Site Backup Reference
Site backup image details to hint user to restore site before
starting onboarding process.
string
Required
Readonly
site_id
Site Id
Site Id.
string
Readonly
suffix
Suffix string
User provided suffix string to resolve conflicting site entities.
string
Example Request:
POST /global-infra/sites/site-1/onboarding?action=start_config_onboarding { "site_id" : "site-1", "suffix": "site-1-suffix", "site_backup_reference" : "2020-01-28-Site-1-backup" }
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", "supported_features": [], "details": { "import_progress": {}, "site_backup_reference": "2020-01-28-Site-1-backup" }, "timestamp": 1580609440765 }
Required Permissions:
crud
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