Hub 2018.1 Help

Create New Setting

Request

POST <REST API URL>/settings?fields=string
Parameter Description
fields Optional Lets you specify a subset of the fields to be returned. Use Fields Syntax to define the subset.

Request Body

settings

extended by backupSettings, clientCertAuthSettings, importSettings, internalSettings, jabberSettings, license, publicSettings, smtpSettings, throttlingSettings

{ "id": string, "aliasIds": [string, ...], "aliases": [alias, ...] }

Response

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 a message that describes the error.
403 Forbidden Requester has no access to the request.
404 Not Found Requested resource was not found.
500 Internal Server Error Failed to process request because of the server error. The response contains a message that describes the error.

Response body

settings

extended by backupSettings, clientCertAuthSettings, importSettings, internalSettings, jabberSettings, license, publicSettings, smtpSettings, throttlingSettings

{ "id": string, "aliasIds": [string, ...], "aliases": [alias, ...] }
Last modified: 5 April 2018