License management API

The /license API endpoints

For more information about commercial features designed for enterprises, see the getting started guide.

/license (GET)

The /license API endpoint provides HTTP GET access to the active license configuration.

API Specification

/license (GET)
description Returns the active commercial license configuration. To download your license, log in to your Sensu account or contact the Sensu sales team for a free trial.
example url http://hostname:8080/api/enterprise/licensing/v2/license
response type Map
response codes
  • Success: 200 (OK)
  • Error: 500 (Internal Server Error)

/license (PUT)

The /license API endpoint provides HTTP PUT access to activate a commercial license.

API Specification

/license (PUT)
description Activates a commercial license, or updates an existing license configuration. To download your license, log in to your Sensu account or contact the Sensu sales team for a free trial.
example url http://hostname:8080/api/enterprise/licensing/v2/license
payload License definition
response codes
  • Success: 201 (Created)
  • Malformed: 400 (Bad Request)
  • Error: 500 (Internal Server Error)

/license (DELETE)

The /license API endpoint provides HTTP DELETE access to remove a commercial license.

API Specification

/license (DELETE)
description Removes the commercial license.
example url http://hostname:8080/api/enterprise/licensing/v2/license
response codes
  • Success: 204 (No Content)
  • Missing: 404 (Not Found)
  • Error: 500 (Internal Server Error)
output
curl -X DELETE -H "Authorization: Bearer $SENSU_TOKEN"  http://localhost:8080/api/enterprise/licensing/v2/license

HTTP/1.1 204 No Content