Web Adaptor

URL:
https://<root>/system/webadaptors/<webadaptorID>
Methods:
GET
Operations:
Unregister Web Adaptor
Required Capability:
Access allowed with the "Security and Infrastructure" privilege
Version Introduced:
10.2.1

Description

The resource for an individual web adaptor returns the properties of a web adaptor, such as its HTTP and HTTPS ports and description.

The ArcGIS Web Adaptor is a web application that runs in a front-end web server. One of the web adaptor's primary responsibilities is to forward HTTP requests from end users to Portal for ArcGIS. The web adaptor acts a reverse proxy, providing the end users with an entry point to the system, hiding the back-end servers, and providing some degree of immunity from back-end failures.

The front-end web server can authenticate incoming requests against your enterprise identity stores and provide specific authentication schemes such as Integrated Windows Authentication (IWA), HTTP Basic, or Digest.

Most importantly, a web adaptor provides your end users with a well-defined entry point to your system without exposing the internal details of your portal. Portal for ArcGIS will trust requests being forwarded by the web adaptor and will not challenge the user for any credentials. However, the authorization of the request (by looking up roles and permissions) is still enforced by the portal's sharing rules.

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL for used to access an individual webadaptor resource:

Use dark colors for code blocksCopy
1
https://machine.domain.com/webadaptor/portaladmin/system/webadaptors/a62c3fed-50f9-4f15-83fa-aec7a4172af4?f=json

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
{
  "id": "<id>",
  "webAdaptorURL": "<url>",
  "description": "<description>",
  "httpPort": <httpPort>,
  "httpsPort": <httpsPort>,
  "machineName": "<machineName>",
  "machineIP": "<machineIP>",
  "refreshServerListInterval": <number>,
  "reconnectServerOnFailureInterval": <number>
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
{
  "machineName": "machine.domain.com",
  "machineIP": "192.168.14.15",
  "webAdaptorURL": "https://myorg.com/gis",
  "id": "8b2846c8-984e-43a9-805b-61fc22d0a2e3",
  "description": "Web adaptor for Portal for ArcGIS",
  "httpPort": 80,
  "httpsPort": 443,
  "refreshServerListInterval": 1,
  "reconnectServerOnFailureInterval": 1
}

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