v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB

Agents

Create an agent

Use this endpoint to create a new agent.

post/v1/agents

Request body

namestring required

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

descriptionstring

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

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

sourceTypestring

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'api' | 'datahub' required

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

integrationIdstring uuid required

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

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

tagsstring[]

Tags to associate with the agent.

metadataobject

Metadata to associate with the agent.

Example request

{
  "name": "Agent name",
  "description": "Agent description",
  "type": "file-log",
  "integrationId": "6f166302-df8a-4044-ab4b-7ddd3eefb50b",
  "tags": [
    "tag1"
  ],
  "metadata": {
    "metadataKey": "metadataValue"
  },
  "labels": {
    "labelsToAdd": [
      {
        "name": "labelKey",
        "value": "labelValue"
      }
    ]
  }
}

Response

Successful response with agent details

idstring uuid

The ID of the agent.

namestring

The name of the agent.

descriptionstring

The description of the agent.

sourceTypestring nullable

The source type of the agent (nullable).

typestring

The type of agent.

integrationTypestring

The integration type of the agent.

integrationIdstring uuid

The integration ID of the agent.

datahubIdstring uuid nullable

The Data Hub ID of the agent (nullable).

sourceIdstring uuid

The source ID of the agent.

isEnabledboolean

Indicates if the agent is enabled or not.

tagsstring[]

Tags associated with the agent.

metadataobject

Metadata associated with the agent.

Example response

{
  "id": "9b9f275c-a60d-454f-8c6c-1ea094e3fd38",
  "name": "File-Log Agent",
  "description": "description",
  "type": "file-log",
  "integrationType": "api",
  "integrationId": "6f166302-df8a-4044-ab4b-7ddd3eefb50b",
  "sourceId": "9201d7a7-2282-4ef2-b295-a1d1d1927b9a",
  "isEnabled": true,
  "tags": [
    "tag1"
  ],
  "config": {
    "group_user": {
      "user_name": "user1",
      "password": "-1943064076"
    },
    "agent_configuration": {
      "s3_direct_upload": true,
      "receive_commands": true,
      "destination_id": "2e72c40f-432e-46a9-a027-e70686e8cd39",
      "agent_id": "f82d2230-eed1-443c-9ed8-2e1fef9039c2",
      "org_slug": "tetrascience",
      "Authentication": "-1943064076",
      "advanced_setting": {
        "heart_beat_interval": 30,
        "agent_log_upload_job_interval": 30,
        "compression_type": "zip",
        "retry_limit": 3,
        "tdpApiUrlOverride": "https://api.tetrascience.com",
        "validateAwsCertificate": true,
        "proxyUseCustom": true,
        "proxyHost": "proxy.example.com",
        "proxyPort": 8080,
        "proxyBypassList": "example.com,example.org",
        "proxyUsername": "proxyuser",
        "proxyPassword": "-1943064076"
      }
    },
    "services_enabled": [
      "fileWatcher"
    ],
    "services_configuration": {
      "fileWatcher": {
        "use_path_configuration": true,
        "paths": [
          {
            "path": "C:\\FLA\\test1",
            "file_watch_mode": "file",
            "source_type": "unknown",
            "interval": 30,
            "start_date": "2023-03-27",
            "patterns": [
              "*.*"
            ],
            "metadata": {
              "meta1": "value1"
            },
            "tags": "tag1,tag2",
            "labels": [
              {
                "name": "vendor",
                "value": "Beckman Coulter"
              }
            ],
            "archive": {
              "path": "c:\\archive",
              "wait_time": 1,
              "wait_time_unit": "Days",
              "delete": {
                "wait_time": 7,
                "wait_time_unit": "Days"
              }
            }
          }
        ]
      }
    },
    "windows_scheduled_task": {
      "enabled": true,
      "time": "1:00pm"
    }
  }
}