Skip To Content

Update Web Adaptors Configuration

  • URL:https://<systems-url>/webadaptors/config/update(POST only)
  • Required Capability:Administrator
  • Version Introduced:10.8

Description

You can use this operation to change the configuration parameters and shared key.

Caution:
If the shared key parameter has been changed, you need to re-register each of your web adaptors so that they can pick up the updated key. The configuration must always have the shared key parameter.

Request parameters

ParameterDetails
webAdaptorsConfig

The sharedKey attribute must always be present in this JSON.

Example

webAdaptorsConfig={"sharedKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX"}
f

The response format. The default value is html.

Values: html | json

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: []

webAdaptorsConfig={"sharedKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX"}&f=json

JSON Response example

{"status": "success"}