Update an agent

put

https://api.tetrascience.com/v1/agents/{agentId}

Use this endpoint to update a single agent

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

agentId

uuid

required

The ID of the agent.

Body Params

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

string

enum

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

Allowed:

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

string

enum

required

Type of the updated integration for the agent. The valid types are api or `datahub.

Allowed:

integrationId

uuid

required

Id of the connector to be used by the agent, in GUID format

datahubId

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'

200Successful response with agent details

400Bad Request