/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
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:

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

Parameter	Details
`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. Note It is recommended that this operation is performed asynchronously. Only organizations with a small number of items, and few federated servers, should performed this operation synchronously. Values: `true` \| `false`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

newUrl

(Required)

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

Use dark colors for code blocksCopy
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
{
  "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
  }
}

If the async parameter is set as true, the request will return a job ID and job URL. The returned URL can be used to access the job resource and periodically poll the jobs status.

Use dark colors for code blocksCopy
{
  "jobId": "e8c9560278a94c6f88d8d4dbd82c863f",
  "key": "5qVOT43M4lcK_tcNKfIcdho2FOCN0NbvUwRxH7FuxI4",
  "jobUrl": "https://machine.domain.com/webadaptor/sharing/rest/portals/self/jobs/e8c9560278a94c6f88d8d4dbd82c863f"
}

Once the job is completed, the following response is returned:

Use dark colors for code blocksCopy
{
  "id": "3b030adbdb77497cbc036906f3984623",
  "definition": {
    "type": "reregisterPortalUrl",
    "siteKey": "0f207870-8b05-4c3b-8ea9-964beefbd035"
  },
  "status": "completed",
  "created": 1727130311697,
  "modified": 1727130382989,
  "messages": [
 "Started - Exporting items to package. update URL :https://modifiedPublicURL.domain.com/portal",
    "Completed - Exporting items to package. update URL :https://modifiedPublicURL.domain.com/portal",
    "Started - Updating portal url of federated server security config to https://modifiedPublicURL.domain.com/portal",
    "Updated portal url of federated server: https://machine2.domain.com/server's security config to https://modifiedPublicURL.domain.com/portal",
    "Updated portal url of federated server: https://machine3.domain.com/server's security config to https://modifiedPublicURL.domain.com/portal"
  ],
  "result": {
    "reregisterUrlResults": {
      "type": "reregisterPortalUrl",
      "id": "0f207870-8b05-4c3b-8ea9-964beefbd035",
      "reregisterURL": "https://modifiedPublicURL.domain.com/portal",
      "reregisteredServerSecurityConfig": true,
      "reregisteredPortalDatabase": true,
      "reregisteredWebContextURL": true,
      "itemUrls": {
        "succeededCount": 50,
        "failedCount": 0,
        "failedItems": [],
        "notProcessedCount": 0
      },
      "created": 1727130311698
    }
  }
}