Sign in

v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB
Data Acquisition

Agent Status (Heart Beat)

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
post/v1/data-acquisition/agent/status

Request body

agentIdstring 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.

agentVersionstring required

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

agent'TetraScience.Agent.file-log' | 'TetraScience.Agent.empower' | 'TetraScience.Agent.unicorn' | 'TetraScience.Agent.labx' | 'TetraScience.Agent.chromeleon' | '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')

Response

200

agentNamestring

Example response

{
  "agentName": "test"
}