Get time-series interface metrics for an ASA device - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get time-series interface metrics for an ASA device","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/cdbcd64e8c81b1f572dff1a1b687b52867178d60/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.15.0","description":"Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"description":"Returns time-series interface metrics - including link status, overruns, and other key performance indicators - over a specified time range. Supports filtering by interface and metric. Pagination applies only when interface UIDs are not specified.","operationId":"getAsaInterfaceHealthMetrics","parameters":[{"description":"The unique identifier, represented as a UUID, of the ASA device in Security Cloud Control.","in":"path","name":"deviceUid","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Start of the time range (ISO 8601 format).","example":"2025-04-05T00:00:00Z","in":"query","name":"start","required":false,"schema":{"type":"string"}},{"description":"End of the time range (ISO 8601 format).","example":"2025-04-05T04:00:00Z","in":"query","name":"end","required":false,"schema":{"type":"string"}},{"description":"Relative time range (mutually exclusive with start/end). Data is collected every 10 minutes, so shorter time ranges may return fewer data points.","example":"10m","in":"query","name":"timeRange","required":false,"schema":{"enum":["10m","30m","1h"],"type":"string"}},{"description":"Maximum number of device records to return (used only when no deviceUids are provided).","in":"query","name":"limit","required":false,"schema":{"maximum":50,"minimum":0,"type":"string"}},{"description":"Offset for pagination (used only when no deviceUids are provided).","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"string"}},{"description":"Comma-separated list of interface UIDs to query. Max 50. If omitted, results are paginated.","example":"def6c34a-a5d4-45c1-8d96-820fb00de723,4bc125a0-cf08-4dcc-bfac-45669ba898b0","in":"query","name":"interfaceUids","required":false,"schema":{"maxLength":50,"maximum":50,"minLength":0,"type":"string"}},{"description":"Comma-separated list of metrics to return (e.g. linkStatus, overruns). Returns all if omitted.","example":"linkStatus,overruns","in":"query","name":"metrics","required":false,"schema":{"enum":["overruns","underruns","droppedPackets","l2DecodeDrops","inputErrors","outputErrors","inputPacketSize","outputPacketSize","linkStatus"],"type":"string"}},{"description":"Lucene-style query filter. Supports logical operators AND, OR, and NOT.Applicable only to the fields name and linkStatus.","example":"name:GigabitEthernet* OR linkStatus:1","in":"query","name":"q","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"description":{"type":"string"},"metrics":{"additionalProperties":{"properties":{"series":{"items":{"properties":{"timestamp":{"format":"date-time","type":"string"},"value":{"format":"double","type":"number"}},"type":"object","$$ref":"#/components/schemas/Series"},"type":"array"},"summary":{"properties":{"average":{"format":"double","type":"number"},"latest":{"format":"double","type":"number"},"max":{"format":"double","type":"number"}},"type":"object","$$ref":"#/components/schemas/Summary"}},"type":"object","$$ref":"#/components/schemas/Metric"},"type":"object"},"name":{"type":"string"},"uid":{"format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/MetricsItem"},"type":"array"},"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"total":{"format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/MetricsResponse"}}},"description":"Successfully retrieved time-series metrics for one or more interfaces."},"400":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, on the error","example":{},"type":"object"},"description":"Additional details, if any, on the error","example":{},"type":"object"},"errorCode":{"description":"A unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"A human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Invalid input provided. Check the response for details.","$$ref":"#/components/responses/http400BadRequest"},"401":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A human-readable error description in English.","example":"invalid_token","type":"string"},"errorDescription":{"description":"A human-readable error description in English.","example":"Your token is invalid","type":"string"}},"$$ref":"#/components/schemas/AuthenticationError"}}},"description":"Request not authorized.","$$ref":"#/components/responses/http401Unauthorised"},"403":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, on the error","example":{},"type":"object"},"description":"Additional details, if any, on the error","example":{},"type":"object"},"errorCode":{"description":"A unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"A human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"User does not have sufficient privileges to perform this operation.","$$ref":"#/components/responses/http403Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, on the error","example":{},"type":"object"},"description":"Additional details, if any, on the error","example":{},"type":"object"},"errorCode":{"description":"A unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"A human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Entity not found.","$$ref":"#/components/responses/http404NotFound"},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, on the error","example":{},"type":"object"},"description":"Additional details, if any, on the error","example":{},"type":"object"},"errorCode":{"description":"A unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"A human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Get time-series interface metrics for an ASA device","tags":["Device Health"],"__originalOperationId":"getAsaInterfaceHealthMetrics","method":"get","path":"/v1/inventory/devices/asas/health/{deviceUid}/interfaces"}}