Tessen API
The /tessen
API endpoints
The Tessen API provides HTTP access to manage Tessen configuration.
Access to the Tessen API is restricted to the default admin
user.
/tessen
(GET)
The /tessen
API endpoint provides HTTP GET access to Tessen configuration.
EXAMPLE
The following example demonstrates an HTTP GET request to the /tessen
API.
curl -H "Authorization: Bearer $SENSU_TOKEN" http://127.0.0.1:8080/api/core/v2/tessen
The request returns a 200 (OK) HTTP response code and a JSON map containing Tessen configuration, indicating that Tessen is enabled.
HTTP/1.1 200 OK
{"opt_out": false}
API Specification
/tessen (GET) | |
---|---|
description | Returns the active Tessen configuration. A response of "opt_out": false indicates that Tessen is enabled; a response of "opt_out": true indicates that Tessen is disabled. |
example url | http://hostname:8080/api/core/v2/tessen |
response type | Map |
response codes |
|
example output |
|
/tessen
(PUT)
The /tessen
API endpoint provides HTTP PUT access to opt in to or opt out of Tessen.
Tessen is enabled by default on Sensu backends and required for licensed Sensu instances.
EXAMPLE
In the following example, an HTTP PUT request is submitted to the /tessen
API to opt in to Tessen using the opt_out
attribute.
curl -X PUT \
-H "Authorization: Bearer $SENSU_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"opt_out": false}' \
http://127.0.0.1:8080/api/core/v2/tessen
The request returns a 200 (OK) HTTP response code and the resulting Tessen configuration.
HTTP/1.1 200 OK
{"opt_out": false}
API Specification
/tessen (PUT) | |
---|---|
description | Updates Tessen configuration. Licensed Sensu instances override the opt_out attribute to false at runtime. |
example url | http://hostname:8080/api/core/v2/tessen |
request parameters | opt_out (required): Set to false to enable Tessen; set to true to opt out of Tessen. |
response codes |
|