Hub 2017.2 Help

Get All Settings


GET <REST API URL>/settings?fields=string&$skip=int&$top=int&query=string
Parameter Description
fields Optional query parameter. Specifies a subset of the fields to be returned. Use Fields Syntax to define subset.
$skip Optional query parameter. Number of roles to skip before returning first entry of the page.
$top Optional query parameter. Max number of roles to return in the page.

Filter query. See Query Syntax for the definition of supported logical operations syntax. Following fields and tuples are supported for Settings:

id: value — Settings by given id

type: license — Get license settings

type: public — Get public settings

type: internal — Get internal settings

type: smtp — Get smtp settings

type: jabber — Get jabber settings

type: backup — Get jabber settings


Response Code Meaning
200 OK Successful request.
400 Bad Request Some of the parameters of the request are invalid (for example, required fields in the passed JSON object are missing). The response contains message describing the error.
403 Forbidden Requester has no access to the request.
404 Not Found Requested resource wasn't found.
500 Internal Server Error Failed to process request because of the server error. The response contains message describing the error.

Response body


{ "skip": int, "top": int, "total": int, "settings": [settings, ...] }
Last modified: 19 July 2017