API ReferenceDocumentation
API Reference

Agent Status (Heart Beat)

post
https://api.tetrascience.com/v1/data-acquisition/agent/status

This endpoint allows TetraScience Agent to send heartbeats to the Tetrascience platform periodically. Platform will return the agent's name. It's recommended to send a heartbeat every 30 seconds.

It requires a user-defined agent set up in the TetraScience Web UI.

Required fields:

  • agentId
  • agentVersion

Optional fields:

  • agent
  • sourceType - If agent defines various source types, like file-log agent, this should be an array of objects with filePath and type values. Otherwise, it should be single item array that contains object with field type
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

This is the sourceId for a user-defined integration. Need to copy from the TDP web UI, where the user-defined integration is created. For existing Tetra Agent that can connect to TetraScience Cloud directly, provide the agentId to this field.

string
required

The Agent version, such as "v1.0.0".

string
enum
Defaults to TetraScience.Agent.user-defined

Type of agent, in the form TetraScience.Agent.file-log, TetraScience.Agent.empower, etc. If provided, object in data lake will have the metadata value agent in the form of agent agentVersion (for example, `TetraScience.Agent.file-log v4.3.0')

Allowed:
Responses

Updated 13 days ago

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

Updated 13 days ago