elasticsearch-key

An API key of Elasticsearch

Elasticsearch accepts an API key in the header Authorization: ApiKey <base64 of id:key>. The collector writes it with base64.encode and reads the health of the cluster, green, yellow or red.

How to read it

• base64.encode($id . ':' . $key): the bytes of the text in base64, the standard alphabet with its = padding.
• The key is a variable declared 'secret' => true, so the encoded text is a secret too: anything computed from a secret is one. It goes into a header, never into a value or a message, and only over https://.
• The answer is not a secret: the key went in a header, not in a body.
• watch.state raises a warning on yellow (a replica missing) and critical on red (a primary shard missing).

To adapt it

• OpenSearch with the security plugin takes an account in Basic instead: user= and password= (see examples/protocols/http-get-account).
• Any API that wants a value in base64 in a header follows the same line.