{"type":"api","title":"Get Interface Status Details","meta":{"id":"/apps/pubhub/media/nexus-dashboard-api-v1/86cc2501c92a7370499e3d537496e5c722396afb/65a171d6-461c-341f-833b-8723fe3ac65c","info":{"contact":{"name":"API Support","url":"https://devnetapps.cisco.com/docs/nexus-dashboard/api-v1/developer-support/"},"description":"Nexus Dashboard Insights API Documentation","title":"Nexus Dashboard Insights API","version":"6.8.0"},"tags":[{"name":"Cloud"},{"name":"Anomaly Threshold settings"},{"name":"Cluster level settings"},{"name":"Config - NI"},{"name":"NI Systems Settings"},{"name":"Site - Alert Rules"},{"name":"Site - Collection"},{"name":"Site - Compliance Requirements"},{"name":"Site - Configuration Import Export"},{"name":"Site - Entity Settings, Offline / Epoch-Delta Jobs & Site Management"},{"name":"Site - Export Kafka Fast Settings"},{"name":"Site - Export Nas Settings"},{"name":"Site - Export Settings"},{"name":"Site - FileUpload"},{"name":"Site - Flow Rules"},{"name":"Site - Integrations"},{"name":"Site - Offline Data Collection"},{"name":"Site - PDU integration"},{"name":"Site - Pre-Change Analysis"},{"name":"Site - Purge Epoch & Anomaly DB"},{"name":"Site - Syslog Export Settings"},{"name":"Site Group"},{"name":"Site Groups"},{"name":"Traffic Analytics Rules settings"},{"name":"User Settings"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview-legacy-insights.md"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}}},"openapi":"3.0.3","servers":[{"url":"/"}]},"spec":{"description":"Get Interface Status details","operationId":"getInterfaceStatusDetails","parameters":[{"description":"Start date, to skip records generated earlier to this date","in":"query","name":"startDate","required":false,"schema":{"default":"now-1h","example":"2021-03-29T08:03:55+05:30","type":"string"}},{"description":"End date, to collect the records generated till specified date","in":"query","name":"endDate","required":false,"schema":{"default":"now","example":"2021-03-29T08:18:55+05:30","type":"string"}},{"description":"Site name - limit the records pertaining to given siteName","in":"query","name":"siteName","required":false,"schema":{"default":"None","example":"DC-tel1","type":"string"}},{"description":"Node name - limit the records pertaining to given node name","in":"query","name":"nodeName","required":false,"schema":{"default":"None","example":"tel1-leaf1","type":"string"}},{"description":"Name of the Site Group - limit the records pertaining to the sites in this site group","in":"query","name":"siteGroupName","required":false,"schema":{"default":"None","example":"ifav-insight","type":"string"}},{"description":"Interface name - limit the records pertaining to given interface name","in":"query","name":"interfaceName","required":false,"schema":{"default":"None","example":"eth1/1","type":"string"}},{"description":"Defines whether records need to be added with timeseries or not in response","in":"query","name":"history","required":false,"schema":{"default":0,"example":1,"type":"integer"}},{"description":"Interface Type - limit the records pertaining to given interface type","in":"query","name":"interfaceType","required":false,"schema":{"enum":["physical","pc","vpc","svi","peerlinkpc"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"description":"Returning interface status details","entries":[{"adminStatus":{"stats":[{"ts":"2023-10-01T08:07:44.045Z","value":"up"}],"ts":"2023-10-01T08:07:44.045Z","value":"up"},"fabricName":"scale-1","interfaceName":"eth1/45","nodeName":"node-1","operStatus":{"stats":[{"ts":"2023-10-01T08:07:44.045Z","value":"up"}],"ts":"2023-10-01T08:07:44.045Z","value":"up"},"siteName":"scale-1"}],"interfaceName":"eth1/45","totalItemsCount":1,"totalResultsCount":1},"properties":{"description":{"type":"string"},"entries":{"items":{"properties":{"adminStatus":{"properties":{"stats":{"items":{"properties":{"ts":{"type":"string"},"value":{"enum":["up","down"],"type":"string"}},"type":"object"},"type":"array"},"ts":{"type":"string"},"value":{"enum":["up","down"],"type":"string"}},"type":"object"},"fabricName":{"type":"string"},"interfaceName":{"type":"string"},"nodeName":{"type":"string"},"siteName":{"type":"string"}},"type":"object"},"type":"array"},"interfaceName":{"type":"string"},"totalItemsCount":{"type":"number"},"totalResultsCount":{"type":"number"}},"type":"object"}}},"description":"Returning congestion stats"}},"summary":"Get interface status details","tags":["Protocols"],"__originalOperationId":"getInterfaceStatusDetails","method":"get","path":"/sedgeapi/v1/cisco-nir/api/api/v1/protocols/statusDetails"}}