/updatePortalUrl: Update Portal URL

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

Use dark colors for code blocksCopy
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: []

newUrl=https://modifiedPublicURL.domain.com/portal&f=pjson&token=<token>

Description

The updatePortalUrl 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:

Request parameters

ParameterDetails

newUrl

(Required)

Sets the new public-facing URL for ArcGIS Enterprise portal.

Use dark colors for code blocksCopy
1
newUrl=https://modifiedPublicURL.domain.com/portal

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:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "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
  }
}

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