- URL:
- https://<root>/orgs/<orgID>/federation/servers/<serverID>/unfederate
- Methods:
POST- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The unfederate operation unfederates a currently federated ArcGIS Server from your organization. Before performing this operation, the federated server should be taken out of read-only mode if it was already in that state. This operation is not applicable to the hosting server configured as part of the base deployment of ArcGIS Enterprise on Kubernetes.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the unfederate operation:
POST /<context>/admin/orgs/0123456789ABCDEF/federation/servers/vlQpWOiz9oEooY64/unfederate HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjson&token=GsLMAFIrrfkho8hbSRPjxsa0zeNPNaK39HPgNG5iAjtc_BhgGOq6GyuKsD3V_GJKQG0YBri1kY-I2H0de-U2z6RHZMxWwIlwkE0RX1mJv3qq8djYFdaQZlrT23paKVkEGZGF2Ju7gHTQRKogS7XBdiFB2apm6JErgU1WAum2uJx6s3sBhEx2XNrv8cIk2yUAzlrMubspXG335Bw1tPN-p0rxU2I3jRmGOiYEsyVvMQ4TLywA-ubgV0EvrxkeWsU4ZJoYqvzq0GI8J7mYXb9Jq6lGQy108x4jFzs4FP36yrE.JSON Response example
{"status": "success"}