Description

Configuration

REST Name
configuration
Methods
retrieve
Retrieve
update
Update
Properties
Name Data Possible Values Description
enable

Type

  • Enumeration

Default

  • true

Rules

  • required

Values

  • true - Enable
  • false - Disable

RESTful API

Option to enable/disable RESTful API

ip-whitelist

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • true - Enable
  • false - Disable

IP White List

Any client connecting to RESTful API will be checked against the list of allowed IP addresses.

api-key

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • true - Enable
  • false - Disable

API Key

Any client connecting to RESTful API will be checked against the api key.

Key is send using X-API-KEY header.