Federation >
Infra
>
Onboarding
Check Onboarding configuration conflicts
Verifies and reports conflicting onboarding feature for a site. The
response will contain first conflicting feature for the site configuration
compared to corresponding global manager configuration.
Request:
Method:
POST
URI Path(s):
/global-manager/api/v1/global-infra/sites/<site-id>/onboarding?action=check_conflict
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
ConfigOnboardingConflictRequest
+
ConfigOnboardingConflictRequest
(
schema
)
Name
Description
Type
Notes
prefix
Prefix string
User provided prefix string to resolve conflicting site entities.
string
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=check_conflict { "site_id" : "site-1", "suffix": "site-1-suffix" }
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ConfigOnboardingConflictStatus
+
ConfigOnboardingConflictStatus
(
schema
)
Name
Description
Type
Notes
details
OnboardingFeatureInfo
Readonly
site_id
Site Id
Site identifier of the site being onboarded.
string
Required
Readonly
status
OnboardingConflictStatus
Required
Readonly
Example Response:
{ "site_id": "site-1", "status": "CONFLICT_DETECTED", "details": { "resource_type" : "Tier0", "name": "routing-gateway", "path": "/global-infra/tier0s/routing-gateway" } }
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