Web Adaptor

URL:
https://<root>/system/webadaptors/<webadaptor>
Methods:
GET
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
10.1

Description

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

The 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 the back-end GIS Server in a round-robin fashion. The Web Adaptor acts a reverse proxy, providing the end users with an entry point into the system, hiding the GIS servers, and providing some degree of immunity from back-end failures.

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

Most importantly, a Web Adaptor provides your end users with a well-defined entry point into your system without exposing the internal details of your GIS server. The back-end GIS server will trust requests being forwarded by one or more of such registered Web Adaptors 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 GIS server.

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 used to access an individual web adaptor resource:

Use dark colors for code blocksCopy
1
https://machine.domain.com/webadaptor/admin/system/webadaptors/bb2873dd-a52c-49b2-9de6-4790f5c2e638?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{
  "id": "<id>",
  "webAdaptorURL": "<url>",
  "description": "<description>",
  "httpPort": <httpPort>,
  "httpsPort": <httpsPort>,
  "isAdminEnabled": <true|false>,
  "serverName": "<serverName>"
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{
  "id": "9c5c8fd4-a611-444e-ad06-b9f8be4a9aff",
  "webAdaptorURL": "https://www.gis.com/arcgis",
  "description": "External server",
  "httpPort": 80,
  "httpsPort": 443,
  "isAdminEnabled": true,
  "serverName": "www.gis.com"
}

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