REST Tenant Configuration
- Mickey Bushman
- Jason Andrew
Resource URL Summary
Retrieve the Tenant Configuration
GET /up/v5/sysConfig
Update the Tenant Configuration
POST /up/v5/sysConfig
HTTP Headers
This API uses the standard ServiceBroker HTTP Headers.
API Specifics
Retrieve the Tenant Configuration
This REST API will return the current configuration belonging to the authenticated Tenant.
URL
GET /up/v5/sysConfig
HTTP Request Body
This request does not require a request body.
HTTP Response
Success
On success, an HTTP response code of 200 will be returned, and the response body will contain a REST Objects Configuration.
Error
Otherwise, on error, the API will:
- Return an HTTP response code of 400, if the request was invalid;
- Return an HTTP response code of 401, if the request was not authorized; or
- Return an HTTP response code of 500, if something else went wrong.
Both HTTP 400 and 500 responses will contain a REST Integration Standard Response Object with appropriate values for the Code and/or Message fields, describing the error, in the response body.
Update the Tenant Configuration
This REST API will update the current configuration belonging to the authenticated Tenant.
URL
POST /up/v5/sysConfig
HTTP Request Body
This request requires a REST Objects Configuration supplied in the HTTP request body.
HTTP Response
Success
On success, an HTTP response code of 200 will be returned.
Error
Otherwise, on error, the API will:
- Return an HTTP response code of 400, if the request was invalid;
- Return an HTTP response code of 401, if the request was not authorized; or
- Return an HTTP response code of 500, if something else went wrong.
Both HTTP 400 and 500 responses will contain a REST Integration Standard Response Object with appropriate values for the Code and/or Message fields, describing the error, in the response body.