You can use the Media Server REST API to view, configure, and manage settings for Web Pages and Integrations. This approach is useful when you need to configure multiple pages at once or automate your setup using scripts.

While the desktop client separates Web pages and Integrations in the user interface, both use the same underlying API endpoints. The primary difference is that integrations can interact with the Client API.

Update Web Page settings

Follow these steps to retrieve a Web Page's current configuration, modify its settings, and save the changes back to the Media Server:

1. Retrieve the Web Page ID and configuration: Send a GET request to the Web Pages endpoint to collect the parameters and unique identifiers of your Web Pages:

   GET /rest/v4/webPages

   Example response:

   [
     {
       "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
       "parentId": "00000000-0000-0000-0000-000000000000",
       "name": "Web page",
       "url": "https://example.com",
       "certificateCheck": true,
       "proxyDomainAllowList": [],
       "parameters": {}
     }
   ]

2. Construct the update payload: Identify the id of the Web Page you want to update. Prepare a JSON payload that contains only the fields you want to change.

   For example, to disable SSL certificate checking and set an auto-refresh interval of 30 seconds, construct the following payload:

   {
     "certificateCheck": false,
     "parameters": {
       "refreshIntervalS": 30
     }
   }

3. Apply the configurations to the Media Server: Send a PATCH request containing your JSON payload to the specific web page resource URL:

   PATCH /rest/v4/webPages/{web_page_id}

Map UI settings to API fields

To modify settings through the API, map the options in the Desktop Client to JSON fields in the API payload:

• Proxy this Web Page through the Media Server

  • API field: parentId

  • Enable: Set to the specific Media Server ID string (obtained from GET /rest/v4/servers).

  • Disable: Set to "00000000-0000-0000-0000-000000000000".

• Allow opening this Web Page without SSL certificate checking

  • API field: certificateCheck

  • Enable (Bypass check): Set to false.

  • Disable (Enforce check): Set to true.

  • Note: The API logic is inverted relative to the client checkbox. Setting this field to true enables validation, which is the secure default.

• Proxy all requested contents

  • API field: proxyDomainAllowList

  • Enable: Include "*" in the array.

  • Disable: Omit "*" from the array.

• Auto-refresh the Web Page

  • API field: parameters.refreshIntervalS

  • Enable: Set to the desired number of seconds (integer).

  • Disable: Set to 0.

• Force open in a dedicated window

  • API field: parameters.dedicatedWindowSettings

  • Enable: Set to {"enabled": true} along with any additional window properties.

  • Disable: Set to {"enabled": false}.

Understand parentId

For most system resources, parentId defines hierarchy or nesting in a resource tree. For web pages and integrations, parentId specifies the proxy server. To find available server IDs, send a GET request to /rest/v4/servers.

Handle the etag field

The etag field might appear in the response body. The system uses it internally for change notifications. The system ignores this field in POST, PUT, or PATCH requests, so do not include it in your requests.

Differences between web pages and integrations

Starting from VMS 6.1 Web Pages are separated from Integrations. The Desktop Client no longer displays an Allow using Client API checkbox on a Web Page. Instead, it displays this notice:

To allow the use of a client API, create a eb integration instead.

It also provides a separate New Integration… command. Under the hood, an Integration is a Web Page whose subtype parameter is set to clientApi. When set, the Web Page gains permission to call the Desktop Client's JavaScript API and request access to the user session.

• To convert a Web Page to an Integration, set the subtype parameter to clientApi:

  {
    "parameters": {
      "subtype": "clientApi"
    }
  }

• To convert an Integration back to a plain web page, clear the subtype value:

  {
    "parameters": {
      "subtype": ""
    }
  }

Final note

Whenever possible, create Integrations directly rather than converting a Web Page through the API. Use the API conversion primarily for automated scripts or bulk migrations of assets created before version 6.1.