topic Re: How to check if an HEC is up or not before posting any data to it? in Getting Data In

How to check if an HEC is up or not before posting any data to it?

sathwikakamai — Thu, 28 Feb 2019 11:02:28 GMT

Hi, I am trying to post data to Splunk using HEC. But before posting I want to check if the endpoint I'm trying to post data to is up or not. How can I check that.

e.g: There is on HEC - Named Test with auth token "d51d25fc-6fa2-4841-b430-be55876332b7". I post data using curl request -
curl -k http://localhost:8088/services/collector -H 'Authorization: Splunk d51d25fc-6fa2-4841-b430-be55876332b7' -d '{"sourcetype": "input", "event":"Hello, World!"}'

How can we check if that particular endpoint is up and accepting data input.

Please note that this is our customer Splunk endpoint, hence we have only the HEC URL and AuthToken. And we don't want to post any dummy data just to check if the post is successful or not.

Re: How to check if an HEC is up or not before posting any data to it?

spavin — Sun, 03 Mar 2019 01:28:32 GMT

Hi @sathwikakamai,

If you are confident that the HEC endpoint is set up correctly, there are no firewall restrictions between you and it, and the authorization token is correct, you should be able to run the following curl command:

curl -k https://localhost:8088/services/collector -H 'Authorization: Splunk d51d25fc-6fa2-4841-b430-be55876332b7' -d ''

It will return something like:
{"text":"No data","code":5}

It will not submit any data to the index, but it will check that:

There are no firewall issues between where you ran the command and the HEC endpoint
The authentication token is correct, and working

You can add an additional check by supplying an index that you expect to be valid, while still not sending an event:

curl -k https://localhost:8088/services/collector -H 'Authorization: Splunk d51d25fc-6fa2-4841-b430-be55876332b7' -d '{"index":"my_index"}'

The response will either tell you that the index is incorrect (meaning the HEC endpoint doesn't allow adding events to that index), or that there was no event supplied - indicating that the index is allowed.

Re: How to check if an HEC is up or not before posting any data to it?

sathwikakamai — Fri, 29 Mar 2019 17:52:18 GMT

Thanks @spavin , it was very helpful.

Re: How to check if an HEC is up or not before posting any data to it?

Jeremiah — Tue, 16 Apr 2019 22:22:13 GMT

You can also check the health endpoint.

curl -k https://localhost:8088/services/collector/health

You should get a response similar to:

{"text":"HEC is healthy","code":17}

Note that this doesn't validate your token.

Re: How to check if an HEC is up or not before posting any data to it?

PvandenHondel — Tue, 12 Jul 2022 14:19:41 GMT

With these tests, I can check if the Splunk side of the HEC is correctly configured. Thanks @spavin!!

Re: How to check if an HEC is up or not before posting any data to it?

orangered6000 — Tue, 16 May 2023 03:43:04 GMT

Is this better than calling the /health endpoint? Or was this answer written before that existed?

IE: https://localhost:8088/services/collector/health