Get Resource Details - Nexus Dashboard API v1, Release 4.2 and above

{"type":"api","title":"Get Resource Details","meta":{"id":"/apps/pubhub/media/nexus-dashboard-api-v1/86cc2501c92a7370499e3d537496e5c722396afb/65fc3264-ac5a-3c30-875c-02fef61e57b5","info":{"contact":{"name":"Cisco Technical Assistance Center (TAC)","url":"https://developer.cisco.com/docs/nexus-dashboard/latest/#developer-support/"},"description":"Analyze APIs provide visibility across the managed resources","license":{"name":"Cisco","url":"https://www.cisco.com/site/us/en/about/legal/contract-experience/index.html"},"title":"Nexus Dashboard Analyze v1","version":"1.1.209"},"tags":[{"name":"AI Infrastructure and Analytics"},{"name":"Anomalies and Advisories"},{"name":"Compliance Conformance and Update Analysis"},{"name":"Dashboards and Explorer"},{"name":"Endpoints"},{"name":"Energy Management"},{"name":"Flow Analytics"},{"name":"Job and Report Management"},{"name":"Network Connectivity Resources"},{"name":"Resources Summary"},{"name":"Services and Segmentation"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview-analyze.md"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}}},"openapi":"3.0.3","servers":[{"description":"Nexus Dashboard Analyze APIs","url":"https://{cluster}/api/v1/analyze","variables":{"cluster":{"default":"example.com","description":"The cluster URL/IP address","enum":["example.com","10.1.1.20"]}}}],"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OAuth2 security scheme","flows":{"implicit":{"authorizationUrl":"https://example.com/login","scopes":{"observer":"Grants read access","fabric-admin":"Grants write access to fabric resources","support-engineer":"Primarily a role for support engineers to operate the managed resources","super-admin":"Grants access to all operations","approver":"Grants access to approve policies","designer":"Grants access to design policies"}}}},"http_signature":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"HTTP Signature security scheme"},"cookieAuth":{"type":"apiKey","description":"Cookie based authentication","in":"cookie","name":"AuthCookie"}}},"spec":{"description":"Returns detailed resource information for a specific count within resources.","operationId":"getResourceDetails","parameters":[{"description":"Type of the resource (e.g., appProfile, tenant, etc.)","in":"query","name":"resourceType","required":true,"schema":{"description":"Type of the resource","enum":["tenant","appProfile","epg","bd","vrf","l3Out","l2Out","contract","filter","subject","tabooContract","tabooSubject","internalSubnet","externalRoute","endPoint","interface","leaf","spine","borderLeaf","borderGateway","vlan","vpc","l2Vni","l3Vni","vni","svi","nxosEndpoint","accesse","aggregation","borderGatewaySpine","borderGatewaySuperSpine","borderSpine","borderSuperSpine","coreRouter","edgeRouter","superSpine","tor"],"type":"string","$$ref":"#/components/schemas/resourceType"}},{"description":"Type of detail to fetch (e.g., unchanged, new, cleared)","in":"query","name":"detailType","required":true,"schema":{"enum":["unchanged","new","cleared","earlierSnapshot","laterSnapshot"],"type":"string"}},{"name":"clusterName","description":"Name of the target Nexus Dashboard cluster to execute this API, in a multi-cluster deployment","in":"query","required":false,"schema":{"type":"string","description":"Name of the target Nexus Dashboard cluster to execute this API, in a multi-cluster deployment"},"$$ref":"#/components/parameters/fromClusterQueryParam"},{"description":"job id","example":"ONLINE-ANALYSIS-ACI-xyz123","in":"query","name":"jobId","required":false,"schema":{"type":"string"},"$$ref":"#/components/parameters/jobId"},{"description":"Should results include acknowledged anomalies and its resources. This is optional and defaults to `false` if not provided.","in":"query","name":"includeAcknowledged","required":false,"schema":{"default":false,"type":"boolean"},"$$ref":"#/components/parameters/includeAcknowledged"},{"description":"Health status of the resource, used to filter resources that have an anomaly associated with them (unhealthy) or have no anomalies reported (healthy)","in":"query","name":"healthStatus","required":false,"schema":{"enum":["healthy","unhealthy"],"type":"string"},"$$ref":"#/components/parameters/healthStatus"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"value":{"resourceType":"appProfile","resources":[{"identifier":"uni/tn-apples/app-foo","name":"foo"},{"identifier":"uni/tn-apples/app-bar","name":"bar"}]}}},"schema":{"description":"Response containing detailed resource information for a specific count","properties":{"resourceType":{"description":"Type of the resource","enum":["tenant","appProfile","epg","bd","vrf","l3Out","l2Out","contract","filter","subject","tabooContract","tabooSubject","internalSubnet","externalRoute","endPoint","interface","leaf","spine","borderLeaf","borderGateway","vlan","vpc","l2Vni","l3Vni","vni","svi","nxosEndpoint","accesse","aggregation","borderGatewaySpine","borderGatewaySuperSpine","borderSpine","borderSuperSpine","coreRouter","edgeRouter","superSpine","tor"],"type":"string","$$ref":"#/components/schemas/resourceType"},"resources":{"description":"List of resources with their details","items":{"properties":{"identifier":{"description":"Unique identifier of the resource","type":"string"},"name":{"description":"Name of the resource","type":"string"}},"required":["name","identifier"],"type":"object"},"type":"array"}},"required":["resources","resourceType"],"type":"object","$$ref":"#/components/schemas/resourceDetailsResponse"}}},"description":"OK"},"400":{"description":"Bad Request","headers":{"Date":{"description":"Date","example":"Tue, 15 Nov 1994 08:12:31 GMT","schema":{"type":"string","example":"Tue, 15 Nov 1994 08:12:31 GMT","nullable":true},"$$ref":"#/components/headers/Date"},"Cache-Control":{"description":"Cache-Control","example":"no-cache, no-store, must-revalidate","schema":{"type":"string","default":"no-cache","nullable":true},"$$ref":"#/components/headers/Cache-Control"}},"content":{"application/json":{"schema":{"description":"Error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"},"errors":{"description":"An array of errors","type":"array","items":{"description":"Sub error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"}},"required":["message","code","description"],"example":{"message":"Invalid email","description":"The email you provided is invalid","code":4066},"$$ref":"#/components/schemas/SubError"}}},"example":{"message":"Unauthorized","description":"You are not authorized to access this resource","code":4065},"required":["message","code","description"],"$$ref":"#/components/schemas/Error"},"example":{"message":"Bad Request","description":"The server could not understand the request due to incorrect syntax.","code":400}}},"$$ref":"#/components/responses/400"},"401":{"description":"Unauthorized","headers":{"Date":{"description":"Date","example":"Tue, 15 Nov 1994 08:12:31 GMT","schema":{"type":"string","example":"Tue, 15 Nov 1994 08:12:31 GMT","nullable":true},"$$ref":"#/components/headers/Date"},"Cache-Control":{"description":"Cache-Control","example":"no-cache, no-store, must-revalidate","schema":{"type":"string","default":"no-cache","nullable":true},"$$ref":"#/components/headers/Cache-Control"}},"content":{"application/json":{"schema":{"description":"Error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"},"errors":{"description":"An array of errors","type":"array","items":{"description":"Sub error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"}},"required":["message","code","description"],"example":{"message":"Invalid email","description":"The email you provided is invalid","code":4066},"$$ref":"#/components/schemas/SubError"}}},"example":{"message":"Unauthorized","description":"You are not authorized to access this resource","code":4065},"required":["message","code","description"],"$$ref":"#/components/schemas/Error"},"example":{"message":"Unauthorized","description":"Indicates that the request requires user authentication information.","code":401}}},"$$ref":"#/components/responses/401"},"403":{"description":"Forbidden","headers":{"Date":{"description":"Date","example":"Tue, 15 Nov 1994 08:12:31 GMT","schema":{"type":"string","example":"Tue, 15 Nov 1994 08:12:31 GMT","nullable":true},"$$ref":"#/components/headers/Date"},"Cache-Control":{"description":"Cache-Control","example":"no-cache, no-store, must-revalidate","schema":{"type":"string","default":"no-cache","nullable":true},"$$ref":"#/components/headers/Cache-Control"}},"content":{"application/json":{"schema":{"description":"Error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"},"errors":{"description":"An array of errors","type":"array","items":{"description":"Sub error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"}},"required":["message","code","description"],"example":{"message":"Invalid email","description":"The email you provided is invalid","code":4066},"$$ref":"#/components/schemas/SubError"}}},"example":{"message":"Unauthorized","description":"You are not authorized to access this resource","code":4065},"required":["message","code","description"],"$$ref":"#/components/schemas/Error"},"example":{"message":"Forbidden","description":"The client does not have access rights to the content.","code":403}}},"$$ref":"#/components/responses/403"},"404":{"description":"Not Found","headers":{"Date":{"description":"Date","example":"Tue, 15 Nov 1994 08:12:31 GMT","schema":{"type":"string","example":"Tue, 15 Nov 1994 08:12:31 GMT","nullable":true},"$$ref":"#/components/headers/Date"},"Cache-Control":{"description":"Cache-Control","example":"no-cache, no-store, must-revalidate","schema":{"type":"string","default":"no-cache","nullable":true},"$$ref":"#/components/headers/Cache-Control"}},"content":{"application/json":{"schema":{"description":"Error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"},"errors":{"description":"An array of errors","type":"array","items":{"description":"Sub error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"}},"required":["message","code","description"],"example":{"message":"Invalid email","description":"The email you provided is invalid","code":4066},"$$ref":"#/components/schemas/SubError"}}},"example":{"message":"Unauthorized","description":"You are not authorized to access this resource","code":4065},"required":["message","code","description"],"$$ref":"#/components/schemas/Error"},"example":{"message":"Not Found","description":"The server cannot find the requested resource.","code":404}}},"$$ref":"#/components/responses/404"},"500":{"description":"Internal Server Error","headers":{"Date":{"description":"Date","example":"Tue, 15 Nov 1994 08:12:31 GMT","schema":{"type":"string","example":"Tue, 15 Nov 1994 08:12:31 GMT","nullable":true},"$$ref":"#/components/headers/Date"},"Cache-Control":{"description":"Cache-Control","example":"no-cache, no-store, must-revalidate","schema":{"type":"string","default":"no-cache","nullable":true},"$$ref":"#/components/headers/Cache-Control"}},"content":{"application/json":{"schema":{"description":"Error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"},"errors":{"description":"An array of errors","type":"array","items":{"description":"Sub error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"}},"required":["message","code","description"],"example":{"message":"Invalid email","description":"The email you provided is invalid","code":4066},"$$ref":"#/components/schemas/SubError"}}},"example":{"message":"Unauthorized","description":"You are not authorized to access this resource","code":4065},"required":["message","code","description"],"$$ref":"#/components/schemas/Error"},"example":{"message":"Internal Server Error","description":"The server encountered an unexpected condition that prevented it from fulfilling the request.","code":500}}},"$$ref":"#/components/responses/500"}},"security":[{"OAuth2":["fabric-admin","super-admin","observer","support-engineer","approver","designer"]}],"summary":"Get detailed information for a specific resource","tags":["Compliance Conformance and Update Analysis"],"__originalOperationId":"getResourceDetails","method":"get","path":"/deltaAnalysis/resourceDetails"}}