PatchPolarClawConfig

Updated at:
Copy as MD

Updates a PolarClaw configuration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

ApplicationId

string

Yes

The application ID.

pa-**************

ConfigPatch

object

No

A JSON merge-patch object.

{ "tools": { "web": { "search": { "enabled": false } } } }

Restart

boolean

No

Specifies whether to restart the gateway after applying the patch. The default is true.

true

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The request ID.

3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF

Message

string

The message.

successful

Code

integer

The status code.

200

ApplicationId

string

The application ID.

pa-**************

Ok

boolean

Indicates whether the operation was successful.

true

Restarted

boolean

Indicates whether the gateway was restarted.

true

PatchedKeys

array

A list of the top-level configuration keys that were modified.

string

A top-level configuration key.

tools

Examples

Success response

JSON format

{
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "Message": "successful",
  "Code": 200,
  "ApplicationId": "pa-**************",
  "Ok": true,
  "Restarted": true,
  "PatchedKeys": [
    "tools"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.