v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB

Agents

Get agent

Use this endpoint to get the details of a single agent.

get/v1/agents/{agentId}

Path parameters

agentIdstring uuid required

The ID of the agent.

Response

Successful response with agent details

idstring uuid

The unique identifier 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 the 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 whether the agent is enabled.

tagsstring[]

Tags associated with the agent.

metadataobject

Metadata associated with the agent.

configStatusstring

Agent configuration status of a File-Log agent, null otherwise.

configStatusUpdatedAtstring date-time

Timestamp when configuration status was updated.

configStatusErrorstring nullable

Configuration status error message of a File-Log agent, null otherwise.

configChangedBystring

User who changed the configuration of a File-Log agent, null otherwise.

configChangedAtstring date-time

Timestamp when configuration of a File-Log agent was changed, null otherwise.

createdAtstring date-time

Timestamp when the agent was created.

updatedAtstring date-time

Timestamp when the agent was last updated.

orgSlugstring

Organization slug.

statusstring

The status of the agent.

versionstring

The version of the agent.

liveTypestring

Type reported by the agent to the platform.

Example response

{
  "id": "9b9f275c-a60d-454f-8c6c-1ea094e3fd38",
  "name": "FLA Agent",
  "description": "description",
  "type": "file-log",
  "integrationType": "api",
  "integrationId": "6f166302-df8a-4044-ab4b-7ddd3eefb50b",
  "sourceId": "9201d7a7-2282-4ef2-b295-a1d1d1927b9a",
  "isEnabled": true,
  "tags": [
    "tag1"
  ],
  "metadata": {
    "metadataKey": "metadataValue"
  },
  "labels": [
    {
      "name": "vendor",
      "value": "Beckman Coulter"
    }
  ],
  "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"
    }
  },
  "configStatus": "SUCCESS",
  "configStatusUpdatedAt": "2023-08-28T14:43:59.753Z",
  "configChangedBy": "local",
  "configChangedAt": "2023-09-05T16:25:01.697Z",
  "createdAt": "2023-04-04T14:01:30.136Z",
  "updatedAt": "2023-10-10T16:29:08.573Z",
  "orgSlug": "tetrascience",
  "status": "Online",
  "version": "v4.3.1",
  "liveType": "file-log",
  "host": {
    "ip": "10.60.4.128",
    "name": "EC2AMAZ-53HU01M"
  },
  "queue": {
    "enabled": true,
    "name": "https://sqs.us-east-2.amazonaws.com/706717599419/onprem-9b9f275c-a60d-454f-8c6c-1ea094e3fd38.fifo",
    "visibilityTimeout": 600
  }
}