Create an agent

post

https://api.tetrascience.com/v1/agents

Use this endpoint to create a new agent.

Body Params

name

string

required

Name of the new agent. Validation: It may contain any alphanumeric character, spaces, and the following special characters, -, _, +, ., /.

description

string

Description of the new agent. It may contain any alphanumeric character, spaces, line breaks, and the following special characters, -, _, +, ., /.

type

string

enum

required

Type of the new agent. The valid types are file-log, empower, unicorn, labx, chromeleon or user-defined.

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 following special 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

New agent's integration type. The valid types are api or datahub.

Allowed:

integrationId

uuid

required

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

datahubId

uuid

Id of the Data Hub the new agent is using, 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.