# Repeat Snapshots JSON ### Overview This page describes the exact JSON messages that can be sent for the health synchronization Repeat Snapshots consistency model. ### JSON property: "health" Health can be sent to the StackState Receiver API using the `"health"` property of the [common JSON object](/5.1/configure/health/send-health-data/send-health-data.md#common-json-object). {% tabs %} {% tab title="Example health `repeat_snapshots` JSON" %} ```javascript { "apiKey":"", "collection_timestamp":1585818978, "internalHostname":"lnx-343242.srv.stackstate.com", "health":[ { "consistency_model": "REPEAT_SNAPSHOTS", "start_snapshot": { "repeat_interval_s": 50 //"expiry_interval_s": 200 Optional }, "stop_snapshot": {}, "stream": { "urn": "urn:health:sourceId:streamId" //"sub_stream_id": "subStreamId" Optional }, "check_states": [ { "checkStateId": "checkStateId1", "message": "Server Running out of disk space", "health": "Deviating", "topologyElementIdentifier": "server-1", "name": "Disk Usage" }, { "checkStateId": "checkStateId2", "message": "Provisioning failed. [Learn more](https://www.any-link.com)", "health": "critical", "topologyElementIdentifier": "server-2", "name": "Health monitor" } ] } ] } ``` {% endtab %} {% endtabs %} Every health Repeat Snapshots data payload has the following details: * **start\_snapshot** - Optional. A start of a snapshot needs to be processed before processing `check_states`. This enables StackState to diff a stream snapshot with the previously received one and delete check states that are no longer present in the snapshot. It carries the following fields as snapshot metadata: * **repeat\_interval\_s** - Time in seconds. The frequency with which the external source will send health data to StackState. Max allowed value is 1800 (30 minutes). * **expiry\_interval\_s** - Time in seconds. The time to wait after the last update before an external check is deleted by StackState. Required when using sub streams. * **stop\_snapshot** - Optional. An end of a snapshot will be processed after processing the`check_states`. * **stream** - Object providing identification regarding which snapshots and `check_states` belong together. It has the following fields: * **urn** - Data source and stream ID encoded as a StackState [URN](/5.1/configure/topology/identifiers.md) that matches the following convention: `urn:health::` where `` is the name if the external data source and `` is a unique identifier for the health data stream. * **sub\_stream\_id** - Optional. Identifier for a subset of the stream health data. When the stream data is distributed and reported by several Agents, this allows snapshot lifecycles per `sub_stream_id` * **check\_states** - A list of check states. Each check state can have the following fields: * **checkStateId** - Identifier for the check state in the external system * **message** - Optional. Message to display in StackState UI. Data will be interpreted as markdown allowing to have links to the external system check that generated the external check state. * **health** - One of the following StackState Health state values: `Clear`, `Deviating`, `Critical`. * **topologyElementIdentifier** - Used to bind the check state to a StackState topology element. * **name** - Name of the external check state. ### Send health to StackState Health can be sent in one JSON message via HTTP POST or using the `stac` CLI command `stac health send`. In the example below, a snapshot containing two check states is sent to StackState from a single external monitoring system. {% tabs %} {% tab title="curl" %} ```bash curl -X POST \ '' \ -H 'Content-Type: application/json' \ -d '{ "collection_timestamp": 1548857167, "internalHostname": "local.test", "health": [ { "consistency_model": "REPEAT_SNAPSHOTS", "start_snapshot": { "repeat_interval_s": 300 }, "stop_snapshot": {}, "stream": { "urn": "urn:health:sourceId:streamId" }, "check_states": [ { "checkStateId": "checkStateId1", "message": "Server Running out of disk space", "health": "Deviating", "topologyElementIdentifier": "server-1", "name": "Disk Usage" }, { "checkStateId": "checkStateId2", "message": "Provisioning failed. [Learn more](https://www.any-link.com)", "health": "critical", "topologyElementIdentifier": "server-2", "name": "Health monitor" } ] } ] }' ``` {% endtab %} {% tab title="CLI: stac (deprecated)" %} {% hint style="warning" %} **From StackState v5.0, the old `sts` CLI is called `stac`. The old CLI is now deprecated.** The new `sts` CLI replaces the `stac` CLI. It's advised to install the new `sts` CLI and upgrade any installed instance of the old `sts` CLI to `stac`. For details see: * [Which version of the `sts` CLI am I running?](/5.1/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) * [Install the new `sts` CLI and upgrade the old `sts` CLI to `stac`](/5.1/setup/cli/cli-sts.md#install-the-new-sts-cli) * [Comparison between the CLIs](/5.1/setup/cli/cli-comparison.md) {% endhint %} ``` stac health send start urn:health:sourceId:streamId \ --repeat-interval-seconds 300 stac health send check-state urn:health:sourceId:streamId \ checkStateId1 "Disk Usage" "server-1" deviating \ --message "Deviating Server Running out of disk space" --consistency-model="REPEAT_SNAPSHOTS" stac health send check-state urn:health:sourceId:streamId \ checkStateId2 "Health monitor" "server-2" critical \ --message "Provisioning failed. [Learn more](https://www.any-link.com)" --consistency-model="REPEAT_SNAPSHOTS" stac health send stop urn:health:sourceId:streamId ``` {% endtab %} {% tab title="CLI: sts" %} The new `sts` CLI doesn't support sending health states. This will only be supported by directly reaching out to the receiver API. {% endtab %} {% endtabs %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://archivedocs.stackstate.com/5.1/configure/health/send-health-data/repeat_snapshots.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.