TEtetrascience
Agents

Update an agent

Use this endpoint to update a single agent

put/v1/agents/{agentId}

Request

  • Base URL
    https://api.tetrascience.com
  • URL
    https://api.tetrascience.com/v1/agents/{agentId}
  • Auth
    API key in header ts-auth-token and API key in header x-org-slug

Path parameters

agentIdstring uuid required

The ID of the agent.

Request body

namestring required

Updated name of the agent. Validation: It may contain any alphanumeric character, spaces, and the characters - _ + . /

descriptionstring

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

sourceTypestring

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.

integrationIdstring uuid required

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

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

tagsstring[]

Tags to associate with the agent.

metadataobject

Metadata to associate with the agent.

Response

(unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.