Visit Azul.com Support

API Request Parameters

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

This is an overview of the common API request parameters.

Argument Default Description

reportName

string

Name of the report.

from

string

Relative or absolute time that will be applied to the firstSeen timestamp of the AppEnv. See API Date Filter Format.

to

string

Relative or absolute time that will be applied to the lastSeen timestamp of the AppEnv. See API Date Filter 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 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"
]