Agent Status Setting Update

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

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

Body Params

agentId

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

agentVersion

string

required

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

agent

string

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

statusSetting

string

Defaults to STARTED

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

Responses

Language

Credentials

URL


xxxxxxxxxx
10
1
curl --request PUT \
2
     --url https://api.tetrascience.com/v1/data-acquisition/agent/status \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "agent": "TetraScience.Agent.user-defined",
8
  "statusSetting": "STARTED"
9
}
10
'


xxxxxxxxxx
 
1
{
2
  "agentName": "test"
3
}

200200

404404