- URL:
- https://<root>/portals/[portalID]/urls/updatePortalUrl
- 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: []
newUrl=https://modifiedPublicURL.domain.com/portal&f=pjson&token=<token>
Description
The update
operation modifies the public-facing URL for ArcGIS Enterprise portal. This operation supports modifying the domain, subdomain, and context of the URL. When this operation is performed, the Enterprise portal items that used the previous URL are updated to use the new URL. Performing this operation will cause Enterprise portal to restart, resulting in the system being unavailable for some time.
To ensure that the organization's resources will remain accessible after the update, the URLs for each federated server will also need to be updated.
When a URL is updated, the following areas will be impacted:
- ArcGIS Pro users will need to update their connections to Enterprise portal with the new URL.
- Preexisting distributed collaborations will need to be recreated by removing and inviting participants back to the collaboration.
- Organizations that have configured OpenID Connect logins will need to update the OIDC IDP configuration with the new login and logout redirect URLs.
- Organizations that have configured a SAML-compliant identity provider will need to download and import the updated portal metadata file to the identity provider.
Request parameters
Parameter | Details |
---|---|
(Required) | Sets the new public-facing URL for ArcGIS Enterprise portal.
|
| 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": "reregisterPortalUrl",
"id": "0f207870-8b05-4c3b-8ea9-964beefbd035",
"reregisterURL": "https://modifiedPublicURL.domain.com/portal",
"reregisteredServerSecurityConfig": true,
"reregisteredPortalDatabase": false,
"reregisteredWebContextURL": true,
"itemUrls": {
"succeededCount": 58,
"failedCount": 0,
"failedItems": [
],
"notProcessedCount": 0
},
"created": 1727131308924
}
}