Get Applications Browse - Nexus Dashboard API v1, Release 4.2 and above

{"type":"api","title":"Get Applications Browse","meta":{"id":"/apps/pubhub/media/nexus-dashboard-api-v1/86cc2501c92a7370499e3d537496e5c722396afb/bd1d3c86-e531-31dc-81ae-49c9907bffa7","info":{"contact":{"name":"Cisco Technical Assistance Center (TAC)","url":"https://developer.cisco.com/docs/nexus-dashboard/latest/#developer-support/"},"description":"Infrastructure APIs are largely used to manage the ND cluster","license":{"name":"Cisco","url":"https://www.cisco.com/site/us/en/about/legal/contract-experience/index.html"},"title":"Nexus Dashboard Infrastructure v1","version":"1.1.136"},"tags":[{"name":"Authentication"},{"name":"System Status"},{"name":"System Settings"},{"name":"Multi-Cluster Connectivity"},{"name":"License Management"},{"name":"Integrations"},{"name":"System Software"},{"name":"Backup and Restore"},{"name":"History and Logs"},{"name":"Tech Support"},{"name":"Users and Security"},{"name":"Certificate Management"},{"name":"Multi Tenancy"},{"name":"System Bootstrap"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview-infra.md"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}}},"openapi":"3.0.3","servers":[{"description":"Nexus Dashboard Infrastructure APIs","url":"https://{cluster}/api/v1/infra","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":"Get summary status of objects such as health status of applications, latency of netlinks, etc.,","operationId":"getApplicationsBrowse","parameters":[{"description":"Object in the application hierarchy","example":"application","in":"query","name":"object","required":true,"schema":{"enum":["application","tier","node","netlink","flow"],"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":"Start date","in":"query","name":"startDate","required":false,"schema":{"format":"date-time","type":"string"},"$$ref":"#/components/parameters/startDate"},{"description":"End date","in":"query","name":"endDate","required":false,"schema":{"format":"date-time","type":"string"},"$$ref":"#/components/parameters/endDate"},{"description":"Name of the fabric","in":"query","name":"fabricName","required":false,"schema":{"nullable":true,"type":"string","maxLength":64,"minLength":1},"$$ref":"#/components/parameters/fabricName"},{"description":"Lucene format filter - Filter the response based on this filter field","in":"query","name":"filter","schema":{"type":"string"},"$$ref":"#/components/parameters/filter"},{"description":"Number of records to skip for pagination","in":"query","name":"offset","required":false,"schema":{"type":"integer"},"$$ref":"#/components/parameters/offset"},{"description":"Number of records to return","in":"query","name":"max","required":false,"schema":{"type":"integer"},"$$ref":"#/components/parameters/max"},{"description":"Sort the records by the declared fields in either ascending (default) or descending (:desc) order\nAscending order by default: \"field1\"\nSpecific order for one field: \"field1:asc\" or \"field1:desc\"\nSpecific order with multiple fields: \"field1:asc,field2:desc\"\n","in":"query","name":"sort","required":false,"schema":{"type":"string"},"$$ref":"#/components/parameters/sort"}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Response for browsing applications, tiers, nodes, network links, or flow groups. The entire items array is oneOf the entity type.","discriminator":{"mapping":{"application":"#/components/schemas/browseApplicationsApplicationResponse","flow":"#/components/schemas/browseApplicationsFlowgroupResponse","netlink":"#/components/schemas/browseApplicationsNetworkLinkResponse","node":"#/components/schemas/browseApplicationsNodeResponse","tier":"#/components/schemas/browseApplicationsTierResponse"},"propertyName":"objectType"},"oneOf":[{"description":"Browse Application response.","example":{"items":[{"accountName":"customer1","anomalyScore":96,"applicationDisplayName":"EComm-NPM-Demo","applicationId":8,"applicationName":"EComm-NPM-Demo","controllerIp":"90.1.1.2","controllerPort":"8090","currentEstablishedConnectionCount":100,"distinguishedEntityName":"controller-test-cntl/account-customer1/app-8","entityName":"EComm-NPM-Demo","entityType":"application","errorCount":0,"fabricName":"swmp3","healthState":{"businessTransactions":{"criticalCount":0,"normalCount":30,"warningCount":0},"nodes":{"normalCount":6,"warningCount":2},"state":"CRITICAL","stateValue":3,"tiers":{"normalCount":2,"undefinedCount":1,"warningCount":1}},"healthStateValue":3,"integrationId":"appDynamics-1.2.3.4","integrationName":"controller1","latencyRoundTripTime":6.004,"lossPerMille":0,"nodeCount":8,"pieEventCount":485,"pktsPerSec":5587,"throughputBitsPerSecond":1243.553,"tierCount":4,"totalAnomalyScore":96}],"meta":{"counts":{"remaining":0,"total":1}},"objectType":"application"},"properties":{"items":{"description":"List of applications","items":{"description":"Response for browsing applications, including detailed application metrics and health information.","properties":{"accountName":{"description":"The name of the account associated with the application.","type":"string"},"anomalyScore":{"description":"Score indicating the degree of anomaly detected in the application.","type":"number"},"applicationDisplayName":{"description":"A display name for the application.","type":"string"},"applicationId":{"description":"Unique identifier for the application.","type":"integer"},"applicationName":{"description":"The name of the application.","type":"string"},"controllerIp":{"description":"The IP address of the controller managing the application.","type":"string"},"controllerPort":{"description":"The port number on which the controller is listening.","type":"string"},"currentEstablishedConnectionCount":{"description":"Number of currently established connections to the application.","type":"integer"},"distinguishedEntityName":{"description":"Distinguished name (DN) of the application entity.","type":"string"},"entityName":{"description":"Name of the entity representing the application.","type":"string"},"entityType":{"description":"The type of entity represented, such as \"Application\".","type":"string"},"errorCount":{"description":"Number of errors recorded for the application.","type":"integer"},"fabricName":{"description":"The name of the fabric associated with the application.","example":"fab2","type":"string"},"healthState":{"description":"Health state metrics for the application.","properties":{"businessTransactions":{"description":"Health metrics for the application's business transactions.","nullable":false,"properties":{"criticalCount":{"description":"Number with a critical health state.","example":2,"type":"integer"},"normalCount":{"description":"Number with a normal health state.","example":2,"type":"integer"},"undefinedCount":{"description":"Number with an undefined health state.","example":3,"type":"integer"},"warningCount":{"description":"Number with a warning health state.","example":1,"type":"integer"}},"type":"object","$$ref":"#/components/schemas/healthStateProperties"},"nodes":{"description":"Health metrics for the application's nodes.","nullable":false,"properties":{"criticalCount":{"description":"Number with a critical health state.","example":2,"type":"integer"},"normalCount":{"description":"Number with a normal health state.","example":2,"type":"integer"},"undefinedCount":{"description":"Number with an undefined health state.","example":3,"type":"integer"},"warningCount":{"description":"Number with a warning health state.","example":1,"type":"integer"}},"type":"object","$$ref":"#/components/schemas/healthStateProperties"},"state":{"description":"Descriptive label for the application's overall health state.","example":"CRITICAL","type":"string"},"stateValue":{"description":"Numeric representation of the application's overall health state.","example":3,"type":"integer"},"tiers":{"description":"Health metrics for the application's tiers.","nullable":false,"properties":{"criticalCount":{"description":"Number with a critical health state.","example":2,"type":"integer"},"normalCount":{"description":"Number with a normal health state.","example":2,"type":"integer"},"undefinedCount":{"description":"Number with an undefined health state.","example":3,"type":"integer"},"warningCount":{"description":"Number with a warning health state.","example":1,"type":"integer"}},"type":"object","$$ref":"#/components/schemas/healthStateProperties"}},"type":"object","$$ref":"#/components/schemas/applicationHealthState"},"healthStateValue":{"description":"Numeric value representing the overall health state of the application.","type":"integer"},"integrationId":{"description":"The id of integrated appDynamics controller managing the application.","type":"string"},"integrationName":{"description":"User defined name for the Power Distribution Unit Collector","example":"myPduCollector1","type":"string","$$ref":"#/components/schemas/integrationName"},"latencyRoundTripTime":{"description":"Round-trip time latency of the application measured in microseconds.","type":"number"},"lossPerMille":{"description":"Packet loss rate measured in parts per thousand.","type":"integer"},"nodeCount":{"description":"Number of nodes within the application.","type":"integer"},"packetsPerSecond":{"description":"Number of packets processed per second by the application.","type":"integer"},"pieEventCount":{"description":"Number of Performance Insights Events (PIE) associated with the application.","type":"integer"},"throughputBitsPerSecond":{"description":"Throughput of the application in bits per second.","type":"number"},"tierCount":{"description":"Number of tiers within the application.","type":"integer"},"totalAnomalyScore":{"description":"Total score representing the overall anomaly level across the application.","type":"number"}},"type":"object","$$ref":"#/components/schemas/browseApplication"},"type":"array"},"meta":{"type":"object","description":"The metadata of the records","properties":{"counts":{"type":"object","description":"The metadata of the records","required":["total","remaining"],"properties":{"total":{"type":"integer","description":"The total number of records","example":50},"remaining":{"type":"integer","description":"The remaining number of records","example":40}},"$$ref":"#/components/schemas/MetadataCounts"},"links":{"type":"object","description":"The links to the next and previous pages","properties":{"next":{"type":"string","description":"The link to the next page","example":"https://api.example.com/v1/my-api?offset=40&max=10"},"previous":{"type":"string","description":"The link to the previous page","example":"https://api.example.com/v1/my-api?offset=20&max=10"}},"$$ref":"#/components/schemas/MetadataLinks"}},"example":{"counts":{"total":50,"remaining":40},"links":{"next":"https://api.example.com/v1/my-api?offset=40&max=10","previous":"https://api.example.com/v1/my-api?offset=20&max=10"}},"$$ref":"#/components/schemas/Metadata"},"objectType":{"description":"Discriminator value identifying this response as containing application entities.","enum":["application"],"type":"string"}},"required":["objectType","items","meta"],"type":"object","$$ref":"#/components/schemas/browseApplicationsApplicationResponse"},{"description":"Response for browsing tiers, including detailed tier metrics and health information.","example":{"items":[{"accountName":"customer1","anomalyScore":100,"applicationDisplayName":"EComm-NPM-Demo","applicationId":8,"applicationName":"EComm-NPM-Demo","controllerIp":"90.1.1.2","controllerPort":"8090","currentEstablishedConnectionCount":100,"distinguishedEntityName":"controller-test-cntl/account-customer1/app-8/tier-14","entityName":"Ecom-Tier","entityType":"tier","errorCount":0,"fabricName":"swmp3","healthState":{"state":"WARNING","stateValue":2},"healthStateValue":2,"integrationId":"appDynamics-1.2.3.4","integrationName":"controller1","latencyRoundTripTime":5.772,"lossPerMille":0,"nodeCount":2,"pieEventCount":618,"pktsPerSec":5694,"throughputBitsPerSecond":1268.078,"tierName":"Ecom-Tier","totalAnomalyScore":100}],"meta":{"counts":{"remaining":0,"total":1}},"objectType":"tier"},"properties":{"items":{"description":"List of tiers","items":{"description":"Response for browsing tier, including detailed tier metrics and health information.","properties":{"accountName":{"description":"The name of the account associated with the tier.","type":"string"},"anomalyScore":{"description":"Score indicating the degree of anomaly detected in the tier.","type":"number"},"applicationDisplayName":{"description":"A display name for the application to which the tier belongs.","type":"string"},"applicationId":{"description":"Unique identifier for the application to which the tier belongs.","type":"integer"},"applicationName":{"description":"The name of the application to which the tier belongs.","type":"string"},"controllerIp":{"description":"The IP address of the controller managing the tier.","type":"string"},"controllerPort":{"description":"The port number on which the controller is listening.","type":"string"},"currentEstablishedConnectionCount":{"description":"Number of currently established connections to the tier.","type":"integer"},"distinguishedEntityName":{"description":"Distinguished name (DN) of the tier entity.","type":"string"},"entityName":{"description":"Name of the entity representing the tier.","type":"string"},"entityType":{"description":"The type of entity represented, such as \"Tier\".","type":"string"},"errorCount":{"description":"Number of errors recorded for the tier.","type":"integer"},"fabricName":{"description":"The name of the fabric associated with the tier.","example":"fab2","type":"string"},"healthState":{"description":"Health state metrics for the tier.","properties":{"state":{"description":"Descriptive label of the overall health state of the tier.","type":"string"},"stateValue":{"description":"Numeric representation of the overall health state of the tier.","type":"integer"}},"type":"object","$$ref":"#/components/schemas/healthMetrics"},"healthStateValue":{"description":"Numeric value representing the overall health state of the tier.","type":"integer"},"integrationId":{"description":"The id of integrated appDynamics controller managing the tier.","type":"string"},"integrationName":{"description":"User defined name for the Power Distribution Unit Collector","example":"myPduCollector1","type":"string","$$ref":"#/components/schemas/integrationName"},"latencyRoundTripTime":{"description":"Round-trip time latency of the tier measured in microseconds.","type":"number"},"lossPerMille":{"description":"Packet loss rate measured in parts per thousand.","type":"integer"},"nodeCount":{"description":"Number of nodes within the tier.","type":"integer"},"packetsPerSecond":{"description":"Number of packets processed per second by the tier.","type":"integer"},"pieEventCount":{"description":"Number of Performance Insights Events (PIE) associated with the tier.","type":"integer"},"throughputBitsPerSecond":{"description":"Throughput of the tier in bits per second.","type":"number"},"tierName":{"description":"The name of the tier.","type":"string"},"totalAnomalyScore":{"description":"Total score representing the overall anomaly level across the tier.","type":"number"}},"type":"object","$$ref":"#/components/schemas/browseTier"},"type":"array"},"meta":{"type":"object","description":"The metadata of the records","properties":{"counts":{"type":"object","description":"The metadata of the records","required":["total","remaining"],"properties":{"total":{"type":"integer","description":"The total number of records","example":50},"remaining":{"type":"integer","description":"The remaining number of records","example":40}},"$$ref":"#/components/schemas/MetadataCounts"},"links":{"type":"object","description":"The links to the next and previous pages","properties":{"next":{"type":"string","description":"The link to the next page","example":"https://api.example.com/v1/my-api?offset=40&max=10"},"previous":{"type":"string","description":"The link to the previous page","example":"https://api.example.com/v1/my-api?offset=20&max=10"}},"$$ref":"#/components/schemas/MetadataLinks"}},"example":{"counts":{"total":50,"remaining":40},"links":{"next":"https://api.example.com/v1/my-api?offset=40&max=10","previous":"https://api.example.com/v1/my-api?offset=20&max=10"}},"$$ref":"#/components/schemas/Metadata"},"objectType":{"description":"Discriminator value identifying this response as containing tier entities.","enum":["tier"],"type":"string"}},"required":["objectType","items","meta"],"type":"object","$$ref":"#/components/schemas/browseApplicationsTierResponse"},{"description":"Response for browsing nodes, including detailed node metrics and health information.","example":{"items":[{"accountName":"customer1","anomalyScore":0,"applicationDisplayName":"EComm-NPM-Demo","applicationId":8,"applicationName":"EComm-NPM-Demo","controllerIp":"90.1.1.2","controllerPort":"8090","distinguishedEntityName":"controller-test-cntl/account-customer1/app-8/tier-14/node-211","entityName":"ECOM-N1_1","entityType":"node","errorCount":0,"fabricName":"swmp3","healthState":{"state":"WARNING","stateValue":2},"healthStateValue":2,"integrationId":"appDynamics-1.2.3.4","integrationName":"controller1","ipAddresses":[{"displayBd":"ecom","displayEpg":"ecom","displayVrf":"appdynamics","fabricName":"swmp3","interfaceName":"eth1/3","ip":"40.1.1.10","nodeNames":[{"ifDn":"fabric-swmp3/node-swmp3-leaf8/interface-eth1_3","nodeName":"swmp3-leaf8"}],"tenant":"appdynamics"},{"ip":"172.25.229.50"}],"jvmCurrentHeapUtilization":362,"latencyRoundTripTime":5.772,"lossPerMille":0,"nodeName":"ECOM-N1_1","pieEventCount":309,"throughputBitsPerSecond":634.039,"tierName":"Ecom-Tier","totalAnomalyScore":0}],"meta":{"counts":{"remaining":0,"total":1}},"objectType":"node"},"properties":{"items":{"description":"List of nodes","items":{"description":"The offset value used for pagination. It specifies the starting point of the data returned in this response.","properties":{"accountName":{"description":"The name of the account associated with the node.","type":"string"},"anomalyScore":{"description":"Score indicating the degree of anomaly detected in the node.","type":"number"},"applicationDisplayName":{"description":"A display name for the application to which the node belongs.","type":"string"},"applicationId":{"description":"Unique identifier for the application to which the node belongs.","type":"integer"},"applicationName":{"description":"The name of the application to which the node belongs.","type":"string"},"controllerIp":{"description":"The IP address of the controller managing the node.","type":"string"},"controllerPort":{"description":"The port number on which the controller is listening.","type":"string"},"distinguishedEntityName":{"description":"Distinguished name (DN) of the node entity.","type":"string"},"entityName":{"description":"Name of the entity representing the node.","type":"string"},"entityType":{"description":"The type of entity represented, such as \"Node\".","type":"string"},"errorCount":{"description":"Number of errors recorded for the node.","type":"integer"},"fabricName":{"description":"The name of the fabric associated with the node.","example":"fab2","type":"string"},"healthState":{"description":"Health state metrics for the node.","properties":{"state":{"description":"Descriptive label of the overall health state of the tier.","type":"string"},"stateValue":{"description":"Numeric representation of the overall health state of the tier.","type":"integer"}},"type":"object","$$ref":"#/components/schemas/healthMetrics"},"healthStateValue":{"description":"Numeric value representing the overall health state of the node.","type":"integer"},"integrationId":{"description":"The id of integrated appDynamics controller managing the node.","type":"string"},"integrationName":{"description":"User defined name for the Power Distribution Unit Collector","example":"myPduCollector1","type":"string","$$ref":"#/components/schemas/integrationName"},"ipAddresses":{"description":"List of IP addresses associated with the node.","items":{"description":"IP addresses associated with the node.","properties":{"displayBd":{"description":"Display Bridge Domain (BD) associated with the IP address.","type":"string"},"displayEpg":{"description":"Display Endpoint Groups (EPG) associated with the IP address.","type":"string"},"displayVrf":{"description":"Display Virtual Routing and Forwarding (VRF) associated with the IP address.","type":"string"},"fabricName":{"description":"The name of the fabric associated with the IP address.","example":"fab2","type":"string"},"interfaceName":{"description":"Name of the network interface associated with the IP address.","type":"string"},"ip":{"description":"IP address of the node.","type":"string"},"nodeNames":{"description":"List of node names related to the IP address.","items":{"description":"Node name related to the IP address.","properties":{"distinguishedInterfaceName":{"description":"Interface distinguished name (DN) related to the IP address.","type":"string"},"nodeName":{"description":"Name of the node associated with the IP address.","type":"string"}},"type":"object","$$ref":"#/components/schemas/browseNodeNodeName"},"type":"array"},"tenant":{"description":"Tenant information related to the IP address.","type":"string"}},"type":"object","$$ref":"#/components/schemas/nodeIpAdress"},"type":"array"},"jvmCurrentHeapUtilization":{"description":"Current JVM heap utilization percentage.","type":"number"},"jvmMaxHeap":{"description":"Maximum JVM heap size in bytes.","type":"number"},"jvmPercentHeap":{"description":"Percentage of JVM heap used.","type":"number"},"latencyRoundTripTime":{"description":"Round-trip time latency of the node measured in microseconds.","type":"number"},"lossPerMille":{"description":"Packet loss rate measured in parts per thousand.","type":"integer"},"nodeName":{"description":"The name of the node.","type":"string"},"pieEventCount":{"description":"Number of Performance Insights Events (PIE) associated with the node.","type":"integer"},"throughputBitsPerSecond":{"description":"Throughput of the node in bits per second.","type":"number"},"tierName":{"description":"The name of the tier to which the node belongs.","type":"string"},"totalAnomalyScore":{"description":"Total score representing the overall anomaly level across the node.","type":"number"}},"type":"object","$$ref":"#/components/schemas/browseNode"},"type":"array"},"meta":{"type":"object","description":"The metadata of the records","properties":{"counts":{"type":"object","description":"The metadata of the records","required":["total","remaining"],"properties":{"total":{"type":"integer","description":"The total number of records","example":50},"remaining":{"type":"integer","description":"The remaining number of records","example":40}},"$$ref":"#/components/schemas/MetadataCounts"},"links":{"type":"object","description":"The links to the next and previous pages","properties":{"next":{"type":"string","description":"The link to the next page","example":"https://api.example.com/v1/my-api?offset=40&max=10"},"previous":{"type":"string","description":"The link to the previous page","example":"https://api.example.com/v1/my-api?offset=20&max=10"}},"$$ref":"#/components/schemas/MetadataLinks"}},"example":{"counts":{"total":50,"remaining":40},"links":{"next":"https://api.example.com/v1/my-api?offset=40&max=10","previous":"https://api.example.com/v1/my-api?offset=20&max=10"}},"$$ref":"#/components/schemas/Metadata"},"objectType":{"description":"Discriminator value identifying this response as containing node entities.","enum":["node"],"type":"string"}},"required":["objectType","items","meta"],"type":"object","$$ref":"#/components/schemas/browseApplicationsNodeResponse"},{"description":"Response for browsing network links, including detailed network link metrics and health information.","example":{"items":[{"accountName":"customer1","anomalyScore":0,"applicationDisplayName":"EComm-NPM-Demo","applicationId":8,"applicationName":"EComm-NPM-Demo","connectionErrorCount":0,"connectionRequestCount":0,"controllerIp":"90.1.1.2","controllerPort":"8090","currentEstablishedConnectionCount":100,"dataReTxCount":618,"distinguishedEntityName":"controller-test-cntl/account-customer1/app-8/netlink-68","dstEntity":"APPDY-MySQL-DB-5.5.58-0ubuntu0.14.04.1","dstEntityType":"backend","entityName":68,"entityType":"netlink","errorCount":0,"fabricName":"swmp3","flowGroupCount":2,"initialLatencyRoundTripTime":138,"integrationId":"appDynamics-1.2.3.4","integrationName":"controller1","latencyRoundTripTime":5.772,"lossPerMille":0,"netlinkId":68,"pieEventCount":618,"reTxTimeoutCount":618,"srcEntity":"Ecom-Tier","srcEntityType":"tier","tcpHandshakeRttUsec":138,"tcpResetCount":0,"throughputBitsPerSecond":1268.078,"totalAnomalyScore":0}],"meta":{"counts":{"remaining":0,"total":1}},"objectType":"netlink"},"properties":{"items":{"description":"List of network links","items":{"description":"Response for browsing network links, including detailed network link metrics and health information.","properties":{"accountName":{"description":"The name of the account associated with the network link.","type":"string"},"anomalyScore":{"description":"Score indicating the degree of anomaly detected in the network link.","type":"number"},"applicationDisplayName":{"description":"A display name for the application to which the network link belongs.","type":"string"},"applicationId":{"description":"Unique identifier for the application to which the network link belongs.","type":"integer"},"applicationName":{"description":"The name of the application to which the network link belongs.","type":"string"},"connectionErrorCount":{"description":"Number of connection errors recorded for the network link.","type":"integer"},"connectionRequestCount":{"description":"Number of connection requests recorded for the network link.","type":"integer"},"controllerIp":{"description":"The IP address of the controller managing the network link.","type":"string"},"controllerPort":{"description":"The port number on which the controller is listening.","type":"string"},"currentEstablishedConnectionCount":{"description":"Number of currently established connections through the network link.","type":"integer"},"dataReTxCount":{"description":"Number of data retransmissions recorded for the network link.","type":"integer"},"distinguishedEntityName":{"description":"Distinguished name (DN) of the network link entity.","type":"string"},"dstEntity":{"description":"The destination entity associated with the network link.","type":"string"},"dstEntityType":{"description":"The type of the destination entity, such as \"Node\" or \"Tier\".","type":"string"},"entityName":{"description":"Name of the entity representing the network link.","type":"integer"},"entityType":{"description":"The type of entity represented, such as \"Network Link\".","type":"string"},"errorCount":{"description":"Number of errors recorded for the network link.","type":"integer"},"fabricName":{"description":"The name of the fabric associated with the network link.","example":"fab2","type":"string"},"flowGroupCount":{"description":"Number of flow groups associated with the network link.","type":"integer"},"initialLatencyRoundTripTime":{"description":"Initial round-trip time latency measured in microseconds.","type":"integer"},"integrationId":{"description":"The id of integrated appDynamics controller managing the network link.","type":"string"},"integrationName":{"description":"User defined name for the Power Distribution Unit Collector","example":"myPduCollector1","type":"string","$$ref":"#/components/schemas/integrationName"},"latencyRoundTripTime":{"description":"Round-trip time latency of the network link measured in microseconds.","type":"number"},"lossPerMille":{"description":"Packet loss rate measured in parts per thousand.","type":"integer"},"netlinkId":{"description":"Unique identifier for the network link.","type":"integer"},"pieEventCount":{"description":"Number of Performance Insights Events (PIE) associated with the network link.","type":"integer"},"reTxTimeoutCount":{"description":"Number of retransmission timeouts recorded for the network link.","type":"integer"},"srcEntity":{"description":"The source entity associated with the network link.","type":"string"},"srcEntityType":{"description":"The type of the source entity, such as \"Node\" or \"Tier\".","type":"string"},"tcpHandshakeRoundTripTime":{"description":"TCP handshake round-trip time latency measured in microseconds.","type":"integer"},"tcpResetCount":{"description":"Number of TCP resets recorded for the network link.","type":"integer"},"throughputBitsPerSecond":{"description":"Throughput of the network link in bits per second.","type":"number"},"totalAnomalyScore":{"description":"Total score representing the overall anomaly level across the network link.","type":"number"}},"type":"object","$$ref":"#/components/schemas/browseNetworkLink"},"type":"array"},"meta":{"type":"object","description":"The metadata of the records","properties":{"counts":{"type":"object","description":"The metadata of the records","required":["total","remaining"],"properties":{"total":{"type":"integer","description":"The total number of records","example":50},"remaining":{"type":"integer","description":"The remaining number of records","example":40}},"$$ref":"#/components/schemas/MetadataCounts"},"links":{"type":"object","description":"The links to the next and previous pages","properties":{"next":{"type":"string","description":"The link to the next page","example":"https://api.example.com/v1/my-api?offset=40&max=10"},"previous":{"type":"string","description":"The link to the previous page","example":"https://api.example.com/v1/my-api?offset=20&max=10"}},"$$ref":"#/components/schemas/MetadataLinks"}},"example":{"counts":{"total":50,"remaining":40},"links":{"next":"https://api.example.com/v1/my-api?offset=40&max=10","previous":"https://api.example.com/v1/my-api?offset=20&max=10"}},"$$ref":"#/components/schemas/Metadata"},"objectType":{"description":"Discriminator value identifying this response as containing network link entities.","enum":["netlink"],"type":"string"}},"required":["objectType","items","meta"],"type":"object","$$ref":"#/components/schemas/browseApplicationsNetworkLinkResponse"},{"description":"Response for browsing flow groups, including detailed flow group metrics and health information.","example":{"items":[{"accountName":"customer1","applicationDisplayName":"EComm-NPM-Demo","applicationId":8,"applicationName":"EComm-NPM-Demo","controllerIp":"90.1.1.2","controllerPort":"8090","distinguishedEntityName":"controller-test-cntl/account-customer1/app-8/netlink-68/flowgroup-68:102:211","dstEntity":"APPDY-MySQL-DB-5.5.58-0ubuntu0.14.04.1","dstEntityType":"backend","dstIp":"80.1.1.10","dstPort":3306,"entityType":"flow","fabricName":"swmp3","flowgroupId":"68:102:211","integrationId":"appDynamics-1.2.3.4","integrationName":"controller1","netlinkId":68,"protocol":"TCP","protocolNumber":6,"srcEntity":"ECOM-N1_1","srcEntityType":"node","srcIp":"40.1.1.10"}],"meta":{"counts":{"remaining":0,"total":1}},"objectType":"flow"},"properties":{"items":{"description":"List of flow groups","items":{"description":"Response for browsing flow groups, including detailed flow group metrics and health information.","properties":{"accountName":{"description":"The name of the account associated with the flow group.","type":"string"},"anomalyScore":{"description":"Score indicating the degree of anomaly detected in the flow group.","type":"number"},"applicationDisplayName":{"description":"A display name for the application to which the flow group belongs.","type":"string"},"applicationId":{"description":"Unique identifier for the application to which the flow group belongs.","type":"integer"},"applicationName":{"description":"The name of the application to which the flow group belongs.","type":"string"},"controllerIp":{"description":"The IP address of the controller managing the flow group.","type":"string"},"controllerPort":{"description":"The port number on which the controller is listening.","type":"string"},"distinguishedEntityName":{"description":"Distinguished name (DN) of the flow group entity.","type":"string"},"dstEntity":{"description":"The destination entity associated with the flow group.","type":"string"},"dstEntityType":{"description":"The type of the destination entity, such as \"Node\" or \"Tier\".","type":"string"},"dstIp":{"description":"Destination IP address associated with the flow group.","type":"string"},"dstPort":{"description":"Destination port number associated with the flow group.","type":"integer"},"entityName":{"description":"Name of the entity representing the flow group.","type":"string"},"entityType":{"description":"The type of entity represented, such as \"Flow Group\".","type":"string"},"fabricName":{"description":"The name of the fabric associated with the flow group.","example":"fab2","type":"string"},"flowgroupId":{"description":"Unique identifier for the flow group.","type":"string"},"integrationId":{"description":"The id of integrated appDynamics controller managing the flow group.","type":"string"},"integrationName":{"description":"User defined name for the Power Distribution Unit Collector","example":"myPduCollector1","type":"string","$$ref":"#/components/schemas/integrationName"},"netlinkId":{"description":"Unique identifier for the network link associated with the flow group.","type":"integer"},"protocol":{"description":"Network protocol used by the flow group.","type":"string"},"protocolNumber":{"description":"Numeric representation of the network protocol used by the flow group.","type":"integer"},"srcEntity":{"description":"The source entity associated with the flow group.","type":"string"},"srcEntityType":{"description":"The type of the source entity, such as \"Node\" or \"Tier\".","type":"string"},"srcIp":{"description":"Source IP address associated with the flow group.","type":"string"},"srcPort":{"description":"Source port number associated with the flow group.","type":"integer"},"totalAnomalyScore":{"description":"Total score representing the overall anomaly level across the flow group.","type":"number"}},"type":"object","$$ref":"#/components/schemas/browseFlowGroups"},"type":"array"},"meta":{"type":"object","description":"The metadata of the records","properties":{"counts":{"type":"object","description":"The metadata of the records","required":["total","remaining"],"properties":{"total":{"type":"integer","description":"The total number of records","example":50},"remaining":{"type":"integer","description":"The remaining number of records","example":40}},"$$ref":"#/components/schemas/MetadataCounts"},"links":{"type":"object","description":"The links to the next and previous pages","properties":{"next":{"type":"string","description":"The link to the next page","example":"https://api.example.com/v1/my-api?offset=40&max=10"},"previous":{"type":"string","description":"The link to the previous page","example":"https://api.example.com/v1/my-api?offset=20&max=10"}},"$$ref":"#/components/schemas/MetadataLinks"}},"example":{"counts":{"total":50,"remaining":40},"links":{"next":"https://api.example.com/v1/my-api?offset=40&max=10","previous":"https://api.example.com/v1/my-api?offset=20&max=10"}},"$$ref":"#/components/schemas/Metadata"},"objectType":{"description":"Discriminator value identifying this response as containing flow group entities.","enum":["flow"],"type":"string"}},"required":["objectType","items","meta"],"type":"object","$$ref":"#/components/schemas/browseApplicationsFlowgroupResponse"}],"$$ref":"#/components/schemas/browseApplications"}}},"description":"OK","headers":{"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"},"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"}}},"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"},"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":["super-admin","fabric-admin","observer","support-engineer","approver","designer"]}],"summary":"Browse application objects","tags":["Integrations"],"__originalOperationId":"getApplicationsBrowse","method":"get","path":"/integrations/appdynamics/browse"}}