Skip to content
URL:
https://<root>/system/webadaptors
Methods:
GET
Child Resources:
Configuration, Web Adaptor
Version Introduced:
12.0

Description

The webadaptors resource lists each web adaptors that have been registered with the site. The server will trust all these web adaptors and will authorize calls from these servers. To configure a new web adaptor with the server, you'll need to use the configuration web page or the command line utility. For full instructions, see Configuring the Web Adaptor after installation.

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 for the webadaptors resource:

Use dark colors for code blocksCopy
1
https://organization.example.com/<context>/admin/system/webadaptors?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
{
  "webadaptors": [ <webadaptor1>, <webadaptor2>]
}

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.