Get SOS Version Snapshot

Overview

Use this endpoint to retrieve the complete SOS object represented by a specific monitoring version.

While Version Detail focuses on differences from the previous version, Snapshot provides the full SOS data associated with the selected version.

When Should I Use This API?

Use Snapshot when you need to:

  • Retrieve the complete SOS record at a particular version.
  • Display the full historical SOS information.
  • Reconstruct the state of the SOS record at a particular point in its monitoring history.
  • Compare complete SOS objects in your own application.

Example

Version 1 Snapshot
        ↓
Complete SOS Object at Version 1

Version 2 Snapshot
        ↓
Complete SOS Object at Version 2

If Version 2 contains an address change, the Version Detail endpoint can tell you what changed, while the Version 2 Snapshot gives you the entire SOS object after that change.

Version Detail vs. Snapshot

EndpointReturnsUse When
Version DetailDifferences from the previous versionYou need to know what changed
Version SnapshotComplete SOS object for the versionYou need the full SOS state

Related APIs

  • List SOS Versions — identify available versions.
  • Version Detail — retrieve differences for the selected version.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
integer
required
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json