All Applications Analytics and Health

Overview

A list of applications managed by the BIG-IPs that are connected to BIG-IQ. This API provides health and statistics information for each application. This information can then be used to analyze and describe the performance of each application.

REST Endpoint: /mgmt/ap/query/v1/tenants/default/reports/AllApplicationsList

Requests

GET /mgmt/ap/query/v1/tenants/default/reports/AllApplicationsList

Query Parameters

Name Type Required Description
filter string False Specifies a string or integer used to filter the results. You can filter based on one or more parameters.
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.
orderby string False Specifies the sorting parameter and order to apply to results. You can sort by health, name, lastActivity, activeAlerts, transactionsPerSecond, connections, newConnections, responseTime, and for applications with security services, protectionMode. The sort order can be ascending (asc) or descending (desc). The default value is “health desc”, which sorts by health in descending order.
securityFrom string False Specifies the earliest application security data shown over the elapsed time period. The default uses the values of “-1d” for securityFrom and “now” for to, which starts from 1 day before the current time and ends at the current time.
skip number False Specifies the number of results in the ordered list to skip. The default value of skip is 0, meaning none are skipped and the results range from 1 to the top value.
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.
top number False Specify the maximum number of results in the ordered list. The default value is 10.

Response

HTTP/1.1 200 OK

Name Type Description
items object The items that appear in the query.
     activeAlerts number Number of active alerts that are currently opened for this application
     badTraffic number Application’s bad traffic rate
connections number The number of opened connections
     enhancedAnalytics boolean A flag for enhanced analytics collection and presentation
     findings string The application’s findings. “blockingValidTraffic” means traffic that was blocked due to false positives by blocking protection status. “successfulAttack” means traffic that was allowed, even though identified as an attack, due to transparent protection status. “blockedAttacks” means an identified attack value increased significantly over the past day, in relation to the past week. “dosSuccessfulAttack” means traffic that was allowed, even though identified as an DoS attack, due to transparent protection status. “dosBlockedAttacks” means traffic that was blocked due to false positives by blocking protection status. “none” - No attacks to the application were detected.
     health HealthEnum The application’s health. Possible values “Critical”, “Moderate”, “Good” or “Other”.
     id string The application’s unique identifier
     isBadTrafficGrowth boolean Is the application’s bad traffic grows over time?
     lastActivity number The last time the configuration of this application changed
     name string The application’s readable name
     newConnections number New connection creation rate
     prefix string prefix description goes here…
     protectionMode string The application’s protection mode. Possible values: “notProtected”, “transparent”, or “blocking”.
     responseTime number The application’s response time
     status string The application’s current status. Possible values: “CREATED”, “DEPLOYING”, “FAILED_DEPLOY”, “DEPLOYED”, “DELETING” and “FAILED_DELETE”.
     transactionsPerSecond number Number of transactions per second
itemsPerPage number The number of items per page.
pageIndex number The chronological page number as of which to display query results.
startIndex number The chronological item number as of which to display query results.
total number The total number of items queried.
totalPages number The total number of pages in the query result.

Permissions

Role Allow
Security Manager Yes

Examples

GET to retrieve a List of the existing applications

The following example returns the top 50 items ordered by the health in ascending order.

GET https://<BIG-IQ>/mgmt/ap/query/v1/tenants/default/reports/AllApplicationsList?$orderby=health asc&$skip=0&$top=50

Response

