Update Web Adaptor

URL:
https://<root>/system/webadaptors/<webadaptor>/update
Methods:
POST
Required Capability:
Administrator
Version Introduced:
10.1

Description

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

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
Use dark colors for code blocksCopy
1
description=Web Adaptor entry point for external users

httpPort

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

Example
Use dark colors for code blocksCopy
1
httpPort=-1

httpsPort

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

Example
Use dark colors for code blocksCopy
1
httpsPort=443

refreshServerListInterval

The refresh interval value.

Example
Use dark colors for code blocksCopy
1
refreshServerListInterval=1

reconnectServerOnFailureInterval

The reconnect interval.

Example
Use dark colors for code blocksCopy
1
reconnectServerOnFailureInterval=1

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the update operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /webadaptor/admin/system/webadaptors/21964697-1a85-49f8-81f2-f16ba6cfa614/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=pjson

JSON Response example

Use dark colors for code blocksCopy
1
{"status": "success"}

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