Sign in

v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB
Agents

Get File-Log agent configuration list

Use this endpoint to get the past configurations of a File-Log agent

get/v1/agents/{agentId}/configuration/list

Path parameters

agentIdstring required

Agent ID

Query parameters

pageinteger

Page number

sizeinteger

Number of items per page

by'local' | 'cloud' | 'all'

Filter by agent config type

status'CREATED' | 'UNSENT' | 'PENDING' | 'PURGED' | 'ERROR' | 'PROCESSING' | 'REJECTED' | 'SUCCESS' | 'FAILURE' | 'all'

Filter by agent config by its command status

order'asc' | 'desc'

Sorting order by creation date

Response

Successful response

pageinteger
sizeinteger
hasNextboolean

Example response

{
  "page": 1,
  "size": 10,
  "hasNext": true,
  "hits": [
    {
      "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"
    }
  ]
}