Visit Azul.com Support

API Request Parameters

Table of Contents
Need help?
Schedule a consultation with an Azul performance expert.
Contact Us

Intelligence Cloud offers APIs for data requests and report generation. Detailed documentation for each component’s APIs is provided in the corresponding sections. Common request parameters applicable to all APIs are described below.

Common API Request Parameters

This is an overview of the common API request parameters.

Argument Type Description

reportName

string

Name of the report.

from

string

Relative or absolute time for the start of the report. See Filter Range and Date Format.

to

string

Relative or absolute time for the end of the report. See Filter Range and Date Format.

filter

list

List of filters as described in the Filter Rules.

sortBy

list

List of sorting conditions as described in the Sorting Rules.

Filter Range

To reduce the amount of data sent between JVMs, the Forwarder, and Azul Intelligence Cloud, the JVMs don’t send a continuous "heartbeat", but only the data needed for the reports in Intelligence Cloud.

Therefore, for the from and to filters, you must consider when a JVM sent data to Intelligence Cloud, which may differ from how long the JVM has been running.

For example:

  • An app that is started on Monday night and sends the dependency information.

  • On Tuesday morning, the app starts handling traffic, and the used methods are sent.

  • The application keeps running for the entire week without sending new data to the Forwarder and Intelligence Cloud.

In this example, when defining the filter to create an Intelligence Cloud report, you need to include the dates of that Monday and Tuesday. If you filter from Wednesday till the end of the week, this instance will not appear in the report.

Date Format

You can use relative or absolute times for the start and end times when you request the generation of a report via one of the APIs.

Relative Time

Relative time is calculated from the current time on the server (now) and can be specified as:

  • Days: Xd where X is an integer number of days in the past from now.

    • Examples:

      • 0d: today

      • 1d: yesterday

      • 365d: 1 year ago from today

  • Months: Xm where X is an integer number of months in the past from now.

    • Examples:

      • 1m = 1 month ago from today

      • 12m = 1 year ago from today

Absolute Time

Absolute time can be specified in:

  • ISO 8601 format: yyyy-MM-dd’T’HH:mm:ss.SSS

    • Example: 2022-05-01T12:43:50.000

  • Epoch time in milliseconds

    • Example: 1671397200000

Filter Rules

Depending on the type of API you are using, filtering can be applied on one or more fields. For example: AppEnv, componentName, componentVersion, tags.A, tags.B, tags.xxx,…​

Operand Description

=

Filters on exact equality.

!=

Filters on exact inequality.

= null

Filters on empty data.

!= null

Filters on non-empty data.

IN ('A', …​)

Filters on exact equality.

<=, >=, <, >

Use this filter to compare numbers (e.g. score) or the string representation of values (e.g. componentVersion).

CONTAINS '…​'

Filters on the fields containing the given value.

Sorting Rules

It is possible to sort by one or more of the fields. For example, the default sort is:

  • For Component Inventory:

     
    "sortBy": [
    "AppEnv=ASC",
    "componentName=ASC",
    "componentVersion=DESC"
]

  • For Vulnerability Detection:

     
    "sortBy": [
    "AppEnv=ASC",
    "componentName=ASC",
    "componentVersion=DESC"
    "cveState=DESC",
    "cveId=DESC"
]