/sensu-go/6.12/api/other/ Recent content in Other APIs on Sensu Docs Hugo -- gohugo.io en-us /sensu-go/6.12/api/other/auth/ Mon, 01 Jan 0001 00:00:00 +0000 /sensu-go/6.12/api/other/auth/ Generate an access token and a refresh token The /auth API endpoint provides HTTP GET access to generate an access token and a refresh token using Sensu’s basic authentication. The access and refresh tokens are JSON Web Tokens (JWTs) that Sensu issues to record the details of users’ authenticated Sensu sessions. The backend digitally signs these tokens, and the tokens can’t be changed without invalidating the signature. Example The following example queries the /auth API endpoint with a given username and password to determine whether the credentials are valid and retrieve an access token and a refresh token: /sensu-go/6.12/api/other/health/ Mon, 01 Jan 0001 00:00:00 +0000 /sensu-go/6.12/api/other/health/ Get health data for your Sensu instance The /health API endpoint provides HTTP GET access to health data for your Sensu instance. Example The following example demonstrates a GET request to the /health API endpoint: curl -X GET \ http://127.0.0.1:8080/health The request results in a successful HTTP/1.1 200 OK response and a JSON map that contains Sensu health data: { "Alarms": null, "ClusterHealth": [ { "MemberID": 2882886652148554927, "MemberIDHex": "8923110df66458af", "Name": "default", "Err": "", "Healthy": true } ], "Header": { "cluster_id": 4255616344056076734, "member_id": 2882886652148554927, "raft_term": 26 }, "PostgresHealth": [ { "Name": "my-postgres", "Active": false, "Healthy": false } ] } NOTE: If your Sensu instance is not configured to use a PostgreSQL datastore, the health payload will not include PostgresHealth. /sensu-go/6.12/api/other/license/ Mon, 01 Jan 0001 00:00:00 +0000 /sensu-go/6.12/api/other/license/ NOTE: Requests to /license API endpoints require you to authenticate with a Sensu API key or access token. The code examples in this document use the environment variable $SENSU_API_KEY to represent a valid API key in API requests. For more information about commercial features designed for enterprises, read Get started with commercial features. Get the active license configuration The /license API endpoint provides HTTP GET access to the active license configuration. /sensu-go/6.12/api/other/metrics/ Mon, 01 Jan 0001 00:00:00 +0000 /sensu-go/6.12/api/other/metrics/ Get Sensu metrics The /metrics API endpoint provides HTTP GET access to internal Sensu metrics in Prometheus format, including embedded etcd, memory usage, garbage collection, and gRPC metrics. Example The following example demonstrates a GET request to the /metrics API endpoint: curl -X GET \ http://127.0.0.1:8080/metrics The request results in a successful HTTP/1.1 200 OK response and plaintext output that contains internal Sensu metrics: # HELP etcd_debugging_mvcc_compact_revision The revision of the last compaction in store. /sensu-go/6.12/api/other/ready/ Mon, 01 Jan 0001 00:00:00 +0000 /sensu-go/6.12/api/other/ready/ Get API readiness data for your Sensu instance The /ready API endpoint provides HTTP GET access to information about whether your Sensu instance is ready to serve API requests. Example The following example demonstrates a GET request to the /ready API endpoint: curl -X GET \ http://127.0.0.1:8080/ready The request results in a successful HTTP/1.1 200 OK response and a text response body: ready If the backend configuration includes an api-serve-wait-time duration, the request will result in an HTTP/1. /sensu-go/6.12/api/other/version/ Mon, 01 Jan 0001 00:00:00 +0000 /sensu-go/6.12/api/other/version/ Get the Sensu backend and etcd versions The /version API endpoint provides HTTP GET access to the Sensu backend and etcd versions for the Sensu instance. Example The following example demonstrates a GET request to the /version API endpoint: curl -X GET \ http://127.0.0.1:8080/version The request results in a successful HTTP/1.1 200 OK response and a JSON map that contains Sensu version data: { "etcd": { "etcdserver": "3.5.0", "etcdcluster": "3.5.0" }, "sensu_backend": "6.