v1
latestOpenAPI 3.1.02026-07-24239123562.1 KBAgents
Remotely configure a running File-Log agent
-| This endpoint allows configuration of a running File-Log Agent with paths. The File-Log Agent must be version 4.1.0 or greater, and configured to Receive Commands. Additionally, the Command Queue must be enabled for this Agent on TDP. This will remove any paths not included in the JSON. To preserve existing paths, you must include them each time you POST. If the target's command queue doesn't exist or is not accessible, the API will return a 400 error code and doesn't create the command. For more details, see https://developers.tetrascience.com/docs/configuring-the-file-log-agent-in-the-cloud.
post/v1/agents/{agentId}/configuration
Path parameters
agentIdstring required
Agent ID
Request body
Example request
{
"destination_id": "2e72c40f-432e-46a9-a027-e70686e8cd39",
"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"
}
}
}
]
}
}
}Response
Successful response with the id to the command that executed the update
Example response
{
"commandId": "729dec7d-26f6-4ac2-b1c0-2ae918e270dc"
}