Telemetry Api Download Telemetry Report
Exact stored report for a day (attachment vtp-usage-DATE.json). Readable by every authenticated role; audited.
Date the report was collected, in the form yyyy-MM-dd. Any other form answers 400 INVALID_DATE; a date with no stored report answers 404 REPORT_NOT_FOUND.
2026-01-15
Exact stored report bytes
{
"type": "cspla",
"product": "VMHyperArmor",
"instance_id": "00000000-0000-4000-8000-000000000031",
"date_collected": "2026-01-14",
"period_days": 1,
"product_version": "1.4.2",
"licenses": {
"ESG-VCFHA-SUB": {
"count": 64,
"usage": 48,
"start": "2026-01-01",
"expires": "2026-02-28",
"serials": [
"0000740016"
]
}
},
"additional_info": {
"registered_agents": 2,
"consuming_hosts": 2,
"reclaimed_hosts": 0,
"hosts_with_unknown_topology": 0,
"license_state": 2,
"over_capacity": 0,
"overage_cores": 0,
"samples": 24
},
"details": {
"cpu_count": 4,
"memory_in_mb": 16384,
"storage_in_gb": 200
}
}
Response Headers
undefined
400 Bad Request: INVALID_DATE when date is not in the form yyyy-MM-dd
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
403 Forbidden error response (including LICENSE_EXPIRED while the license is restricted). PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
404 Not Found: REPORT_NOT_FOUND when no report is stored for the date
"ApiErrorResponse Object"
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
500 Internal Server Error: INTERNAL_ERROR when the server fails unexpectedly; the message carries no detail
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/telemetry/reports/{date}