# Send health data

## Overview

StackState can synchronize health information from your own data sources either via HTTP or the [StackState CLI](https://archivedocs.stackstate.com/5.1/setup/cli).

## StackState Receiver API

The StackState Receiver API accepts topology, metrics, events and health data in a common JSON object. The default location for the receiver API is the `<STACKSTATE_RECEIVER_API_ADDRESS>`, constructed using the `<STACKSTATE_BASE_URL>` and <`STACKSTATE_RECEIVER_API_KEY>`.

{% tabs %}
{% tab title="Kubernetes" %}
The `<STACKSTATE_RECEIVER_API_ADDRESS>` for StackState deployed on Kubernetes or OpenShift is:

```
https://<STACKSTATE_BASE_URL>/receiver/stsAgent/intake?api_key=<STACKSTATE_RECEIVER_API_KEY>
```

The `<STACKSTATE_BASE_URL>` and `<STACKSTATE_RECEIVER_API_KEY>` are set during StackState installation, for details see [Kubernetes install - configuration parameters](https://archivedocs.stackstate.com/5.1/setup/install-stackstate/kubernetes_openshift/kubernetes_install#generate-values-yaml).
{% endtab %}

{% tab title="Linux" %}
The `<STACKSTATE_RECEIVER_API_ADDRESS>` for StackState deployed on Linux is:

```
https://<STACKSTATE_BASE_URL>:<STACKSTATE_RECEIVER_PORT>/stsAgent/intake?api_key=<STACKSTATE_RECEIVER_API_KEY>
```

The `<STACKSTATE_BASE_URL>` and `<STACKSTATE_RECEIVER_API_KEY>` are set during StackState installation, for details see [Linux install - configuration parameters](https://archivedocs.stackstate.com/5.1/setup/install-stackstate/linux/install_stackstate#configuration-options-required-during-install).
{% endtab %}
{% endtabs %}

## JSON

### Common JSON object

Topology, telemetry and health data are sent to the receiver API via HTTP POST. There is a common JSON object used for all messages.

```javascript
{
  "collection_timestamp": 1548855554, // the epoch timestamp for the collection
  "events": {}, // used to send events data
  "internalHostname": "localdocker.test", // the host sending this data
  "metrics": [], // used to send metrics data
  "service_checks": [],
  "topologies": [], // used to send topology data
  "health": // used for sending health data
}
```

### JSON health payload

StackState accepts health data based on a chosen [consistency model](https://archivedocs.stackstate.com/5.1/configure/health-synchronization#consistency-models). The message that can be sent for each model are described on the pages below:

* [Repeat Snapshots JSON](https://archivedocs.stackstate.com/5.1/configure/health/send-health-data/repeat_snapshots)
* [Repeat States JSON](https://archivedocs.stackstate.com/5.1/configure/health/send-health-data/repeat_states)
* [Transactional Increments JSON](https://archivedocs.stackstate.com/5.1/configure/health/send-health-data/transactional_increments)

## See also

* [Install the StackState CLI](https://archivedocs.stackstate.com/5.1/setup/cli)
* [Send topology data over HTTP](https://archivedocs.stackstate.com/5.1/configure/topology/send-topology-data)
* [Send telemetry data over HTTP](https://archivedocs.stackstate.com/5.1/configure/telemetry/send_metrics)