{
    "kind": "ap:compose:Report",
    "lastUpdateMicros": 317532368711,
    "result": {
            "totalItems": 3,
            "items": [{
                    "protectionMode": "Not Protected",
                    "findings": "None",
                    "id": "d6b485ce-06ec-38ea-bdd8-9c1053dc36c1",
                    "name": "Automation-01Ssg4App",
                    "lastActivity": 1551065637830,
                    "status": "FAILED_DEPLOY",
                    "transactionsPerSecond": 0.18666666666666668,
                    "connections": 0.0666666030883789,
                    "newConnections": 0.18666666666666668,
                    "responseTime": 0.0,
                    "health": "Other",
                    "activeAlerts": 2,
                    "badTraffic": 0.0,
                    "enhancedAnalytics": false,
                    "badTrafficGrowth": false
            }, {
                    "protectionMode": "Not Protected",
                    "findings": "None",
                    "id": "ed5870af-f9aa-3cb1-82cf-8df0a7c25d99",
                    "name": "Automation-01Ssg5App",
                    "lastActivity": 1551065737689,
                    "status": "FAILED_DEPLOY",
                    "connections": 0.0,
                    "newConnections": 0.0,
                    "health": "Other",
                    "activeAlerts": 0,
                    "badTraffic": 0.0,
                    "enhancedAnalytics": false,
                    "badTrafficGrowth": false
            }, {
                    "protectionMode": "Not Protected",
                    "findings": "None",
                    "id": "75c63195-b4ee-3984-835f-ad29241bccec",
                    "name": "Automation-01Ssg3App",
                    "lastActivity": 1551065541512,
                    "status": "FAILED_DEPLOY",
                    "connections": 0.0,
                    "newConnections": 0.0,
                    "health": "Other",
                    "activeAlerts": 0,
                    "badTraffic": 0.0,
                    "enhancedAnalytics": false,
                    "badTrafficGrowth": false
            }],
            "itemsPerPage": 0,
            "startIndex": 0,
            "totalPages": 0,
            "pageIndex": 0,
            "currentItemCount": 7
    },
    "requestDurationInMillis": 240
}

{
    "kind": "ap:compose:Report",
    "lastUpdateMicros": 317532368711,
    "result": {
            "totalItems": 3,
            "items": [{
                            "protectionMode": "Not Protected",
                            "findings": "None",
                            "id": "d6b485ce-06ec-38ea-bdd8-9c1053dc36c1",
                            "name": "Automation-01Ssg4App",
                            "lastActivity": 1551065637830,
                            "status": "FAILED_DEPLOY",
                            "transactionsPerSecond": 0.18666666666666668,
                            "connections": 0.0666666030883789,
                            "newConnections": 0.18666666666666668,
                            "responseTime": 0.0,
                            "health": "Other",
                            "activeAlerts": 2,
                            "badTraffic": 0.0,
                            "enhancedAnalytics": false,
                            "badTrafficGrowth": false
                    }, {
                            "protectionMode": "Not Protected",
                            "findings": "None",
                            "id": "ed5870af-f9aa-3cb1-82cf-8df0a7c25d99",
                            "name": "Automation-01Ssg5App",
                            "lastActivity": 1551065737689,
                            "status": "FAILED_DEPLOY",
                            "connections": 0.0,
                            "newConnections": 0.0,
                            "health": "Other",
                            "activeAlerts": 0,
                            "badTraffic": 0.0,
                            "enhancedAnalytics": false,
                            "badTrafficGrowth": false
                    }, {
                            "protectionMode": "Not Protected",
                            "findings": "None",
                            "id": "75c63195-b4ee-3984-835f-ad29241bccec",
                            "name": "Automation-01Ssg3App",
                            "lastActivity": 1551065541512,
                            "status": "FAILED_DEPLOY",
                            "connections": 0.0,
                            "newConnections": 0.0,
                            "health": "Other",
                            "activeAlerts": 0,
                            "badTraffic": 0.0,
                            "enhancedAnalytics": false,
                            "badTrafficGrowth": false
                    }
            ],
            "itemsPerPage": 0,
            "startIndex": 0,
            "totalPages": 0,
            "pageIndex": 0,
            "currentItemCount": 7
    },
    "requestDurationInMillis": 240
}

To order the response using orderby

Base expression format of orderby:

$orderby: <property name> <asc|desc>

For example:

$orderby: responseTime desc
$orderby: protectionMode asc

To filter the response using filter

Base expression format :

$filter <property name> eq <value>

Complex expression format:

$filter <expression> <and|or> <expression>
$filter: health eq 'Critical'
$filter: badTrafficGrowth eq 'true'
$filter: (health eq 'Critical') or (health eq 'Moderate') or (health eq 'Other')
$filter: (findings eq 'Successful Attack') or (findings eq 'Blocking Valid Traffic') or (badTrafficGrowth eq 'true') or (protectionMode eq 'Not Protected')
$filter: (allContent eq '*app*' or name eq '*app*' or health eq '*app*')
$filter: (allContent eq '*app*' or name eq '*app*' or health eq '*app*') and (name eq '*app*') and (name eq 'app')