/generateOrgUrlMap: Generate Organization URL Map

URL:: https://<root>/portals/[portalID]/urls/generateOrgUrlMap
Methods:: POST
Version Introduced:: 11.4

Example usage

The following is a sample ArcGIS Enterprise POST request for the generateOrgUrlMap operation:

Use dark colors for code blocksCopy
POST /webadaptor/sharing/rest/portals/0123456789ABCDEF/urls/generateOrgUrlMap HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

f=pjson&token=<token>

Description

The generateOrgUrlMap operation returns a report of the organization's Enterprise portal and federated servers. The report includes an inventory of all the URLs for an organization, including the WebContextURL URLs that have been configured for ArcGIS Enterprise portal and federated servers. The id value returned for each federated server can be used with the Generate URL Report and Update Federated Server URL operations.

Request parameters

Parameter	Details
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

JSON Response example

Use dark colors for code blocksCopy
{
  "siteUrlMap": {
    "portal": {
      "id": "d31fa679-968e-41d1-a3d3-8b8c76d9bc54",
      "webContextUrl": "https://publicUrlPortal.domain.com/portal",
      "portalLocalHostname": "MACHINE1.DOMAIN.COM",
      "portalLocalHttpPort": 7080,
      "portalLocalHttpsPort": 7443,
      "machines": [
        {
          "machineName": "MACHINE.DOMAIN.COM",
          "adminURL": "https://machine1.domain.com:7443/arcgis",
          "role": "",
          "platform": "Windows Server 2022-amd64-10.0"
        }
      ]
    },
    "servers": [
      {
        "id": "LsoQCXJ3KxIcQNLT",
        "name": "machine2.domain.com:6443",
        "adminUrl": "https://machine2.domain.com:6443/arcgis",
        "url": "https://publicURLFederatedServer.domain.com/dataserver",
        "webContextUrl": "https://publicURLFederatedServer.domain.com/dataserver",
        "isHosted": false,
        "serverType": "ArcGIS",
        "serverRole": "FEDERATED_SERVER",
        "serverFunction": "",
        "machines": [
          {
            "machineName": "MACHINE2.DOMAIN.COM",
            "adminURL": "https://MACHINE2.DOMAIN.COM:6443/arcgis/admin",
            "synchronize": false,
            "underMaintenance": false
          },
          {
            "machineName": "MACHINE3.DOMAIN.COM",
            "adminURL": "https://MACHINE3.DOMAIN.COM:6443/arcgis/admin",
            "synchronize": false,
            "underMaintenance": false
          }
        ]
      },
      {
        "id": "PAf9Y5TdsDb1uQkm",
        "name": "machine4.domain.com:6443",
        "adminUrl": "https://machine4.domain.com:6443/arcgis",
        "url": "https://publicURLHostingServer.domain.com/server",
        "webContextUrl": "https://publicURLHostingServer.domain.com/server",
        "isHosted": true,
        "serverType": "ArcGIS",
        "serverRole": "HOSTING_SERVER",
        "serverFunction": "",
        "machines": [
          {
            "machineName": "MACHINE4.DOMAIN.COM",
            "adminURL": "https://MACHINE4.DOMAIN.COM:6443/arcgis/admin",
            "synchronize": false,
            "underMaintenance": false
          }
        ]
      },
      {
        "id": "p0khDc7XHwAUyIuF",
        "name": "machine5.domain.com:6443",
        "adminUrl": "https://machine5.domain.com:6443/arcgis",
        "url": "https://publicURLImageServer.domain.com/image",
        "webContextUrl": "https://publicURLImageServer.domain.com/image",
        "isHosted": false,
        "serverType": "ArcGIS",
        "serverRole": "FEDERATED_SERVER",
        "serverFunction": "ImageHosting",
        "machines": [
          {
            "machineName": "MACHINE5.DOMAIN.COM",
            "adminURL": "https://MACHINE5.DOMAIN.COM:6443/arcgis/admin",
            "synchronize": false,
            "underMaintenance": false
          }
        ]
      }
    ]
  }
}