- URL:https://<services-url>/unfederate(POST only)
- Required Capability:Default administrator role | All authorized privileges
- Version Introduced:10.2
Description
This operation is used when unfederating ArcGIS Server with your ArcGIS Enterprise portal. It removes any items from the portal that represent services running on your federated ArcGIS Server. You typically run this operation in preparation for a full unfederate action. For example, this can be performed using Organization > Edit Settings > Servers in the portal website or the Unregister Server operation in the ArcGIS REST API.
Caution:
Unfederating a server site has several significant consequences and should not be done as part of routine troubleshooting. It is an act that is not easily undone and may have irreversible consequences. Only unfederate a site if you have a clear understanding of the impact. See Administer a federated server for more details.
At ArcGIS Enterprise 10.3 and later, services are removed automatically as part of the unfederate process. If the automatic removal of service items fails as part of the unfederate process, you can manually re-run the operation to remove the items from the portal.
Note:
The Unfederate operation does not remove any items representing services published by portal users (in other words, services in the Hosted folder on ArcGIS Server). Those services are entirely managed by the portal.
Request parameters
| Parameter | Details |
|---|---|
| f | The response format. The default response format is html. Values: html | json | pjson |
Example usage
Below is a sample POST request for unfederate:
POST /webadaptor/admin/services/unfederate HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=jsonJSON Response example
{"status": "success"}