Applications Summary¶

Overview¶

A summary overview of all applications, managed by the BIG-IP devices that are connected to BIG-IQ centralized management.

REST Endpoint: /mgmt/ap/query/v1/tenants/default/reports/ApplicationsSummary¶

Requests¶

GET /mgmt/ap/query/v1/tenants/default/reports/ApplicationsSummary¶

Query Parameters¶

Name	Type	Required	Description
$limit	string	False	Specify the max number of top results to be returned. The default value is “5”.
$from	string	False	Specifies time to start results. The default uses the values of “-5m” for from and “now” for to, which starts from 5 minutes before the current time and ends at the current time.
$to	string	False	Specifies time to end results. The default uses the values of “-5m” for from and “now” for to, which starts from 5 minutes before the current time and ends at the current time.

Response¶

HTTP/1.1 200 OK

Name	Type	Description
health	object	The number of applications by health status of Critical, Moderate, Good, or Other.
critical	number	The number of objects with a critical health status
good	number	The number of objects with a good health status
moderate	number	The number of objects with a moderate health status
other	number	The number of objects with an unknown health status
response-time	object	Top applications by average response time.
application	string	The application’s readable name
response-time	number	The average application’s response time.
http-tps	object	Top applications by average HTTP transactions per second.
application	string	The application’s readable name
http-tps	number	The application’s average HTTP transactions per second.
concurrent-connections	object	Top applications by average number of open connections.
application	string	The application’s readable name
concurrent-connections	number	The application’s average number of open connections.
numOfAppsNotProtected	number	Number of applications that have application services without protection.
numOfAppsWithBadTrafficGrowth	number	Number of applications that have application services that display bad traffic growth.
numOfAppsWithBlockingValidTraffic	number	Number of applications that have application services that display false positives attacks.
numOfAppsWithSuccessfulAttacks	number	Number of applications that have application services that display potentially harmful attacks.
totalApplications	number	Total number of application services in all applications.

Permissions¶

Role	Allow
Application Viewer	Yes
Application Manager	Yes
Application Creator	Yes
Application Editor	Yes
Global Application Viewer	Yes
Global Application Manager	Yes

Examples¶

GET to retrieve application services summary for an application¶

Following is an example of a response to the default API call, with no parameters.

GET https://<BIG-IQ>/mgmt/ap/query/v1/tenants/default/reports/ApplicationsSummary

Response¶

  {
  "kind": "ap:compose:Report",
  "lastUpdateMicros": 206511269449,
  "result": {
      "health": {
          "Critical": 1,
          "Moderate": 1,
          "Good": 1,
          "Other": 0
      },
      "numOfAppsNotProtected": 3,
      "numOfAppsWithBadTrafficGrowth": 0,
      "numOfAppsWithBlockingValidTraffic": 0,
      "numOfAppsWithSuccessfulAttacks": 0,
      "concurrent-connections": [
          {
              "application": "myWebApp_API",
              "concurrent-connections": 0.027777777777777776
          },
          {
              "application": "Unknown Applications",
              "concurrent-connections": 0.0
          },
          {
              "application": "myWebApp_UI",
              "concurrent-connections": 0.0
          }
      ],
      "http-tps": [
          {
              "application": "myWebApp_UI",
              "http-tps": 0.4740740740740741
          },
          {
              "application": "myWebApp_API",
              "http-tps": 0.3333333333333333
          },
          {
              "application": "Unknown Applications",
              "http-tps": 0.044444444444444446
          }
      ],
      "response-time": [
          {
              "application": "myWebApp_API",
              "response-time": 0.14444444444444443
          },
          {
              "application": "Unknown Applications",
              "response-time": 0.0
          },
          {
              "application": "myWebApp_UI",
              "response-time": 0.0
          }
      ]
  },
  "requestDurationInMillis": 341
}

Previous Next