v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB

Data Acquisition

Agent Status Setting Update

This endpoint allows TetraScience Agent to send status setting update to platform. Tetrascience agents have start/stop button. When start button is clicked, agent should hit endpoint with statusSetting=STARTED. Opposite, when stop button is clicked, agent should hit endpoint with statusSetting=STOPPED.

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

put/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 TetraScience Agent who can connect to TetraScience Cloud directly, provide the agentId to this field.

agentVersionstring required

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

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')

statusSetting'STARTED' | 'STOPPED'

Status setting of the agent. It can be STARTED or STOPPED

Response

200

agentNamestring

Example response

{
  "agentName": "test"
}