Telemetry Api Get Telemetry Status
Current reporting status. Readable by every authenticated role.
200 OK successful response envelope. The current telemetry reporting status
{
"state": "ENABLED",
"lastAttemptAt": "2026-01-15T00:17:00Z",
"lastSuccessAt": "2026-01-15T00:17:00Z",
"lastResultCode": "SENT",
"consecutiveFailures": 0,
"nextRunAt": "2026-01-16T00:17:00Z",
"pendingReports": 0
}
State of Broadcom usage reporting. There is no administrator-disabled value because basic reporting is mandatory.
ENABLED: The product credential is configured and the operator kill switch is offDISABLED_BY_OPERATOR: The operator kill switch (configuration property) is on; it outranks a missing credentialNOT_CONFIGURED: The kill switch is off but no product credential is configured
Time of the last upload attempt; omitted when no attempt was made
Time of the last successful upload; omitted when none has succeeded
Result code of the last send cycle: SENT, UNAUTHORIZED, INVALID_SERIAL, NOT_FOUND, REJECTED, THROTTLED or FAILED; omitted when no cycle ran
Fixed explanation of the last failed upload; omitted when the last cycle succeeded or no cycle ran
Number of failed send cycles in a row; reset to 0 by a successful cycle
Next scheduled run: a pending retry time when it is in the future, otherwise the next daily generation time (00:00 UTC plus the installation's send-time jitter)
Number of stored reports whose status is PENDING or FAILED
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.
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/status