Skip To Content

Update Web Adaptor

  • URL:https://<webadaptor-url>/update (POST only)
  • Required Capability:Administrator
  • Version Introduced:10.1

Description

This operation allows you to update the description, HTTP port, and HTTPS port of a Web Adaptor that is registered with the server.

Note:

This operation is only meant to change the descriptive properties of the Web Adaptor and does not affect the configuration of the web server that deploys your Web Adaptor.

Request parameters

ParameterDetails
isAdminEnabled

A Boolean that specifies if admin access is enabled.

Values: on | off

description

A descriptive string for the Web Adaptor.

Example

description=Web Adaptor entry point for external users
httpPort

The HTTP port of the web server that runs the Web Adaptor.

Example

httpPort=-1
httpsPort

The HTTPS (SSL) port of the web server that runs the Web Adaptor.

Example

httpsPort=443
refreshServerListInterval

The refresh interval value.

Example

refreshServerListInterval=1
reconnectServerOnFailureInterval

The reconnect interval.

Example

reconnectServerOnFailureInterval=1
f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

Below is a sample POST request for update:


POST /webadaptor/admin/system/webadaptors/config/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

isAdminEnabled=on&description=Web Adaptor entry point for external users&httpPort=-1&httpsPort=443&refreshServerListInterval=1&reconnectServerOnFailureInterval=1&f=json

JSON Response example

{"status": "success"}