---
title: "Update an agent"
method: PUT
path: "/v1/agents/{agentId}"
tags: ["Agents"]
---

# Update an agent

`PUT /v1/agents/{agentId}`

Use this endpoint to update a single agent

## Path parameters

- `agentId` string, uuid, required

## Request body

- object
  - `name` string, required — Updated name of the agent. Validation: It may contain any alphanumeric character, spaces, and the characters - _ + . /
  - `description` string — Updated description of the agent. It may contain any alphanumeric character, spaces, line breaks, and the characters - _ + . /
  - `type` 'file-log' | 'empower' | 'unicorn' | 'labx' | 'chromeleon' | 'user-defined', required — Type of the existing agent. The valid types are file-log, empower, unicorn, labx, chromeleon or user-defined It is not allowed to change the type of the agent, so this parameter must match the type of the agent being updated
  - `sourceType` string — Source Type of a user-defined agent. For a user-defined agent, it may contain any lower-case alphanumeric character, spaces, and the characters - _ + . / However, a space can't be the first character. For other agent types it must be empty, null or not present
  - `integrationType` 'api' | 'datahub', required — Type of the updated integration for the agent. The valid types are `api` or `datahub.
  - `integrationId` string, uuid, required — Id of the connector to be used by the agent, in GUID format
  - `datahubId` string, uuid — Id of the Data Hub to be used by the new agent, in GUID format. It is required for integrations of type 'datahub'. It must be set to null, empty or not present for integrations of type 'api'
  - `tags` string[] — Tags to associate with the agent.
  - `metadata` object — Metadata to associate with the agent.
  - `labels` object — Labels to add or drop from the agent
    - `labelsToAdd` LabelsToAdd[] — Labels to add the agent — unresolved $ref
    - `labelsToDrop` union — Labels to drop from the agent
      - integer[]
      - integer — Id of the label to drop from the agent

## Other responses

- `200` — unresolved $ref
- `400` — Bad Request

---

[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/revisions/0205e2bace53/schema)