Link11 WAAP
v5
v5
  • Link11 WAAP Documentation
  • Release Notes
  • Known Issues
  • User Guide
    • Introduction to Link11 WAAP
  • How Link11 WAAP Works
    • Traffic Filtering Process
    • Traffic Reporting and Analytics
    • Policy Mapping and Traffic Routing
    • Tagging
    • UI Overview and Common Elements
  • Console UI Walkthrough
    • Analytics
      • Dashboard
      • Events Log
    • Security
      • Global Filters
      • Flow Control Policies
      • Security Policies
      • Rate Limit Rules
      • ACL Profiles
      • Actions
      • Dynamic Rules
      • Quarantined
      • Content Filter
        • Content Filter Profiles
        • Content Filter Rules
    • Sites
      • Server Groups
      • Proxy Templates
      • Mobile Application Groups
      • Backend Services
      • Edge Functions
      • DNS Records
      • SSL
        • Load Balancers
        • Certificates
    • System
      • Interactive Challenge
      • SSO Configuration
      • Purge CDN Cache
      • Users Management
      • Security Alerts
      • Log Exporters
      • Version Control
      • System DB
      • Publish Changes
    • Account
  • Using the product
    • Best Practices
      • Saving and Publishing Your Changes
      • Enabling Passive Challenges
      • Understanding and Diagnosing Traffic Issues
    • How Do I...
      • Authenticate mobile app users
      • Ban, unban, and allowlist traffic sources
      • Bypass Link11 WAAP for loadtesting or other purposes
      • Configure a new path/section of a site
      • Control caching behavior
      • Enable GraphQL traffic
      • Enable mTLS (mutual TLS)
      • Protect sensitive information in logs and analytics
      • Quickly block an attacker
      • Redirect or block HTTP traffic
      • Run custom code
      • Set rate limits and exemptions
      • Stream event data to a SIEM solution or other destination
    • The Link11 WAAP API
      • Overview
      • Internal data structures
      • Using Swagger UI
      • Using curl
  • Reference Information
    • Acronyms
    • API
      • API access to traffic data
      • Types of namespaces
      • Namespace reference
        • ACL Profiles
        • Actions
        • Backend Services
        • Certificates
        • Configs
        • Content Filter Profiles
        • Content Filter Rules
        • Data queries
        • Dynamic Rules
        • Edge Functions
        • Flow Control Policies
        • Global Filters
        • Load Balancers
        • Log Exporters
        • Mobile Application Groups
        • Planets
        • Proxy Templates
        • Rate Limit Rules
        • Security Alerts
        • Security Policies
        • Server Groups
        • Tags
        • Tools
        • Users
    • Hostile Bot Detection / LWCSI
      • Environmental detection and browser verification
      • Client authentication
      • Biometric behavioral verification
    • HTTP Response Codes
    • Log Exporter Output
    • Pattern Matching Syntax
    • Query Filter Syntax and Best Practices
  • Support
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Reference Information
  2. API
  3. Namespace reference

Data queries

PreviousContent Filter RulesNextDynamic Rules

Last updated 2 months ago

Was this helpful?

Two of the Data queries routes below manage . The rest are for retrieving traffic data; for instructions on using them, see .

quarantined traffic sources
API access to traffic data

Get traffic data from logs

get

Retrieve traffic data using 'filters' parameter, explained at https://gb.docs.reblaze.com/reference-information/api/api-access-to-traffic-data

Query parameters
limitinteger · min: 1 · max: 2500OptionalDefault: 100
offsetintegerOptionalDefault: 0
filtersstringOptional

Filters for request in format selected below (JSON or query string)

Example: {"AND":[{"field":"timestamp","op":"between","value":["2024-06-06 09:31:00","2024-06-06 09:36:00"]},{"field":"status","op":"eq","value":301}]}
debugbooleanOptional

if set to true the request will return rendered SQL without running it, for debug purposes

Example: true | false
save_historybooleanOptional

if set to true the query will be saved in the query history

Example: true | false
Header parameters
providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:
syntaxstringOptional

syntax of query

Example: json
syntaxstring · enumOptional

syntax of query

