Tessen API
NOTE: Requests to the Tessen API require you to authenticate with a Sensu access token or API key.
The code examples in this document use the environment variable $SENSU_API_KEY
to represent a valid API key in API requests.
The Tessen API provides HTTP access to manage Tessen configuration.
Access to the Tessen API is restricted to the default admin
user.
Get the active Tessen configuration
The /tessen
API endpoint provides HTTP GET access to the active Tessen configuration.
Example
The following example demonstrates an HTTP GET request to the /tessen
API endpoint.
The request returns an HTTP 200 OK
response and a JSON map that contains the active Tessen configuration, indicating whether Tessen is enabled.
curl -X GET \
http://127.0.0.1:8080/api/core/v2/tessen \
-H "Authorization: Key $SENSU_API_KEY"
HTTP/1.1 200 OK
{
"opt_out": false
}
API Specification
/tessen (GET) | |
---|---|
description | Returns the active Tessen configuration. An "opt_out": false response indicates that Tessen is enabled. An "opt_out": true response indicates that Tessen is disabled. |
example url | http://hostname:8080/api/core/v2/tessen |
response type | Map |
response codes |
|
example output |
|
Opt in to or out of Tessen
The /tessen
API endpoint provides HTTP PUT access to opt in to or opt out of Tessen for unlicensed Sensu instances.
NOTE: Tessen is enabled by default on Sensu backends and required for licensed Sensu instances. If you have a licensed instance and want to opt out of Tessen, contact your account manager.
Example
In the following example, an HTTP PUT request is submitted to the /tessen
API endpoint to opt in to Tessen using the opt_out
attribute.
The request returns an HTTP 200 OK
response and the resulting Tessen configuration.
curl -X PUT \
-H "Authorization: Key $SENSU_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"opt_out": false
}' \
http://127.0.0.1:8080/api/core/v2/tessen
HTTP/1.1 200 OK
{
"opt_out": false
}
API Specification
/tessen (PUT) | |
---|---|
description | Updates the active Tessen configuration for unlicensed Sensu instances. Tessen is enabled by default on Sensu backends and required for licensed Sensu instances. |
example url | http://hostname:8080/api/core/v2/tessen |
request parameters | Required: opt_out (for unlicensed instances, set to false to enable Tessen; set to true to opt out of Tessen). |
response codes |
|
example output |
|