Skip to content
URL:
https://<root>/system/webadaptors/<webadaptor>
Methods:
GET
Operations:
Unregister
Version Introduced:
12.0

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 ArcGIS Video 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 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 server. The back-end 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 server.

Request parameters

ParameterDetails

f

(Required)

The response format. The default response format is html.

Values: html | json | pjson

token

(Required)

Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

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://organization.example.com/<context>/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
10
11
{
  "id": "<id>",
  "webAdaptorURL": "<url>",
  "description": "<description>",
  "httpPort": <httpPort>,
  "httpsPort": <httpsPort>,
  "refreshServerListInterval": "<listInterval>",
  "isAdminEnabled": <true|false>,
  "machineName": "<serverName>",
  "machineIp": "<machineIP>"
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
{
    "reconnectServerOnFailureInterval": 1,
    "webAdaptorURL": "https://organization.example.com/video",
    "httpPort": -1,
    "isAdminEnabled": true,
    "id": "24c138d5-48ef-4147-9a49-b6a125f96bb3",
    "refreshServerListInterval": 1,
    "httpsPort": 443,
    "machineName": "test_machine",
    "machineIP": "192.168.1.98"
}

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