API DocumentationProduct Documentation

Cloud Data Connector Agent Status (Heart Beat)

post https://api.tetrascience.com/v1/uda/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 Cloud Data Connector (formerly known as a user-defined integration) and 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

Validation

  1. agentId and agentVersion are required
  2. agentId must be valid value defined in User Source Integrations
Language
Authorization
Click Try It! to start a request and see the response here!