v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB

Agents

Get File-Log agent configuration

Use this endpoint to get the latest configuration, of the type requested, of a File Log Agent

get/v1/agents/{agentId}/configuration

Path parameters

agentIdstring required

Agent ID

Query parameters

type'local' | 'cloud'

Type of the configuration to be returned, 'cloud' or 'local'. If the parameter is not provided, The endpoint will default to 'local' type.

Response

Successful response with the latest agent configuration

idstring

The unique ID of the configuration.

bystring

The entity that initiated the command.

atstring date-time

The timestamp when the command was executed.

commandStatusstring

The status of the command.

commandIdstring

The unique ID of the command.

Example response

{
  "id": "f82d2230-eed1-443c-9ed8-2e1fef9039c2",
  "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"
    }
  },
  "by": "cloud",
  "at": "2023-08-28T14:43:46.381Z",
  "commandStatus": "SUCCESS",
  "commandId": "f82d2230-eed1-443c-9ed8-2e1fef9039c2"
}