Config Rest API

Overview

Resource	Operation	Description
Config	GET /config/(section)	List full config.
OptionGetDel	DELETE /config/(section)/(option)	delete an option.
	GET /config/(section)/(option)	get config value.
OptionSet	PUT /config/(section)/(option)/(value)	set config value.
Section	GET /config/(section)	List config section.

Details

PUT /config/(section)/(option)/(value)

Set the value of an option. If the option does not exist, create it.

Status Codes

• 201 Created – Option successfully created or updated.

• 401 Unauthorized – Invalid Auth Token.

• 500 Internal Server Error – Configuration Error.

DELETE /config/(section)/(option)

Delete an option.

Status Codes

• 200 OK – OK.

• 401 Unauthorized – Invalid Auth Token.

• 500 Internal Server Error – Internal Error.

GET /config/(section)/(option)

Retrieve the value of an option.

Parameters

• section – The section name.

Response Headers

• Content-Type – application/json

Status Codes

• 200 OK – OK.

• 401 Unauthorized – Invalid Auth Token.

• 404 Not Found – Config not found.

• 406 Not Acceptable – Not Acceptable.

• 500 Internal Server Error – Internal Error.

GET /config/(section)

List configuration of a section

Parameters

• section – The section name.

Response Headers

• Content-Type – application/json

Status Codes

• 200 OK – OK.

• 401 Unauthorized – Invalid Auth Token.

• 404 Not Found – Config not found.

• 406 Not Acceptable – Not Acceptable.

• 500 Internal Server Error – Internal Error.

GET /config/(section)

List full configuration.

Response Headers

• Content-Type – application/json

Status Codes

• 200 OK – OK.

• 401 Unauthorized – Invalid Auth Token.

• 406 Not Acceptable – Not Acceptable.

• 500 Internal Server Error – Internal Error.