- URL:
- https://<root>/portals/[portalID]/urls/updateFederatedServerUrl
- Methods:
POST
- Version Introduced:
- 11.4
Example usage
The following is a sample ArcGIS Enterprise POST request for the update
operation:
POST /webadaptor/sharing/rest/portals/0123456789ABCDEF/urls/updatePortalUrl HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
serverId=PAf9Y5TdsDb1uQkm&newUrl=https://modifiedPublicURL.domain.com/server&async=true&f=html&token=<token>
Description
The update
operation updates the public-facing URL of a federated server. This operation supports modifying the domain, subdomain, and context of the URL. When this operation is performed, the items on the federated server that used the previous URL are updated to use the new URL.
To ensure that the organization's resources will remain accessible, the URLs for each federated server and Enterprise portal must be updated.
Request parameters
Parameter | Details |
---|---|
(Required) | The ID of the federated server. This value is retrieved from the Generate Organization URL Map operation.
|
(Required) | Sets the new public-facing URL for the federated server.
|
| If Values: |
| The response format. The default format is Values: |
JSON Response examples
The tabs below show the JSON responses returned for synchronous and asynchronous requests:
The following response is returned when async
is set to false
:
{
"reregisterUrlResults": {
"type": "reregisterFederatedServerUrl",
"id": "PAf9Y5TdsDb1uQkm",
"reregisterURL": "https://modifiedPublicURL.domain.com/server",
"reregisteredServerSecurityConfig": true,
"reregisteredPortalDatabase": true,
"reregisteredWebContextURL": true,
"itemUrls": {
"succeededCount": 58,
"failedCount": 0,
"failedItems": [],
"notProcessedCount": 0
},
"created": 1718121889216
}
}