13 anynode Configuration

13.1 Import

PUT https://<HOST>:<PORT>/api/anynodeConfig/set?version=0

Imports the given configuration without committing it.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • filepath

    The path to the configuration file.

  • commitProtection

    Type: Boolean

    If set to true, the imported configuration cannot be committed. It can only be viewed.

Request Body Structure

The request expects the .xzconfig file that should be imported.

13.2 Export

GET https://<HOST>:<PORT>/api/anynodeConfig/get?version=0

Returns the current anynode configuration.

Required Permissions

  • API

  • Configuration Mode Read Access

13.3 Commit

POST https://<HOST>:<PORT>/api/anynodeConfig/commit?version=0

Commits the current anynode configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Example

POST http://127.0.0.1:8110/api/anynodeConfig/commit?version=0

13.4 Revert

POST https://<HOST>:<PORT>/api/anynodeConfig/revert?version=0

Reverts the current anynode configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Example

POST http://127.0.0.1:8111/api/anynodeConfig/revert?version=0
HTTP Response
HTTP/1.1 200 OK

13.5 Clean

DELETE https://<HOST>:<PORT>/api/anynodeConfig/clean?version=0

Deletes everything from the current anynode configuration. This can still be reverted if it has not been committed.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Example

DELETE http://127.0.0.1:8111/api/anynodeConfig/clean?version=0
HTTP Response
HTTP/1.1 200 OK

13.6 State

GET https://<HOST>:<PORT>/api/anynodeConfig/status/get?version=0

Returns the current state of the configuration.

Required Permissions

  • API

  • Configuration Mode Read Access

Response Body Structure

The response body is structured as AnynodeConfigState JSON object. A description for its fields is at section 27.16.1. For the JSON schema refer to section 27.16.2.

Example

GET http://localhost:8088/api/anynodeConfig/status/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{"committed": false}