Example: jsonPossible values:
Responses
200
Logs has been received successfully
application/json
4XX
Misconfigured request
application/json
get
GET /api/v4.0/data/logs HTTP/1.1
Host: 
Accept: */*

{
  "data": {
    "results": [],
    "statistics": {}
  },
  "status": 1
}
  • GETGet traffic data from logs
  • GETGet traffic data from logs
  • PARAMETERS/api/v4.0/data/logs
  • GETGet quarantined list
  • DELETEDelete record(s) from quarantined list
  • GETGet traffic stats
  • PARAMETERS/api/v4.0/data/stats
  • GETGet traffic timeline
  • PARAMETERS/api/v4.0/data/timeline
  • POSTConvert 'filters' query string to JSON
  • GETGet "top" traffic data
  • PARAMETERS/api/v4.0/data/topx

Get traffic data from logs

get

Retrieve traffic data using 'filters' parameter, explained at https://gb.docs.reblaze.com/reference-information/api/api-access-to-traffic-data

Query parameters
limitinteger · min: 1 · max: 2500OptionalDefault: 100
offsetintegerOptionalDefault: 0
filtersstringOptional

Filters for request in format selected below (JSON or query string)

Example: {"AND":[{"field":"timestamp","op":"between","value":["2024-06-06 09:31:00","2024-06-06 09:36:00"]},{"field":"status","op":"eq","value":301}]}
debugbooleanOptional

if set to true the request will return rendered SQL without running it, for debug purposes

Example: true | false
Header parameters
providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:
syntaxstringOptional

syntax of query

Example: json
syntaxstring · enumOptional

syntax of query

Example: jsonPossible values:
Responses
200
Logs has been received successfully
application/json
4XX
Misconfigured request
application/json
get
parameters
Header parameters
providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:
syntaxstringOptional

syntax of query

Example: json
parameters

Get quarantined list

get

Get quarantined list

Query parameters
configstringOptional
idsstring[]Optional
rule_idsstring[]Optional
Header parameters
providerstring · enumRequired

Database to get data from

Example: mongodbPossible values:
syntaxstring · enumRequired

Syntax of query

Example: string_queryPossible values:
Responses
200
Query for quarantined has been run successfully
application/json
4XX
Misconfigured request
application/json
get

Get traffic stats

get

Get stats (time_period, counter, hostname, bandwidth, latency) using 'filters' parameter, explained at https://gb.docs.reblaze.com/reference-information/api/api-access-to-traffic-data

Query parameters
filtersstringOptional

Filters for request in format selected below (JSON or query string)

Example: {"AND":[{"field":"timestamp","op":"between","value":["2024-06-06 09:31:00","2024-06-06 09:36:00"]},{"field":"status","op":"eq","value":301}]}
debugbooleanOptional

if set to true the request will return rendered SQL without running it, for debug purposes

Example: true | false
Header parameters
providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:
syntaxstring · enumOptional

syntax of query

Example: jsonPossible values:
Responses
200
Stats has been received successfully
application/json
4XX
Misconfigured request
application/json
get
parameters
Header parameters
providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:
parameters

Get traffic timeline

get

Get timeline (time_period, sessions, remote_addr, all_hits, blocked, origin_blocked, challenge, is_human, statuses stats, origin statuses stats, bytes_sent) using 'filters' parameter, explained at https://gb.docs.reblaze.com/reference-information/api/api-access-to-traffic-data

Query parameters
filtersstringOptional

Filters for request in format selected below (JSON or query string)

Example: {"AND":[{"field":"timestamp","op":"between","value":["2024-06-06 09:31:00","2024-06-06 09:36:00"]},{"field":"status","op":"eq","value":301}]}
debugbooleanOptional

if set to true the request will return rendered SQL without running it, for debug purposes

Example: true | false
Header parameters
providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:
syntaxstringOptional

syntax of query

Example: json
syntaxstring · enumOptional

syntax of query

Example: jsonPossible values:
Responses
200
Timeline has been received successfully
application/json
4XX
Misconfigured request
application/json
get
parameters
Header parameters
providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:
syntaxstringOptional

syntax of query

Example: json
parameters

Get "top" traffic data

get

Get topx stats using 'filters' parameter, explained at https://gb.docs.reblaze.com/reference-information/api/api-access-to-traffic-data

Query parameters
filtersstringOptional

Filters for request in format selected below (JSON or query string)

Example: {"AND":[{"field":"timestamp","op":"between","value":["2024-06-06 09:31:00","2024-06-06 09:36:00"]},{"field":"status","op":"eq","value":301}]}
debugbooleanOptional

if set to true the request will return rendered SQL without running it, for debug purposes

Example: true | false
Header parameters
providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:
syntaxstring · enumOptional

syntax of query

Example: jsonPossible values:
Responses
200
Topx has been received successfully
application/json
4XX
Misconfigured request
application/json
get
parameters
Header parameters
providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:
parameters
GET /api/v4.0/data/logs HTTP/1.1
Host: 
Accept: */*

{
  "data": {
    "results": [],
    "statistics": {}
  },
  "status": 1
}
PARAMETERS /api/v4.0/data/logs HTTP/1.1
Host: 
Accept: */*

GET /api/v4.0/data/quarantined HTTP/1.1
Host: 
provider: mongodb
syntax: string_query
Accept: */*

{
  "data": {
    "results": [],
    "statistics": {}
  },
  "status": 1
}

Delete record(s) from quarantined list

delete

Delete record(s) from quarantined list

Header parameters
providerstring · enumRequired

Database to get data from

Example: mongodbPossible values:
syntaxstring · enumRequired

Syntax of query

Example: jsonPossible values:
Body
configstringOptional
idsstring[]Optional
rule_idsstring[]Optional
Responses
200
Record(s) was/were successfully deleted
application/json
4XX
Misconfigured request
application/json
delete
DELETE /api/v4.0/data/quarantined HTTP/1.1
Host: 
provider: mongodb
syntax: json
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "config": "text",
  "ids": [
    "text"
  ],
  "rule_ids": [
    "text"
  ]
}
{
  "data": {
    "results": [],
    "statistics": {}
  },
  "status": 1
}
GET /api/v4.0/data/stats HTTP/1.1
Host: 
Accept: */*

{
  "data": {
    "results": [],
    "statistics": {}
  },
  "status": 1
}
PARAMETERS /api/v4.0/data/stats HTTP/1.1
Host: 
Accept: */*

GET /api/v4.0/data/timeline HTTP/1.1
Host: 
Accept: */*

{
  "data": {
    "results": [],
    "statistics": {}
  },
  "status": 1
}
PARAMETERS /api/v4.0/data/timeline HTTP/1.1
Host: 
Accept: */*

Convert 'filters' query string to JSON

post

Convert a query string (as used in the UI Dashboard and Events Log) into JSON format.

Body
queryone ofRequired
stringOptional
or
objectOptional
Responses
200
Filter string has been converted successfully
application/json
Responseobject
4XX
Misconfigured request
application/json
post
POST /api/v4.0/data/timeline/parse HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "query": "text"
}
{}
GET /api/v4.0/data/topx HTTP/1.1
Host: 
Accept: */*

{
  "data": {
    "results": [],
    "statistics": {}
  },
  "status": 1
}
PARAMETERS /api/v4.0/data/topx HTTP/1.1
Host: 
Accept: */*