Skip to main content

Welcome to our updated site!

Skyhigh Security

Create a Report with the REST API

You can use the REST API that is provided to create a report that includes data on processing web requests.

  1. Log on to the REST API.

    To log on, you must provide a URL with a country or region prefix to indicate where you log on. It also includes as the domain name and your customer ID.

    Example:<customer ID>

    Use the customer ID here that you received when you purchased the product, but leave out the initial c before the string of numbers, for example, 1234567.

    Prefixes can be used here as follows:

    ae — United Arab Emirates
    au — Australia
    ca — Canada   
    de — Germany
    gb — United Kingdom
    in  — India
    sg — Singapore
    us — United States

  2. Enter a command to download data for your report.

    Use an HTTP client tool for this, such as curl or wget. Include the required parameters and optional parameters as needed. Important required parameters are:

  • Version header — Depending on his header, different combination of data fields, for example, user_id, source_ip, and http_action, can be downloaded for reporting.

    For a list of all available version headers with their data fields, see Reporting Fields.

  • Timestamp filters — Specify the time range during which data is downloaded

    For more information about these filters, see Reporting Filters and Reporting Timestamp.

A complete download command looks like this:

curl --insecure --verbose --header 'Accept: text/csv' --header 'x-mwg-api-version: 3' --compressed
--user <user name>:<password>

NOTE: Depending on the HTTP client tool that you are using, you may have to escape the & (ampersand) character by a preceding \ (backslash), \& for &, to run the command properly. 

For more information about this command and the output it returns, see Reporting Examples

When the report has been run, you can review the downloaded data and analyze them.

  • Was this article helpful?