/updateFederatedServerUrl: Update Federated Server URL

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 updateFederatedServerUrl operation:

1
2
3
4
5
6
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 updateFederatedServerUrl 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

ParameterDetails

serverId

(Required)

The ID of the federated server. This value is retrieved from the Generate Organization URL Map operation.

1
serverId=PAf9Y5TdsDb1uQkm

newUrl

(Required)

Sets the new public-facing URL for the federated server.

1
newUrl=https://modifiedPublicURL.domain.com/server

async

If true, the request is run as an asynchronous job. If set as true, the response will return job details.

Values: true | false

f

The response format. The default format is html.

Values: html | json | pjson

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:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "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
  }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close