---
title: "Agent Status Setting Update"
method: PUT
path: "/v1/data-acquisition/agent/status"
tags: ["Data Acquisition"]
---

# Agent Status Setting Update

`PUT /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

## Request body

- object
  - `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` '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')
  - `statusSetting` 'STARTED' | 'STOPPED' — Status setting of the agent. It can be `STARTED` or `STOPPED`

## Response `200`

200

- object
  - `agentName` string

## Other responses

- `404` — 404

---

[API](https://skmtc.net/tetrascience/apis/tetra-data-lake.md) · [All operations](https://skmtc.net/tetrascience/apis/tetra-data-lake/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tetrascience/tetra-data-lake/versions/0205e2bace53/schema)