{"type":"api","title":"Get Vpc Domain 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 VPC domain details in a given fabric","operationId":"getVpcDomainDetails","parameters":[{"description":"Name of the Site Group - limit the records pertaining to the sites in this site group. One out of siteName / siteGroupName is mandatory.","in":"query","name":"siteGroupName","required":false,"schema":{"default":"None","example":"Ig1","type":"string"}},{"description":"Name of the Site - limit the records pertaining to the site. One out of siteName / siteGroupName is mandatory.","in":"query","name":"siteName","required":false,"schema":{"default":"None","example":"DC-tel1","type":"string"}},{"description":"Start timestamp, to collect the records generated from specified time","in":"query","name":"startDate","required":false,"schema":{"default":"now-1h","example":"2021-03-29T07:18:55+05:30","type":"string"}},{"description":"End timestamp, to collect the records generated till specified time","in":"query","name":"endDate","required":false,"schema":{"default":"now","example":"2021-03-29T08:18:55+05:30","type":"string"}},{"description":"Order the response based on this field","in":"query","name":"sort","required":false,"schema":{"default":"None","example":"-domainId","type":"string"}},{"description":"Filter the response based on this filter field","in":"query","name":"filter","required":false,"schema":{"default":"None","example":"domainId:100","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"description":"Returing VPC domain details","entries":[{"domainId":"450","fabricName":"scale1","primary":"scale1-leaf450","secondary":"scale1-leaf452","siteName":"scale1","totalCount":48,"vpcIfUpCount":48},{"domainId":"1000","fabricName":"scale1","primary":"scale1-leaf302","secondary":"scale1-leaf301","siteName":"scale1","totalCount":48,"vpcIfUpCount":48}],"totalItemsCount":2,"totalResultsCount":2},"properties":{"description":{"type":"string"},"entries":{"items":{"properties":{"domainId":{"type":"string"},"fabricName":{"type":"string"},"peerlink":{"type":"string"},"peerlinkId":{"type":"string"},"peerlinkStatus":{"type":"string"},"primary":{"type":"string"},"secondary":{"type":"string"},"siteName":{"type":"string"},"totalCount":{"type":"number"},"vpcIfUpCount":{"type":"number"}},"type":"object"},"type":"array"},"totalItemsCount":{"type":"number"},"totalResultsCount":{"type":"number"}},"type":"object"}}},"description":"Records list"},"401":{"description":"Key not authorized:token contains an invalid number of segments"},"500":{"description":"Server error, either the server is overloaded or there is an error in the application"}},"summary":"Get VPC domain details","tags":["Protocols"],"__originalOperationId":"getVpcDomainDetails","method":"get","path":"/sedgeapi/v1/cisco-nir/api/api/v1/vpcDomains"}}