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 characters - _ + . /

description

string

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

type

string

required

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

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

required

Type of the integration of the new agent. The valid types are api or datahub

integrationId

string

required

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

datahubId

string

Id of the datahub 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

metadata

object

Metadata to associate with the agent.

labels

object

Labels to associate with the agent

Responses

Language

Credentials

URL


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.tetrascience.com/v1/agents \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "type": "file-log",
8
  "integrationType": "api"
9
}
10
'


xxxxxxxxxx
62
}
1
{
2
  "id": "9b9f275c-a60d-454f-8c6c-1ea094e3fd38",
3
  "name": "File-Log Agent",
4
  "description": "description",
5
  "sourceType": "string",
6
  "type": "file-log",
7
  "integrationType": "api",
8
  "integrationId": "6f166302-df8a-4044-ab4b-7ddd3eefb50b",
9
  "datahubId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
10
  "sourceId": "9201d7a7-2282-4ef2-b295-a1d1d1927b9a",
11
  "isEnabled": true,
12
  "tags": [
13
    "tag1"
14
  ],
15
  "metadata": null,
16
  "config": {
17
    "services_enabled": [
18
      "fileWatcher"
19
    ],
20
    "services_configuration": {
21
      "fileWatcher": {
22
        "use_path_configuration": true,
23
        "paths": [
24
          {
25
            "path": "C:\\FLA\\test1",

200Successful response with agent details

400Bad Request