Description
REST Name
retrieve
Request
GET
URL
[server url][:port]/SAFe/sng_rest/api/retrieve/rest/configuration
Output
Name Data Possible Values Description
enable

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

RESTful API

Option to enable/disable RESTful API

api-key

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

API Key

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

Key is send using X-API-KEY header.

ip-whitelist

Type

  • Enumeration

Default

  • true

Rules

  • required

Values

  • false - Disable
  • true - Enable

IP White List

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