Sensu Aggregates API

Reference documentation

The /aggregates API endpoint

The /aggregates API endpoint provides HTTP GET access to named aggregate data.

/aggregates (GET)

EXAMPLES

The following example demonstrates a /aggregates API query which results in a JSON Array of JSON Hashes containing named check aggregates.

$ curl -s http://localhost:4567/aggregates | jq .
[
  {"name": "check_http"},
  {"name": "check_web_app"},
  {"name": "elasticsearch_health"}
]

API specification

/aggregates (GET)
desc
Returns the list of named aggregates.
example url
http://hostname:4567/aggregates
parameters
  • max_age:
    • required: false
    • type: Integer
    • description: the maximum age of results to include, in seconds.
response type
Array
response codes
  • Success: 200 (OK)
  • Error: 500 (Internal Server Error)
output
[
  {"name": "check_http"},
  {"name": "check_web_app"},
  {"name": "elasticsearch_health"}
]

The /aggregates/:name API endpoints

The /aggregates/:name API endpoints provide HTTP GET and HTTP DELETE access to check aggregate data for a named aggregate.

/aggregates/:name (GET)

EXAMPLES

The following example demonstrates a /aggregates/:name API query for the check result data for the aggregate named example_aggregate.

$ curl -s http://localhost:4567/aggregates/example_aggregate | jq .
{
  "clients": 15,
  "checks": 2,
  "results": {
    "ok": 18,
    "warning": 0,
    "critical": 1,
    "unknown": 0,
    "total": 19,
    "stale": 0
  }
}

API specification

/aggregates/:name (GET)
desc
Returns the list of aggregates for a given check.
example url
http://hostname:4567/aggregates/elasticsearch
parameters
  • max_age:
    • required: false
    • type: Integer
    • description: the maximum age of results to include, in seconds.
response type
Array
response codes
  • Success: 200 (OK)
  • Missing: 404 (Not Found)
  • Error: 500 (Internal Server Error)
output
{
  "clients": 15,
  "checks": 2,
  "results": {
    "ok": 18,
    "warning": 0,
    "critical": 1,
    "unknown": 0,
    "total": 19,
    "stale": 0
  }
}

/aggregates/:name (DELETE)

EXAMPLES

The following example demonstrates a /aggregates/:name API request to delete named aggregate data for the aggregate named example_aggregate, resulting in a 204 (No Content) HTTP response code (i.e. HTTP/1.1 204 No Content).

$ curl -s -i -X DELETE http://localhost:4567/aggregates/example_aggregate
HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Connection: close
Server: thin

API specification

/aggregates/:name (DELETE)
desc
Deletes all aggregate data for a named aggregate.
example url
http://hostname:4567/aggregates/elasticsearch
response type
HTTP-header only (no output)
response codes
  • Success: 204 (No Content)
  • Missing: 404 (Not Found)
  • Error: 500 (Internal Server Error)
output
HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Connection: close
Server: thin

The /aggregates/:name/clients API endpoint

The /aggregates/:name/clients API endpoint provides HTTP GET access to the Sensu client members of a named aggregate.

/aggregates/:name/clients (GET)

EXAMPLES

The following example demonstrates a /aggregates/:name/clients API query for the client members of an aggregate named elasticsearch.

$ curl -s http://localhost:4567/aggregates/elasticsearch/clients | jq .
[
  {
    "name": "1-424242",
    "checks": [
      "elasticsearch_service",
      "elasticsearch_cluster_health"
    ]
  },
  {
    "name": "1-424243",
    "checks": [
      "elasticsearch_service"
    ]
  },
]

API specification

/aggregates/:name/clients (GET)
desc
Returns the client members of a named aggregate.
example URL
http://hostname:4567/aggregates/elasticsearch/clients
response type
Array
response codes
  • Success: 200 (OK)
  • Missing: 404 (Not Found)
  • Error: 500 (Internal Server Error)
output
[
  {
    "name": "1-424242",
    "checks": [
      "elasticsearch_service",
      "elasticsearch_cluster_health"
    ]
  },
  {
    "name": "1-424243",
    "checks": [
      "elasticsearch_service"
    ]
  },
]

The /aggregates/:name/checks API endpoint

The /aggregates/:name/checks API endpoint provides HTTP GET access to the Sensu check members of a named aggregate.

/aggregates/:name/checks (GET)

EXAMPLES

The following example demonstrates a /aggregates/:name/checks API query for the check members of an aggregate named elasticsearch.

$ curl -s http://localhost:4567/aggregates/elasticsearch/checks | jq .
[
  {
    "name": "elasticsearch_service",
    "clients": [
      "1-424242",
      "i-424243"
    ]
  },
  {
    "name": "elasticsearch_cluster_health",
    "clients": [
      "1-424242"
    ]
  }
]

API specification

/aggregates/:name/checks (GET)
desc
Returns the check members of a named aggregate.
example URL
http://hostname:4567/aggregates/elasticsearch/checks
response type
Array
response codes
  • Success: 200 (OK)
  • Missing: 404 (Not Found)
  • Error: 500 (Internal Server Error)
output
[
  {
    "name": "elasticsearch_service",
    "clients": [
      "1-424242",
      "i-424243"
    ]
  },
  {
    "name": "elasticsearch_cluster_health",
    "clients": [
      "1-424242"
    ]
  }
]

The /aggregates/:name/results/:severity API endpoint

The /aggregates/:name/results/:severity API endpoint provides HTTP GET access to check result members of a named aggregate, by severity.

/aggregates/:name/results/:severity (GET)

EXAMPLES

The following example demonstrates a /aggregates/:name/results/:severity API query for the critical check results of an aggregate named elasticsearch.

$ curl -s http://localhost:4567/aggregates/elasticsearch/results/critical | jq .
[
  {
    "check": "elasticsearch_cluster_health",
    "summary": [
      {
        "output": "Everything is Broken!",
        "total": 1,
        "clients": ["i-424242"]
      }
    ]
  }
]

API specification

/aggregates/:name/results/:severity (GET)
desc
Returns the check result members of a named aggregate, by serverity.
example URL
http://hostname:4567/aggregates/elasticsearch/results/critical
response type
Array
parameters
  • max_age:
    • required: false
    • type: Integer
    • description: the maximum age of results to include, in seconds.
allowed values
warning, critical, unknown
response codes
  • Success: 200 (OK)
  • Missing: 404 (Not Found)
  • Error: 500 (Internal Server Error)
output
[
  {
    "check": "elasticsearch_cluster_health",
    "summary": [
      {
        "output": "Everything is Broken!",
        "total": 1,
        "clients": ["i-424242"]
      }
    ]
  }
]

Start your FREE trial today.

Already using Sensu Core? Upgrade to Sensu Enterprise today to take advantage of its enterprise console, added-value features, built-in integrations, FREE annual training, and enterprise-class support.