Logs APIs

Introduction

This document describes how log viewing works in the UI: which backend APIs are used, what options you can pass (including lines / tail size), and where to open each view.
All log endpoints are served by the collector HTTP API and require authentication (same session as the rest of the app).

API Requests

Paths below are relative to the collector API root : https://<CVT_IP>/cablevalidation/

Collector Logs API:

Method	Path	Purpose/Output
`GET`	`/logs/collector`	JSON array of allowed `log_type` keys.
`GET`	`/logs/collector/{log_type}/tail`	Last N lines as plain text (`text/plain`).
`GET`	`/logs/collector/{log_type}/download`	Full collector log file is downloaded from browser.

Query Parameter

Parameter	Applies to	Description
`lines`	`…/tail` only	Number of lines from end of file. Default 100, max 1000. For lines more than 1000 user will have to download the whole file.

log_type values

`log_type`	Log name (under <cable_bringup_root>/log/)
bringup_collector	`bringup_collector.log`
agents	`bringup_agents.log`
apache2_access	`apache2/access.log`
cv_controller_service	`cv_controller_service.log`
cvt_service	`cvt-service.log`
supervisord	`supervisor/supervisord.log`

Example

GET /logs/collector/
GET /logs/collector/bringup_collector/tail?lines=500
GET /logs/collector/cv_controller_service/download

Agent Logs API

There are two log types per agent, both under <cable_bringup_root>/log/agents/<hostname>/ on the collector: Agent log — ongoing runtime and cable-validation output (<hostname>.log); Deployment log — output from deploy / remove agent operations on that node (deployment.log).

Method	Path	Purpose/Output
`GET`	`/logs/agents`	JSON list of agent names that have log directories. Each node will have a directory by its hostname.
`GET`	`/logs/agents/{agent_name}/tail`	Last N lines of the agent log (`text/plain`).
`GET`	`/logs/agents/{agent_name}/download`	Full agent log file is downloaded from browser.
`GET`	`/logs/agents/{agent_name}/deployment/tail`	Last N lines of deployment.log (`text/plain`).
`GET`	`/logs/agents/{agent_name}/deployment/download`	Full agent deployment log file is downloaded from browser.

Query Parameter

Parameter	Applies to	Description
`lines`	`…/tail` only (agent and deployment)	Number of lines from end of file. Default 100, max 1000. For lines more than 1000 user will have to download the whole file.

Example

GET /logs/agents/sw-hdr-proton01/tail?lines=300 
GET /logs/agents/sw-hdr-proton01/deployment/tail?lines=100 
GET /logs/agents/sw-hdr-proton01/download

Last updated: June 03, 2026