Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The {config} API parameter is discussed here.
Load balancer administration is discussed here. The discussion below assumes familiarity with it.
As explained , when a Link11 load balancer supports a multi-regional planet, admins can (if desired) configure traffic routing.
The API provides additional granularity beyond the configuration available in the web console:
In the UI, the load balancer is treated as a single instance. However, this "one" load balancer is conceptual: it represents multiple physical instances, running simultaneously in different cities. The API provides the ability to configure each city separately, if desired.
In the UI, the Preferred datacenter control displays a list of datacenters where Link11 WAAP has been deployed. In the API, this list is provided in the upstream_regions parameter, which is returned when calling GET /api/v4.3/conf/{config}/load-balancers/regions.
In the UI, one Preferred datacenter can be selected, which will be applied to all cities. In the API, different datacenters can be specified for different cities, by calling POST /api/v4.3/conf/{config}/load-balancers/regions.
To retrieve information about all load balancers:
GET /api/v4.3/conf/{config}/load-balancers
To add a certificate:
PUT /api/v4.3/conf/{config}/load-balancers/{entry_name}/certificates/{certificate_id}
To remove a certificate:
DELETE /api/v4.3/conf/{config}/load-balancers/{entry_name}/certificates
To get the list of Link11 WAAP datacenters, and each city's current preference:
GET /api/v4.3/conf/{config}/load-balancers/regions
To set preferred datacenters for each city:
POST /api/v4.3/conf/{config}/load-balancers/regions
Updates an existing set of ACL Profiles for a configuration
ACL Profiles updated successfully
Validation Error
Create a complete set of ACL Profiles for a configuration
ACL Profiles created successfully
Validation Error
Get an individual ACL Profile (not the entire set) from the specified configuration
ACL Profile retrieved successfully
Validation Error
Update an individual ACL Profile within a configuration
ACL Profile updated successfully
Validation Error
Create an individual ACL Profile within a configuration
ACL Profile created successfully
Validation Error
Delete an individual ACL Profile (not the entire set) from the specified configuration
ACL Profile deleted successfully
Validation Error
Set a previous ACL Profile version to be the current one
ACL Profile reversion was successful
Validation Error
Update an existing set of Actions for a configuration
{}List of tags to apply
[]Need to be one of predefined strings
Actions updated successfully
Validation Error
Create complete set of Actions for a configuration
{}List of tags to apply
[]Need to be one of predefined strings
Actions created successfully
Validation Error
Update an individual Action within a configuration
{}List of tags to apply
[]Need to be one of predefined strings
Action updated successfully
Validation Error
Create an individual Action within a configuration
{}List of tags to apply
[]Need to be one of predefined strings
Action created successfully
Validation Error
Set a previous Actions version to be the current one
Actions reversion was successful
Validation Error
Modify settings of a planet
Planet ID
Planet updated successfully
Input Error
Validation Error
Internal Server Error
Retrieve traffic data using 'filters' parameter, explained at https://gb.docs.reblaze.com/reference-information/api/api-access-to-traffic-data
1000Filters for request in format selected below (JSON or query string)
{"AND":[{"field":"timestamp","op":"between","value":["2024-06-06 09:31:00","2024-06-06 09:36:00"]},{"field":"status","op":"eq","value":301}]}if set to true the request will return rendered SQL without running it, for debug purposes
true | falseDatabase to get data from
bigqueryPossible values: syntax of query
jsonLogs has been received successfully
Misconfigured request
Database to get data from
bigqueryPossible values: syntax of query
jsonGet quarantined list
Database to get data from
mongodbPossible values: Syntax of query
string_queryPossible values: Query for quarantined has been run successfully
Misconfigured request
Delete record(s) from quarantined list
Database to get data from
mongodbPossible values: Syntax of query
jsonPossible values: Record(s) was/were successfully deleted
Misconfigured request
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
Filters for request in format selected below (JSON or query string)
{"AND":[{"field":"timestamp","op":"between","value":["2024-06-06 09:31:00","2024-06-06 09:36:00"]},{"field":"status","op":"eq","value":301}]}if set to true the request will return rendered SQL without running it, for debug purposes
true | falseDatabase to get data from
bigqueryPossible values: syntax of query
jsonPossible values: Stats has been received successfully
Misconfigured request
Database to get data from
bigqueryPossible values: 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
Filters for request in format selected below (JSON or query string)
{"AND":[{"field":"timestamp","op":"between","value":["2024-06-06 09:31:00","2024-06-06 09:36:00"]},{"field":"status","op":"eq","value":301}]}if set to true the request will return rendered SQL without running it, for debug purposes
true | falseDatabase to get data from
bigqueryPossible values: syntax of query
jsonTimeline has been received successfully
Misconfigured request
Database to get data from
bigqueryPossible values: syntax of query
jsonConvert a query string (as used in the UI Dashboard and Events Log) into JSON format.
Filter string has been converted successfully
Misconfigured request
Get topx stats using 'filters' parameter, explained at https://gb.docs.reblaze.com/reference-information/api/api-access-to-traffic-data
Filters for request in format selected below (JSON or query string)
{"AND":[{"field":"timestamp","op":"between","value":["2024-06-06 09:31:00","2024-06-06 09:36:00"]},{"field":"status","op":"eq","value":301}]}if set to true the request will return rendered SQL without running it, for debug purposes
true | falseDatabase to get data from
bigqueryPossible values: syntax of query
jsonPossible values: Topx has been received successfully
Misconfigured request
Database to get data from
bigqueryPossible values: Update an existing set of Global Filters for a configuration
{}Global Filters updated successfully
Validation Error
Create a complete set of Global Filters for a configuration
{}Global Filters created successfully
Validation Error
Update an individual Global Filter within a configuration
{}Global Filter updated successfully
Validation Error
Create an individual Global Filter within a configuration
{}Global Filter created successfully
Validation Error
Delete an individual Global Filter from the specified configuration
Global Filter deleted successfully
Validation Error
Set a previous Global Filter version to be the current one
Global Filter reversion was successful
Validation Error
Update an existing set of Content Filter Rules for a configuration
Category of the rule
""Log message for this rule
Matching domain(s) regex
Risk level of this rule, between 1 (lowest risk) and 5 (highest risk)
Subcategory of the rule
List of tags to apply
[]Content Filter Rules updated successfully
Validation Error
Create a complete set of Content Filter Rules for a configuration
Category of the rule
""Log message for this rule
Matching domain(s) regex
Risk level of this rule, between 1 (lowest risk) and 5 (highest risk)
Subcategory of the rule
List of tags to apply
[]Content Filter Rules created successfully
Validation Error
Get a Content Filter Rule from the specified configuration
Content Filter Rule retrieved successfully
Validation Error
Update an individual Content Filter Rule within a configuration
Category of the rule
""Log message for this rule
Matching domain(s) regex
Risk level of this rule, between 1 (lowest risk) and 5 (highest risk)
Subcategory of the rule
List of tags to apply
[]Content Filter Rule updated successfully
Validation Error
Create an individual Content Filter Rule within a configuration
Category of the rule
""Log message for this rule
Matching domain(s) regex
Risk level of this rule, between 1 (lowest risk) and 5 (highest risk)
Subcategory of the rule
List of tags to apply
[]Content Filter Rule created successfully
Validation Error
Delete an individual Content Filter Rule from the specified configuration
Content Filter Rule deleted successfully
Validation Error
Get list of versions of Content Filter Rules in a configuration
Content Filter Rules version list retrieved successfully
Validation Error
Get a specific version of a Content Filter Rule set
Content Filter Rule set retrieved successfully
Validation Error
Set a previous Content Filter Rule version to be the current one
Content Filter Rule reversion was successful
Validation Error
Create new user
New user was created successfully
Input Error
Validation Error
Internal Server Error
Update details of a user
Account ID
User updated successfully
Input Error
Validation Error
Internal Server Error
No content
Delete user by user id
Account ID
User was deleted successfully
Input Error
Validation Error
Internal Server Error
No content
Revokes API key and makes it unavailable for use
API key ID
API key was revoked successfully
Input Error
Validation Error
Internal Server Error
No content
Account ID
API keys for specified user were retrieved successfully
Input Error
Validation Error
Internal Server Error
Account ID
API key for specified user was generated successfully
Input Error
Validation Error
Internal Server Error
No content
Is that profile enabled or not.
falseSSO provider OAuth2 protocol parameters
SSO protocol
An enumeration.
SSO provider
An enumeration.
Title of the SSO profile that will be displayed on the login page.
SSO config was updated successfully
Bad Request
Validation Error
Internal Server Error
Is that profile enabled or not.
falseSSO provider SAML2 protocol parameters
SSO protocol
An enumeration.
SSO provider
An enumeration.
Title of the SSO profile that will be displayed on the login page.
SSO config was updated successfully
Bad Request
Validation Error
Internal Server Error
Set a previous version of a configuration to be the current one
Configuration reversion was successful
Validation Error
Update an existing set of Content Filter Profiles for a configuration
""List of tags to apply
[]List of content types
[]""A field in a JSON that contains GraphQL query that need to be parsed. The value should be passed in JSONPath format. It supports regex for values as well.
""List of tags to apply
[]When true, arguments, headers or cookies, which contain only alpha numeric characters, will be ignored
falseA seed which will be used in the masking process
List of tags to apply
[]List of tags to apply
[]Content Filter Profiles updated successfully
Validation Error
Update an individual Content Filter Profile within a configuration
""List of tags to apply
[]List of content types
[]""A field in a JSON that contains GraphQL query that need to be parsed. The value should be passed in JSONPath format. It supports regex for values as well.
""List of tags to apply
[]When true, arguments, headers or cookies, which contain only alpha numeric characters, will be ignored
falseA seed which will be used in the masking process
List of tags to apply
[]List of tags to apply
[]Content Filter Profile updated successfully
Validation Error
Create an individual Content Filter Profile within a configuration
""List of tags to apply
[]List of content types
[]""A field in a JSON that contains GraphQL query that need to be parsed. The value should be passed in JSONPath format. It supports regex for values as well.
""List of tags to apply
[]When true, arguments, headers or cookies, which contain only alpha numeric characters, will be ignored
falseA seed which will be used in the masking process
List of tags to apply
[]List of tags to apply
[]Content Filter Profile created successfully
Validation Error
Delete an individual Content Filter Profile from the specified configuration
Content Filter Profile deleted successfully
Validation Error
Get a specific version of a Content Filter Profile
Content Filter Profile retrieved successfully
Validation Error
Update an existing set of Edge Functions for a configuration
Edge Function Code
""Unique id
^[A-Za-z0-9_]*$Edge Functions updated successfully
Validation Error
Create a complete set of Edge Functions for a configuration
Edge Function Code
""Unique id
^[A-Za-z0-9_]*$Edge Functions created successfully
Validation Error
Update an individual Edge Function within a configuration
Edge Function Code
""Unique id
^[A-Za-z0-9_]*$Edge Function updated successfully
Validation Error
Create an individual Edge Function within a configuration
Edge Function Code
""Unique id
^[A-Za-z0-9_]*$Edge Function created successfully
Validation Error
Delete an individual Edge Function from the specified configuration
Edge Function deleted successfully
Validation Error
Set a previous Edge Function version to be the current one
Edge Function reversion was successful
Validation Error
PARAMETERS /api/v4.0/data/logs HTTP/1.1
Host:
Accept: */*
PARAMETERS /api/v4.0/data/stats HTTP/1.1
Host:
Accept: */*
PARAMETERS /api/v4.0/data/timeline HTTP/1.1
Host:
Accept: */*
PARAMETERS /api/v4.0/data/topx HTTP/1.1
Host:
Accept: */*
GET /api/v4.0/conf/{config}/acl-profiles HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"action": "text",
"allow": [
"text"
],
"allow_bot": [
"text"
],
"deny": [
"text"
],
"deny_bot": [
"text"
],
"description": "text",
"force_deny": [
"text"
],
"id": "text",
"name": "text",
"passthrough": [
"text"
],
"tags": [
"text"
]
}
]
}PUT /api/v4.0/conf/{config}/acl-profiles HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 201
[
{
"action": "text",
"allow": [
"text"
],
"allow_bot": [
"text"
],
"deny": [
"text"
],
"deny_bot": [
"text"
],
"description": "text",
"force_deny": [
"text"
],
"id": "text",
"name": "text",
"passthrough": [
"text"
],
"tags": [
"text"
]
}
]{
"message": "Successfully updated entry"
}POST /api/v4.0/conf/{config}/acl-profiles HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 201
[
{
"action": "text",
"allow": [
"text"
],
"allow_bot": [
"text"
],
"deny": [
"text"
],
"deny_bot": [
"text"
],
"description": "text",
"force_deny": [
"text"
],
"id": "text",
"name": "text",
"passthrough": [
"text"
],
"tags": [
"text"
]
}
]{
"message": "Successfully created entry"
}DELETE /api/v4.0/conf/{config}/acl-profiles HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/acl-profiles/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"action": "text",
"allow": [
"text"
],
"allow_bot": [
"text"
],
"deny": [
"text"
],
"deny_bot": [
"text"
],
"description": "text",
"force_deny": [
"text"
],
"id": "text",
"name": "text",
"passthrough": [
"text"
],
"tags": [
"text"
]
}PUT /api/v4.0/conf/{config}/acl-profiles/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 199
{
"action": "text",
"allow": [
"text"
],
"allow_bot": [
"text"
],
"deny": [
"text"
],
"deny_bot": [
"text"
],
"description": "text",
"force_deny": [
"text"
],
"id": "text",
"name": "text",
"passthrough": [
"text"
],
"tags": [
"text"
]
}{
"message": "Successfully updated entry"
}POST /api/v4.0/conf/{config}/acl-profiles/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 199
{
"action": "text",
"allow": [
"text"
],
"allow_bot": [
"text"
],
"deny": [
"text"
],
"deny_bot": [
"text"
],
"description": "text",
"force_deny": [
"text"
],
"id": "text",
"name": "text",
"passthrough": [
"text"
],
"tags": [
"text"
]
}{
"message": "Successfully created entry"
}DELETE /api/v4.0/conf/{config}/acl-profiles/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/acl-profiles/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-12-13T06:24:20.464Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}GET /api/v4.0/conf/{config}/acl-profiles/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"action": "text",
"allow": [
"text"
],
"allow_bot": [
"text"
],
"deny": [
"text"
],
"deny_bot": [
"text"
],
"description": "text",
"force_deny": [
"text"
],
"id": "text",
"name": "text",
"passthrough": [
"text"
],
"tags": [
"text"
]
}
]
}PUT /api/v4.0/conf/{config}/acl-profiles/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}GET /api/v4.0/conf/{config}/actions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"description": "text",
"id": "text",
"name": "text",
"params": {
"content": "",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": 1
},
"tags": [
"text"
],
"type": "skip"
}
]
}PUT /api/v4.0/conf/{config}/actions HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 160
[
{
"description": "text",
"id": "text",
"name": "text",
"params": {
"content": "",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": 1
},
"tags": [
"text"
],
"type": "skip"
}
]{
"message": "Successfully updated entry"
}POST /api/v4.0/conf/{config}/actions HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 160
[
{
"description": "text",
"id": "text",
"name": "text",
"params": {
"content": "",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": 1
},
"tags": [
"text"
],
"type": "skip"
}
]{
"message": "Successfully created entry"
}DELETE /api/v4.0/conf/{config}/actions HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/actions/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"description": "text",
"id": "text",
"name": "text",
"params": {
"content": "",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": 1
},
"tags": [
"text"
],
"type": "skip"
}PUT /api/v4.0/conf/{config}/actions/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 158
{
"description": "text",
"id": "text",
"name": "text",
"params": {
"content": "",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": 1
},
"tags": [
"text"
],
"type": "skip"
}{
"message": "Successfully updated entry"
}POST /api/v4.0/conf/{config}/actions/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 158
{
"description": "text",
"id": "text",
"name": "text",
"params": {
"content": "",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": 1
},
"tags": [
"text"
],
"type": "skip"
}{
"message": "Successfully created entry"
}DELETE /api/v4.0/conf/{config}/actions/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/actions/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-12-13T06:24:20.464Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}GET /api/v4.0/conf/{config}/actions/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"description": "text",
"id": "text",
"name": "text",
"params": {
"content": "",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": 1
},
"tags": [
"text"
],
"type": "skip"
}
]
}PUT /api/v4.0/conf/{config}/actions/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}GET /api/v4.0/conf/{config}/planets HTTP/1.1
Host:
Accept: */*
{
"ichallenge": {
"attrs": {},
"lang": {},
"palette": [
"text"
],
"position": {}
},
"name": "text",
"trusted_nets": [
{
"address": "text",
"comment": "text"
}
]
}PUT /api/v4.0/conf/{config}/planets/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 137
{
"ichallenge": {
"attrs": {},
"lang": {},
"palette": [
"text"
],
"position": {}
},
"name": "text",
"trusted_nets": [
{
"address": "text",
"comment": "text"
}
]
}{
"message": "Successfully updated entry"
}GET /api/v4.0/conf/{config}/global-filters HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"action": null,
"active": true,
"description": "text",
"id": "text",
"mdate": "text",
"name": "text",
"rule": null,
"source": "text",
"tags": [
"text"
]
}
]
}PUT /api/v4.0/conf/{config}/global-filters HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 137
[
{
"action": null,
"active": true,
"description": "text",
"id": "text",
"mdate": "text",
"name": "text",
"rule": null,
"source": "text",
"tags": [
"text"
]
}
]{
"message": "Successfully updated entry"
}POST /api/v4.0/conf/{config}/global-filters HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 137
[
{
"action": null,
"active": true,
"description": "text",
"id": "text",
"mdate": "text",
"name": "text",
"rule": null,
"source": "text",
"tags": [
"text"
]
}
]{
"message": "Successfully created entry"
}DELETE /api/v4.0/conf/{config}/global-filters HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/global-filters/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"action": null,
"active": true,
"description": "text",
"id": "text",
"mdate": "text",
"name": "text",
"rule": null,
"source": "text",
"tags": [
"text"
]
}PUT /api/v4.0/conf/{config}/global-filters/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 135
{
"action": null,
"active": true,
"description": "text",
"id": "text",
"mdate": "text",
"name": "text",
"rule": null,
"source": "text",
"tags": [
"text"
]
}{
"message": "Successfully updated entry"
}POST /api/v4.0/conf/{config}/global-filters/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 135
{
"action": null,
"active": true,
"description": "text",
"id": "text",
"mdate": "text",
"name": "text",
"rule": null,
"source": "text",
"tags": [
"text"
]
}{
"message": "Successfully created entry"
}DELETE /api/v4.0/conf/{config}/global-filters/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/global-filters/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-12-13T06:24:20.464Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}GET /api/v4.0/conf/{config}/global-filters/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"action": null,
"active": true,
"description": "text",
"id": "text",
"mdate": "text",
"name": "text",
"rule": null,
"source": "text",
"tags": [
"text"
]
}
]
}PUT /api/v4.0/conf/{config}/global-filters/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}GET /api/v4.0/conf/{config}/content-filter-rules HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"category": "text",
"description": "",
"id": "text",
"msg": "text",
"name": "text",
"operand": "text",
"risk": 1,
"subcategory": "text",
"tags": [
"text"
]
}
]
}PUT /api/v4.0/conf/{config}/content-filter-rules HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 140
[
{
"category": "text",
"description": "",
"id": "text",
"msg": "text",
"name": "text",
"operand": "text",
"risk": 1,
"subcategory": "text",
"tags": [
"text"
]
}
]{
"message": "Successfully updated entry"
}POST /api/v4.0/conf/{config}/content-filter-rules HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 140
[
{
"category": "text",
"description": "",
"id": "text",
"msg": "text",
"name": "text",
"operand": "text",
"risk": 1,
"subcategory": "text",
"tags": [
"text"
]
}
]{
"message": "Successfully created entry"
}DELETE /api/v4.0/conf/{config}/content-filter-rules HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/content-filter-rules/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"category": "text",
"description": "",
"id": "text",
"msg": "text",
"name": "text",
"operand": "text",
"risk": 1,
"subcategory": "text",
"tags": [
"text"
]
}PUT /api/v4.0/conf/{config}/content-filter-rules/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 138
{
"category": "text",
"description": "",
"id": "text",
"msg": "text",
"name": "text",
"operand": "text",
"risk": 1,
"subcategory": "text",
"tags": [
"text"
]
}{
"message": "Successfully updated entry"
}POST /api/v4.0/conf/{config}/content-filter-rules/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 138
{
"category": "text",
"description": "",
"id": "text",
"msg": "text",
"name": "text",
"operand": "text",
"risk": 1,
"subcategory": "text",
"tags": [
"text"
]
}{
"message": "Successfully created entry"
}DELETE /api/v4.0/conf/{config}/content-filter-rules/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/content-filter-rules/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-12-13T06:24:20.464Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}GET /api/v4.0/conf/{config}/content-filter-rules/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"category": "text",
"description": "",
"id": "text",
"msg": "text",
"name": "text",
"operand": "text",
"risk": 1,
"subcategory": "text",
"tags": [
"text"
]
}
]
}PUT /api/v4.0/conf/{config}/content-filter-rules/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}GET /api/v4.0/accounts/users HTTP/1.1
Host:
Accept: */*
[
{
"id": "text",
"name": "text",
"users": [
{
"acl": 1,
"contact_name": "text",
"email": "[email protected]",
"id": "text",
"mobile": "text",
"org_id": "text",
"org_name": "text"
}
]
}
]POST /api/v4.0/accounts/users HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 88
{
"acl": 1,
"contact_name": "text",
"email": "[email protected]",
"mobile": "text",
"org_id": "text"
}{
"id": "text"
}GET /api/v4.0/accounts/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"acl": 1,
"contact_name": "text",
"email": "[email protected]",
"id": "text",
"mobile": "text",
"org_id": "text",
"org_name": "text",
"otpseed": "text"
}PUT /api/v4.0/accounts/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"acl": 1,
"contact_name": "text",
"mobile": "text"
}DELETE /api/v4.0/accounts/{entry_id} HTTP/1.1
Host:
Accept: */*
GET /api/v4.0/accounts/api-keys HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"account_id": "text",
"created_by": "text",
"created_time": 1,
"email": "text",
"id": "text",
"key": "text",
"title": "text"
}
]
}PUT /api/v4.0/accounts/api-keys/{entry_id} HTTP/1.1
Host:
Accept: */*
GET /api/v4.0/accounts/{entry_id}/api-keys HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"account_id": "text",
"created_by": "text",
"created_time": 1,
"email": "text",
"id": "text",
"key": "text",
"title": "text"
}
]
}POST /api/v4.0/accounts/{entry_id}/api-keys HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"title": "text"
}GET /api/v4.0/accounts/sso HTTP/1.1
Host:
Accept: */*
{
"enabled": false,
"params": {
"client_id": "text",
"client_secret": "text",
"issuer": "text",
"roles": [
{
"idp_group": "text",
"reblaze_groups": [
"reblaze-events-viewer"
]
}
],
"roles_claim_key": "text",
"token_expiration_threshold": 1
},
"protocol": "oauth2",
"provider": "okta",
"title": "text"
}POST /api/v4.0/accounts/sso/oauth2 HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 269
{
"enabled": false,
"params": {
"client_id": "text",
"client_secret": "text",
"issuer": "text",
"roles": [
{
"idp_group": "text",
"reblaze_groups": [
"reblaze-events-viewer"
]
}
],
"roles_claim_key": "text",
"token_expiration_threshold": 1
},
"protocol": "oauth2",
"provider": "okta",
"title": "text"
}{
"cert_thumbprint": "text",
"code": 1,
"message": "text"
}POST /api/v4.0/accounts/sso/saml2 HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 299
{
"enabled": false,
"params": {
"entityId": "text",
"login_url": "https://example.com",
"roles": [
{
"idp_group": "text",
"reblaze_groups": [
"reblaze-events-viewer"
]
}
],
"roles_claim_key": "text",
"tenantId": "text",
"token_expiration_threshold": 1,
"x509cert": "text"
},
"protocol": "oauth2",
"provider": "okta",
"title": "text"
}{
"cert_thumbprint": "text",
"code": 1,
"message": "text"
}GET /api/v4.0/conf/configs HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"date": "2025-12-13T06:24:20.464Z",
"description": "text",
"id": "text",
"logs": [
{
"date": "2025-12-13T06:24:20.464Z",
"version": "text"
}
],
"version": "text"
}
]
}GET /api/v4.0/conf/configs/{config} HTTP/1.1
Host:
Accept: */*
GET /api/v4.0/conf/configs/{config}/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-12-13T06:24:20.464Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}PUT /api/v4.0/conf/configs/{config}/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}GET /api/v4.0/conf/{config}/edge-functions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"code": "text",
"description": "",
"id": "text",
"name": "text",
"phase": "request"
}
]
}PUT /api/v4.0/conf/{config}/edge-functions HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 78
[
{
"code": "text",
"description": "",
"id": "text",
"name": "text",
"phase": "request"
}
]{
"message": "Successfully updated entry"
}POST /api/v4.0/conf/{config}/edge-functions HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 78
[
{
"code": "text",
"description": "",
"id": "text",
"name": "text",
"phase": "request"
}
]{
"message": "Successfully created entry"
}DELETE /api/v4.0/conf/{config}/edge-functions HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/edge-functions/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"code": "text",
"description": "",
"id": "text",
"name": "text",
"phase": "request"
}PUT /api/v4.0/conf/{config}/edge-functions/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 76
{
"code": "text",
"description": "",
"id": "text",
"name": "text",
"phase": "request"
}{
"message": "Successfully updated entry"
}POST /api/v4.0/conf/{config}/edge-functions/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 76
{
"code": "text",
"description": "",
"id": "text",
"name": "text",
"phase": "request"
}{
"message": "Successfully created entry"
}DELETE /api/v4.0/conf/{config}/edge-functions/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/edge-functions/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-12-13T06:24:20.464Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}GET /api/v4.0/conf/{config}/edge-functions/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"code": "text",
"description": "",
"id": "text",
"name": "text",
"phase": "request"
}
]
}PUT /api/v4.0/conf/{config}/edge-functions/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}{
"message": "Successfully updated entry"
}{
"message": "Successfully updated entry"
}{
"message": "Successfully created entry"
}PUT /api/v4.0/conf/{config}/content-filter-profiles HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1562
[
{
"action": "",
"active": [
"text"
],
"allsections": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"args": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"content_type": [
"text"
],
"cookies": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"decoding": {
"base64": true,
"dual": false,
"html": false,
"unicode": false
},
"description": "",
"graphql_path": "",
"headers": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"id": "text",
"ignore": [
"text"
],
"ignore_alphanum": true,
"ignore_body": false,
"masking_seed": "text",
"name": "text",
"path": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"report": [
"text"
],
"tags": [
"text"
]
}
]PUT /api/v4.0/conf/{config}/content-filter-profiles/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1560
{
"action": "",
"active": [
"text"
],
"allsections": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"args": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"content_type": [
"text"
],
"cookies": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"decoding": {
"base64": true,
"dual": false,
"html": false,
"unicode": false
},
"description": "",
"graphql_path": "",
"headers": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"id": "text",
"ignore": [
"text"
],
"ignore_alphanum": true,
"ignore_body": false,
"masking_seed": "text",
"name": "text",
"path": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"report": [
"text"
],
"tags": [
"text"
]
}POST /api/v4.0/conf/{config}/content-filter-profiles/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1560
{
"action": "",
"active": [
"text"
],
"allsections": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"args": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"content_type": [
"text"
],
"cookies": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"decoding": {
"base64": true,
"dual": false,
"html": false,
"unicode": false
},
"description": "",
"graphql_path": "",
"headers": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"id": "text",
"ignore": [
"text"
],
"ignore_alphanum": true,
"ignore_body": false,
"masking_seed": "text",
"name": "text",
"path": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"report": [
"text"
],
"tags": [
"text"
]
}DELETE /api/v4.0/conf/{config}/content-filter-profiles/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/content-filter-profiles/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"action": "",
"active": [
"text"
],
"allsections": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"args": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"content_type": [
"text"
],
"cookies": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"decoding": {
"base64": true,
"dual": false,
"html": false,
"unicode": false
},
"description": "",
"graphql_path": "",
"headers": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"id": "text",
"ignore": [
"text"
],
"ignore_alphanum": true,
"ignore_body": false,
"masking_seed": "text",
"name": "text",
"path": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"report": [
"text"
],
"tags": [
"text"
]
}
]
}GET /api/v4.0/data/logs HTTP/1.1
Host:
Accept: */*
{
"data": {
"results": [],
"statistics": {}
},
"status": 1
}GET /api/v4.0/data/quarantined HTTP/1.1
Host:
provider: mongodb
syntax: string_query
Accept: */*
{
"data": {
"results": [],
"statistics": {}
},
"status": 1
}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
}GET /api/v4.0/data/timeline HTTP/1.1
Host:
Accept: */*
{
"data": {
"results": [],
"statistics": {}
},
"status": 1
}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
}Updates an existing set of Backend Services for a configuration
""Use HTTP/1.1
Load Balancing stickiness model
Custom cookie name
""Tranport protocol Service connectivity might follow incoming requests, will always be HTTP, or always HTTPS. Port-bridge mode means that Reblaze will target port numbers identical to incoming requests' port numbers.
Backend Services updated successfully
Validation Error
Create a complete set of Backend Services for a configuration
""Use HTTP/1.1
Load Balancing stickiness model
Custom cookie name
""Tranport protocol Service connectivity might follow incoming requests, will always be HTTP, or always HTTPS. Port-bridge mode means that Reblaze will target port numbers identical to incoming requests' port numbers.
Backend Services created successfully
Validation Error
Get an individual Backend Service from the specified configuration
Backend Service retrieved successfully
Validation Error
Update an individual Backend Service within a configuration
""Use HTTP/1.1
Load Balancing stickiness model
Custom cookie name
""Tranport protocol Service connectivity might follow incoming requests, will always be HTTP, or always HTTPS. Port-bridge mode means that Reblaze will target port numbers identical to incoming requests' port numbers.
Backend Service updated successfully
Validation Error
Create an individual Backend Service within a configuration
""Use HTTP/1.1
Load Balancing stickiness model
Custom cookie name
""Tranport protocol Service connectivity might follow incoming requests, will always be HTTP, or always HTTPS. Port-bridge mode means that Reblaze will target port numbers identical to incoming requests' port numbers.
Backend Service created successfully
Validation Error
Delete an individual Backend Service from the specified configuration
Backend Service deleted successfully
Validation Error
Set a previous Backend Service version to be the current one
Backend Service reversion was successful
Validation Error
Get a Dynamic Rule from the specified configuration
Dynamic Rule retrieved successfully
Input Error
Validation Error
Internal Server Error
Update an individual Dynamic Rule within a configuration
""Unique id
^[A-Za-z0-9\-\_]*$Dynamic Rule updated successfully
Input Error
Validation Error
Internal Server Error
Create an individual Dynamic Rule within a configuration
^[A-Za-z0-9\-\_]*$""Unique id
^[A-Za-z0-9\-\_]*$Dynamic Rule created successfully
Input Error
Validation Error
Internal Server Error
Delete an individual Dynamic Rule from the specified configuration
Dynamic Rule deleted successfully
Input Error
Validation Error
Internal Server Error
Update an existing set of Rate Limit Rules for a configuration
Rate Limit Rules updated successfully
Validation Error
Create a complete set of Rate Limit Rules for a configuration
Rate Limit Rules created successfully
Validation Error
Update an individual Rate Limit Rule within a configuration
Rate Limit Rule updated successfully
Validation Error
Create an individual Rate Limit Rule within a configuration
Rate Limit Rule created successfully
Validation Error
Delete an individual Rate Limit Rule from the specified configuration
Rate Limit Rule deleted successfully
Validation Error
Set a previous Rate Limit Rule version to be the current one
Rate Limit Rule reversion was successful
Validation Error
Get a Proxy Template from the specified configuration
Proxy Template retrieved successfully
Input Error
Validation Error
Internal Server Error
Update an individual Proxy Template within a configuration
""""""Proxy Template updated successfully
Input Error
Validation Error
Internal Server Error
Create an individual Proxy Template within a configuration
^[A-Za-z0-9\-\_]*$""""""Proxy Template created successfully
Input Error
Validation Error
Internal Server Error
Delete an individual Proxy Template from the specified configuration
Proxy Template deleted successfully
Bad Request
Validation Error
Internal Server Error
{
"message": "Successfully updated entry"
}{
"message": "Successfully created entry"
}GET /api/v4.0/conf/{config}/proxy-templates HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"acao_header": true,
"client_body_buffer_size": "text",
"client_body_timeout": "text",
"client_header_buffer_size": "text",
"client_header_timeout": "text",
"client_max_body_size": "text",
"conf_specific": "",
"custom_listener": true,
"description": "",
"keepalive_timeout": "text",
"large_client_header_buffers_count": "text",
"large_client_header_buffers_size": "text",
"limit_req_burst": "text",
"limit_req_rate": "text",
"mask_headers": "text",
"name": "text",
"proxy_connect_timeout": "text",
"proxy_read_timeout": "text",
"proxy_send_timeout": "text",
"send_timeout": "text",
"ssl_ciphers": "text",
"ssl_conf_specific": "",
"ssl_protocols": [
"SSLv2"
],
"upstream_host": "text",
"xff_header_name": "text",
"xrealip_header_name": "text",
"advanced_configuration": [
{
"configuration": "text",
"description": "",
"name": "text",
"protocol": [
"http"
]
}
]
}
]
}GET /api/v4.0/conf/{config}/proxy-templates/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"acao_header": true,
"client_body_buffer_size": "text",
"client_body_timeout": "text",
"client_header_buffer_size": "text",
"client_header_timeout": "text",
"client_max_body_size": "text",
"conf_specific": "",
"custom_listener": true,
"description": "",
"keepalive_timeout": "text",
"large_client_header_buffers_count": "text",
"large_client_header_buffers_size": "text",
"limit_req_burst": "text",
"limit_req_rate": "text",
"mask_headers": "text",
"name": "text",
"proxy_connect_timeout": "text",
"proxy_read_timeout": "text",
"proxy_send_timeout": "text",
"send_timeout": "text",
"ssl_ciphers": "text",
"ssl_conf_specific": "",
"ssl_protocols": [
"SSLv2"
],
"upstream_host": "text",
"xff_header_name": "text",
"xrealip_header_name": "text",
"advanced_configuration": [
{
"configuration": "text",
"description": "",
"name": "text",
"protocol": [
"http"
]
}
]
}PUT /api/v4.0/conf/{config}/proxy-templates/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 793
{
"acao_header": true,
"client_body_buffer_size": "text",
"client_body_timeout": "text",
"client_header_buffer_size": "text",
"client_header_timeout": "text",
"client_max_body_size": "text",
"conf_specific": "",
"custom_listener": true,
"description": "",
"keepalive_timeout": "text",
"large_client_header_buffers_count": "text",
"large_client_header_buffers_size": "text",
"limit_req_burst": "text",
"limit_req_rate": "text",
"mask_headers": "text",
"name": "text",
"proxy_connect_timeout": "text",
"proxy_read_timeout": "text",
"proxy_send_timeout": "text",
"send_timeout": "text",
"ssl_ciphers": "text",
"ssl_conf_specific": "",
"ssl_protocols": [
"SSLv2"
],
"upstream_host": "text",
"xff_header_name": "text",
"xrealip_header_name": "text",
"advanced_configuration": [
{
"configuration": "text",
"description": "",
"name": "text",
"protocol": [
"http"
]
}
]
}POST /api/v4.0/conf/{config}/proxy-templates/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 793
{
"acao_header": true,
"client_body_buffer_size": "text",
"client_body_timeout": "text",
"client_header_buffer_size": "text",
"client_header_timeout": "text",
"client_max_body_size": "text",
"conf_specific": "",
"custom_listener": true,
"description": "",
"keepalive_timeout": "text",
"large_client_header_buffers_count": "text",
"large_client_header_buffers_size": "text",
"limit_req_burst": "text",
"limit_req_rate": "text",
"mask_headers": "text",
"name": "text",
"proxy_connect_timeout": "text",
"proxy_read_timeout": "text",
"proxy_send_timeout": "text",
"send_timeout": "text",
"ssl_ciphers": "text",
"ssl_conf_specific": "",
"ssl_protocols": [
"SSLv2"
],
"upstream_host": "text",
"xff_header_name": "text",
"xrealip_header_name": "text",
"advanced_configuration": [
{
"configuration": "text",
"description": "",
"name": "text",
"protocol": [
"http"
]
}
]
}DELETE /api/v4.0/conf/{config}/proxy-templates/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}{
"message": "Successfully updated entry"
}{
"message": "Successfully created entry"
}GET /api/v4.0/conf/{config}/backend-services HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"back_hosts": [
{
"backup": true,
"down": true,
"fail_timeout": 1,
"host": "text",
"http_ports": [
80,
8080
],
"https_ports": [
443,
8443
],
"max_fails": 1,
"monitor_state": "text",
"weight": 1
}
],
"description": "",
"http11": true,
"id": "text",
"least_conn": true,
"name": "text",
"sticky": "none",
"sticky_cookie_name": "",
"transport_mode": "default"
}
]
}PUT /api/v4.0/conf/{config}/backend-services HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 315
[
{
"back_hosts": [
{
"backup": true,
"down": true,
"fail_timeout": 1,
"host": "text",
"http_ports": [
80,
8080
],
"https_ports": [
443,
8443
],
"max_fails": 1,
"monitor_state": "text",
"weight": 1
}
],
"description": "",
"http11": true,
"id": "text",
"least_conn": true,
"name": "text",
"sticky": "none",
"sticky_cookie_name": "",
"transport_mode": "default"
}
]POST /api/v4.0/conf/{config}/backend-services HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 315
[
{
"back_hosts": [
{
"backup": true,
"down": true,
"fail_timeout": 1,
"host": "text",
"http_ports": [
80,
8080
],
"https_ports": [
443,
8443
],
"max_fails": 1,
"monitor_state": "text",
"weight": 1
}
],
"description": "",
"http11": true,
"id": "text",
"least_conn": true,
"name": "text",
"sticky": "none",
"sticky_cookie_name": "",
"transport_mode": "default"
}
]DELETE /api/v4.0/conf/{config}/backend-services HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/backend-services/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"back_hosts": [
{
"backup": true,
"down": true,
"fail_timeout": 1,
"host": "text",
"http_ports": [
80,
8080
],
"https_ports": [
443,
8443
],
"max_fails": 1,
"monitor_state": "text",
"weight": 1
}
],
"description": "",
"http11": true,
"id": "text",
"least_conn": true,
"name": "text",
"sticky": "none",
"sticky_cookie_name": "",
"transport_mode": "default"
}PUT /api/v4.0/conf/{config}/backend-services/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 313
{
"back_hosts": [
{
"backup": true,
"down": true,
"fail_timeout": 1,
"host": "text",
"http_ports": [
80,
8080
],
"https_ports": [
443,
8443
],
"max_fails": 1,
"monitor_state": "text",
"weight": 1
}
],
"description": "",
"http11": true,
"id": "text",
"least_conn": true,
"name": "text",
"sticky": "none",
"sticky_cookie_name": "",
"transport_mode": "default"
}POST /api/v4.0/conf/{config}/backend-services/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 313
{
"back_hosts": [
{
"backup": true,
"down": true,
"fail_timeout": 1,
"host": "text",
"http_ports": [
80,
8080
],
"https_ports": [
443,
8443
],
"max_fails": 1,
"monitor_state": "text",
"weight": 1
}
],
"description": "",
"http11": true,
"id": "text",
"least_conn": true,
"name": "text",
"sticky": "none",
"sticky_cookie_name": "",
"transport_mode": "default"
}DELETE /api/v4.0/conf/{config}/backend-services/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/backend-services/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-12-13T06:24:20.464Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}GET /api/v4.0/conf/{config}/backend-services/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"back_hosts": [
{
"backup": true,
"down": true,
"fail_timeout": 1,
"host": "text",
"http_ports": [
80,
8080
],
"https_ports": [
443,
8443
],
"max_fails": 1,
"monitor_state": "text",
"weight": 1
}
],
"description": "",
"http11": true,
"id": "text",
"least_conn": true,
"name": "text",
"sticky": "none",
"sticky_cookie_name": "",
"transport_mode": "default"
}
]
}PUT /api/v4.0/conf/{config}/backend-services/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}{
"message": "Successfully updated entry"
}{
"message": "Successfully created entry"
}GET /api/v4.0/conf/{config}/dynamic-rules HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"action": "text",
"active": true,
"description": "",
"id": "text",
"include": {
"relation": "OR",
"tags": [
"text"
]
},
"exclude": {
"relation": "OR",
"tags": [
"text"
]
},
"name": "text",
"offload_ip_filtering": true,
"tags": [
"text"
],
"target": "text",
"threshold": 1,
"timeframe": 1,
"ttl": 1
}
]
}GET /api/v4.0/conf/{config}/dynamic-rules/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"action": "text",
"active": true,
"description": "",
"id": "text",
"include": {
"relation": "OR",
"tags": [
"text"
]
},
"exclude": {
"relation": "OR",
"tags": [
"text"
]
},
"name": "text",
"offload_ip_filtering": true,
"tags": [
"text"
],
"target": "text",
"threshold": 1,
"timeframe": 1,
"ttl": 1
}PUT /api/v4.0/conf/{config}/dynamic-rules/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 258
{
"action": "text",
"active": true,
"description": "",
"id": "text",
"include": {
"relation": "OR",
"tags": [
"text"
]
},
"exclude": {
"relation": "OR",
"tags": [
"text"
]
},
"name": "text",
"offload_ip_filtering": true,
"tags": [
"text"
],
"target": "text",
"threshold": 1,
"timeframe": 1,
"ttl": 1
}POST /api/v4.0/conf/{config}/dynamic-rules/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 258
{
"action": "text",
"active": true,
"description": "",
"id": "text",
"include": {
"relation": "OR",
"tags": [
"text"
]
},
"exclude": {
"relation": "OR",
"tags": [
"text"
]
},
"name": "text",
"offload_ip_filtering": true,
"tags": [
"text"
],
"target": "text",
"threshold": 1,
"timeframe": 1,
"ttl": 1
}DELETE /api/v4.0/conf/{config}/dynamic-rules/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}{
"message": "Successfully updated entry"
}{
"message": "Successfully created entry"
}{
"message": "Successfully created entry"
}GET /api/v4.0/conf/{config}/rate-limit-rules HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"action": "text",
"active": true,
"description": "text",
"exclude": {
"relation": "OR",
"tags": [
"text"
]
},
"global": true,
"id": "text",
"include": {
"relation": "OR",
"tags": [
"text"
]
},
"is_action_ban": true,
"key": 1,
"last_activated": 1,
"name": "text",
"pairwith": null,
"tags": [
"text"
],
"threshold": 1,
"timeframe": 1,
"ttl": 1
}
]
}PUT /api/v4.0/conf/{config}/rate-limit-rules HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 298
[
{
"action": "text",
"active": true,
"description": "text",
"exclude": {
"relation": "OR",
"tags": [
"text"
]
},
"global": true,
"id": "text",
"include": {
"relation": "OR",
"tags": [
"text"
]
},
"is_action_ban": true,
"key": 1,
"last_activated": 1,
"name": "text",
"pairwith": null,
"tags": [
"text"
],
"threshold": 1,
"timeframe": 1,
"ttl": 1
}
]{
"message": "Successfully updated entry"
}POST /api/v4.0/conf/{config}/rate-limit-rules HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 298
[
{
"action": "text",
"active": true,
"description": "text",
"exclude": {
"relation": "OR",
"tags": [
"text"
]
},
"global": true,
"id": "text",
"include": {
"relation": "OR",
"tags": [
"text"
]
},
"is_action_ban": true,
"key": 1,
"last_activated": 1,
"name": "text",
"pairwith": null,
"tags": [
"text"
],
"threshold": 1,
"timeframe": 1,
"ttl": 1
}
]{
"message": "Successfully created entry"
}DELETE /api/v4.0/conf/{config}/rate-limit-rules HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/rate-limit-rules/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"action": "text",
"active": true,
"description": "text",
"exclude": {
"relation": "OR",
"tags": [
"text"
]
},
"global": true,
"id": "text",
"include": {
"relation": "OR",
"tags": [
"text"
]
},
"is_action_ban": true,
"key": 1,
"last_activated": 1,
"name": "text",
"pairwith": null,
"tags": [
"text"
],
"threshold": 1,
"timeframe": 1,
"ttl": 1
}PUT /api/v4.0/conf/{config}/rate-limit-rules/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 296
{
"action": "text",
"active": true,
"description": "text",
"exclude": {
"relation": "OR",
"tags": [
"text"
]
},
"global": true,
"id": "text",
"include": {
"relation": "OR",
"tags": [
"text"
]
},
"is_action_ban": true,
"key": 1,
"last_activated": 1,
"name": "text",
"pairwith": null,
"tags": [
"text"
],
"threshold": 1,
"timeframe": 1,
"ttl": 1
}POST /api/v4.0/conf/{config}/rate-limit-rules/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 296
{
"action": "text",
"active": true,
"description": "text",
"exclude": {
"relation": "OR",
"tags": [
"text"
]
},
"global": true,
"id": "text",
"include": {
"relation": "OR",
"tags": [
"text"
]
},
"is_action_ban": true,
"key": 1,
"last_activated": 1,
"name": "text",
"pairwith": null,
"tags": [
"text"
],
"threshold": 1,
"timeframe": 1,
"ttl": 1
}DELETE /api/v4.0/conf/{config}/rate-limit-rules/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/rate-limit-rules/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-12-13T06:24:20.464Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}GET /api/v4.0/conf/{config}/rate-limit-rules/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"action": "text",
"active": true,
"description": "text",
"exclude": {
"relation": "OR",
"tags": [
"text"
]
},
"global": true,
"id": "text",
"include": {
"relation": "OR",
"tags": [
"text"
]
},
"is_action_ban": true,
"key": 1,
"last_activated": 1,
"name": "text",
"pairwith": null,
"tags": [
"text"
],
"threshold": 1,
"timeframe": 1,
"ttl": 1
}
]
}PUT /api/v4.0/conf/{config}/rate-limit-rules/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}{
"message": "Successfully updated entry"
}{
"total": 1,
"items": [
"text"
]
}GET /api/v4.0/conf/{config}/tags/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"type": "text",
"embeddings": [
{}
]
}GET /api/v4.0/conf/{config}/tags HTTP/1.1
Host:
Accept: */*
Get an individual Log Exporter configuration from the specified configuration
Log Exporter configuration retrieved successfully
Validation Error
Update an individual Log Exporter configuration within a configuration
Name field
This configuration will only take effect when the flag is set to true
falseFormat of the log row that will be exported
Log Exporter configuration updated successfully
Validation Error
Create an individual Log Exporter configuration within a configuration
Name field
This configuration will only take effect when the flag is set to true
falseFormat of the log row that will be exported
Log Exporter configuration created successfully
Validation Error
Delete an individual Log Exporter configuration from the specified configuration
Log Exporter configuration deleted successfully
Validation Error
Get a specific version of an Log Exporter configuration
Log Exporter configuration version retrieved successfully
Validation Error
Set a previous Log Exporters version to be the current one
Log Exporters reversion was successful
Validation Error
Get a Mobile Application Group from the specified identifier
Mobile Application Group retrieved successfully
Input Error
Validation Error
Internal Server Error
Update an individual Mobile Application Group within a configuration
Mobile Application Group updated successfully
Input Error
Validation Error
Internal Server Error
Create an individual Mobile Application Group within a configuration
^[A-Za-z0-9\-\_]*$Mobile Application Group created successfully
Input Error
Validation Error
Internal Server Error
Delete an individual Mobile Applicaions Group from the specified configuration
Mobile Application Group deleted successfully
Bad Request
Validation Error
Internal Server Error
Update an existing set of Flow Control Policies for a configuration
This flow is active
""Tags describing requests to exclude from the flow control rule
[]Tags describing requests to include in the flow control rule
[]List of tags to apply
[]The time in which to limit the requests according to the threshold
Flow Control Policies updated successfully
Validation Error
Create a complete set of Flow Control Policies for a configuration
This flow is active
""Tags describing requests to exclude from the flow control rule
[]Tags describing requests to include in the flow control rule
[]List of tags to apply
[]The time in which to limit the requests according to the threshold
Flow Control Policies created successfully
Validation Error
Get a Flow Control Policy from the specified configuration
Flow Control Policy retrieved successfully
Validation Error
Update an individual Flow Control Policy within a configuration
This flow is active
""Tags describing requests to exclude from the flow control rule
[]Tags describing requests to include in the flow control rule
[]List of tags to apply
[]The time in which to limit the requests according to the threshold
Flow Control Policy updated successfully
Validation Error
Create an individual Flow Control Policy within a configuration
This flow is active
""Tags describing requests to exclude from the flow control rule
[]Tags describing requests to include in the flow control rule
[]List of tags to apply
[]The time in which to limit the requests according to the threshold
Flow Control Policy created successfully
Validation Error
Delete an individual Flow Control Policy from the specified configuration
Flow Control Policy deleted successfully
Validation Error
Get list of versions of Flow Control Policies in a configuration
Flow Control Policies version list retrieved successfully
Validation Error
Get a specific version of a Flow Control Policy
Flow Control Policy retrieved successfully
Validation Error
Set a previous Flow Control Policy version to be the current one
Flow Control Policy reversion was successful
Validation Error
GET /api/v4.0/conf/{config}/mobile-application-groups HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": []
}GET /api/v4.0/conf/{config}/mobile-application-groups/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"id": "text",
"name": "text",
"description": "text",
"uid_header": "text",
"grace": "text",
"active_config": [],
"signatures": [
{
"active": true,
"hash": "text",
"name": "text"
}
]
}PUT /api/v4.0/conf/{config}/mobile-application-groups/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 161
{
"id": "text",
"name": "text",
"description": "text",
"uid_header": "text",
"grace": "text",
"active_config": [],
"signatures": [
{
"active": true,
"hash": "text",
"name": "text"
}
]
}{
"message": "Successfully updated entry"
}POST /api/v4.0/conf/{config}/mobile-application-groups/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 161
{
"id": "text",
"name": "text",
"description": "text",
"uid_header": "text",
"grace": "text",
"active_config": [],
"signatures": [
{
"active": true,
"hash": "text",
"name": "text"
}
]
}{
"message": "Successfully created entry"
}DELETE /api/v4.0/conf/{config}/mobile-application-groups/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}{
"message": "Successfully updated entry"
}{
"message": "Successfully created entry"
}{
"message": "Successfully updated entry"
}{
"message": "Successfully created entry"
}GET /api/v4.0/conf/{config}/flow-control-policies HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"active": true,
"description": "",
"exclude": [
"text"
],
"id": "text",
"include": [
"text"
],
"key": [
{
"args": "text",
"attrs": "asnFlowSef",
"cookies": "text",
"headers": "text",
"plugins": "text"
}
],
"name": "text",
"steps": [
{
"args": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cookies": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"method": "GET",
"plugins": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"uri": "text"
}
],
"tags": [
"text"
],
"timeframe": 1
}
]
}PUT /api/v4.0/conf/{config}/flow-control-policies HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 441
[
{
"active": true,
"description": "",
"exclude": [
"text"
],
"id": "text",
"include": [
"text"
],
"key": [
{
"args": "text",
"attrs": "asnFlowSef",
"cookies": "text",
"headers": "text",
"plugins": "text"
}
],
"name": "text",
"steps": [
{
"args": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cookies": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"method": "GET",
"plugins": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"uri": "text"
}
],
"tags": [
"text"
],
"timeframe": 1
}
]POST /api/v4.0/conf/{config}/flow-control-policies HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 441
[
{
"active": true,
"description": "",
"exclude": [
"text"
],
"id": "text",
"include": [
"text"
],
"key": [
{
"args": "text",
"attrs": "asnFlowSef",
"cookies": "text",
"headers": "text",
"plugins": "text"
}
],
"name": "text",
"steps": [
{
"args": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cookies": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"method": "GET",
"plugins": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"uri": "text"
}
],
"tags": [
"text"
],
"timeframe": 1
}
]DELETE /api/v4.0/conf/{config}/flow-control-policies HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/flow-control-policies/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"active": true,
"description": "",
"exclude": [
"text"
],
"id": "text",
"include": [
"text"
],
"key": [
{
"args": "text",
"attrs": "asnFlowSef",
"cookies": "text",
"headers": "text",
"plugins": "text"
}
],
"name": "text",
"steps": [
{
"args": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cookies": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"method": "GET",
"plugins": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"uri": "text"
}
],
"tags": [
"text"
],
"timeframe": 1
}PUT /api/v4.0/conf/{config}/flow-control-policies/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 439
{
"active": true,
"description": "",
"exclude": [
"text"
],
"id": "text",
"include": [
"text"
],
"key": [
{
"args": "text",
"attrs": "asnFlowSef",
"cookies": "text",
"headers": "text",
"plugins": "text"
}
],
"name": "text",
"steps": [
{
"args": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cookies": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"method": "GET",
"plugins": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"uri": "text"
}
],
"tags": [
"text"
],
"timeframe": 1
}POST /api/v4.0/conf/{config}/flow-control-policies/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 439
{
"active": true,
"description": "",
"exclude": [
"text"
],
"id": "text",
"include": [
"text"
],
"key": [
{
"args": "text",
"attrs": "asnFlowSef",
"cookies": "text",
"headers": "text",
"plugins": "text"
}
],
"name": "text",
"steps": [
{
"args": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cookies": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"method": "GET",
"plugins": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"uri": "text"
}
],
"tags": [
"text"
],
"timeframe": 1
}DELETE /api/v4.0/conf/{config}/flow-control-policies/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/flow-control-policies/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-12-13T06:24:20.464Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}GET /api/v4.0/conf/{config}/flow-control-policies/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"active": true,
"description": "",
"exclude": [
"text"
],
"id": "text",
"include": [
"text"
],
"key": [
{
"args": "text",
"attrs": "asnFlowSef",
"cookies": "text",
"headers": "text",
"plugins": "text"
}
],
"name": "text",
"steps": [
{
"args": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cookies": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"method": "GET",
"plugins": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"uri": "text"
}
],
"tags": [
"text"
],
"timeframe": 1
}
]
}PUT /api/v4.0/conf/{config}/flow-control-policies/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}GET /api/v4.0/conf/{config}/log-exporters HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"id": "text",
"name": "text",
"active": false,
"filter": "all",
"format": "custom_syslog",
"server_groups": {
"all": true,
"ids": [
"text"
]
},
"connection": {
"host": "https://example.com",
"port": 1,
"protocol": "text",
"tls_mode": "no_tls",
"certificate": {
"chain_data": [],
"cert_body": "text"
}
}
}
]
}GET /api/v4.0/conf/{config}/log-exporters/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"id": "text",
"name": "text",
"active": false,
"filter": "all",
"format": "custom_syslog",
"server_groups": {
"all": true,
"ids": [
"text"
]
},
"connection": {
"host": "https://example.com",
"port": 1,
"protocol": "text",
"tls_mode": "no_tls",
"certificate": {
"chain_data": [],
"cert_body": "text"
}
}
}PUT /api/v4.0/conf/{config}/log-exporters/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 252
{
"id": "text",
"name": "text",
"active": false,
"filter": "all",
"format": "custom_syslog",
"server_groups": {
"all": true,
"ids": [
"text"
]
},
"connection": {
"host": "https://example.com",
"port": 1,
"protocol": "text",
"tls_mode": "no_tls",
"certificate": {
"cert_body": "text"
}
}
}POST /api/v4.0/conf/{config}/log-exporters/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 252
{
"id": "text",
"name": "text",
"active": false,
"filter": "all",
"format": "custom_syslog",
"server_groups": {
"all": true,
"ids": [
"text"
]
},
"connection": {
"host": "https://example.com",
"port": 1,
"protocol": "text",
"tls_mode": "no_tls",
"certificate": {
"cert_body": "text"
}
}
}DELETE /api/v4.0/conf/{config}/log-exporters/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/log-exporters/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-12-13T06:24:20.464Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}GET /api/v4.0/conf/{config}/log-exporters/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"id": "text",
"name": "text",
"active": false,
"filter": "all",
"format": "custom_syslog",
"server_groups": {
"all": true,
"ids": [
"text"
]
},
"connection": {
"host": "https://example.com",
"port": 1,
"protocol": "text",
"tls_mode": "no_tls",
"certificate": {
"chain_data": [],
"cert_body": "text"
}
}
}
]
}PUT /api/v4.0/conf/{config}/log-exporters/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}{
"message": "Successfully updated entry"
}{
"message": "Successfully created entry"
}Get a specific Certificate for a configuration
Certificate was retrieved successfully
Validation Error
Internal Server Error
Change settings for a specific certificate. ("le_" parameters refer to Let's Encrypt.)
truetrueCertificate modified successfully
No content
Validation Error
No content
Create new certificate for a specific list of domains. Generate new certificate or upload existing one based on input parameters. "le_" parameters refer to Let's Encrypt.
(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)[]Certificate created
Validation Error
Delete an individual Certificate from the specified configuration
Certificate deleted successfully
No content
Input Error
Validation Error
Internal Server Error
No content
Certificate's PEM retrieved successfully
Input Error
Validation Error
Internal Server Error
Certificate's PFX retrieved successfully
Input Error
Validation Error
Internal Server Error
Retrieve traffic data using 'filters' parameter, explained at https://gb.docs.reblaze.com/reference-information/api/api-access-to-traffic-data
1000Filters for request in format selected below (JSON or query string)
{"AND":[{"field":"timestamp","op":"between","value":["2024-06-06 09:31:00","2024-06-06 09:36:00"]},{"field":"status","op":"eq","value":301}]}if set to true the request will return rendered SQL without running it, for debug purposes
true | falseif set to true the query will be saved in the query history
true | falseDatabase to get data from
bigqueryPossible values: syntax of query
jsonLogs has been received successfully
Misconfigured request
When given a DER file, extracts and returns the certificate body
Required if the certificate is password-protected
Request was successful
Validation Error
Internal Server Error
No content
When given a PEM file, extracts and returns the certificate body
Required if the certificate is password-protected
Request was successful
Validation Error
Internal Server Error
No content
When given a PFX file, extracts and returns the certificate body and private key
Required if the certificate is password-protected
Request was successful
Validation Error
Internal Server Error
No content
Publish the current version of the specified configuration to the system storage bucket. By default, the name and url of the bucket are 'prod' and 'gs://rbz-$PLANETNAME-config/prod'. These values are also available in the console; navigate to System -> System DB -> select the system namespace -> publishinfo -> the buckets settings. Also, only one publish operation can occur at a time. If a 503 error is received, the previous operation has not yet finished, so the publish command should be resent until it is successful.
Configuration published successfully
Publish Configuration Validation Error
Validation Error
Internal Server Error
Publish Already In Progress
Get all Server Groups in a configuration. (Usually, each Server Group represents a site or domain.)
Server Groups retrieved successfully
Bad Request
Internal Server Error
Get a Server Group from the specified configuration
Server Group retrieved successfully
Bad Request
Validation Error
Internal Server Error
Update an individual Server Group within a configuration
Unique id
^[A-Za-z0-9\-\_]*$The domain for a challenge's cookie.
""ID of Mobile Application Group used for site.
site name
ID of Proxy template used for site.
ID of Routing profile used for site.
ID of security policy applied on site.
host names corresponding to the site.
ID of SSL certificate attached to site.
ID of SSL client CA certificate attached to site.
Controls how client certificate is checked when mTLS is enabled.
onPossible values: Server Group updated successfully
Input Error
Validation Error
Internal Server Error
Create a Server Group within a configuration
^[A-Za-z0-9\-\_]*$Unique id
^[A-Za-z0-9\-\_]*$The domain for a challenge's cookie.
""ID of Mobile Application Group used for site.
site name
ID of Proxy template used for site.
ID of Routing profile used for site.
ID of security policy applied on site.
host names corresponding to the site.
ID of SSL certificate attached to site.
ID of SSL client CA certificate attached to site.
Controls how client certificate is checked when mTLS is enabled.
onPossible values: Server Group created successfully
Bad Request
Validation Error
Internal Server Error
Delete a Server Group from the specified configuration
Server Group deleted successfully
Input Error
Validation Error
Internal Server Error
Update an existing set of Security Alerts for a configuration
List of attached Server Group IDs
List of attached Dynamic Rule IDs
Security Alerts updated successfully
Validation Error
Create complete set of Security Alerts for a configuration
List of attached Server Group IDs
List of attached Dynamic Rule IDs
Security Alerts created successfully
Validation Error
Update an individual Alert within a configuration
List of attached Server Group IDs
List of attached Dynamic Rule IDs
Alert updated successfully
Validation Error
Create an individual Alert within a configuration
List of attached Server Group IDs
List of attached Dynamic Rule IDs
Alert created successfully
Validation Error
Set a previous Security Alerts version to be the current one
Security Alerts reversion was successful
Validation Error
Create a complete set of Content Filter Profiles for a configuration
""List of tags to apply
[]List of content types
[]""A field in a JSON that contains GraphQL query that need to be parsed. The value should be passed in JSONPath format. It supports regex for values as well.
""List of tags to apply
[]When true, arguments, headers or cookies, which contain only alpha numeric characters, will be ignored
falseA seed which will be used in the masking process
List of tags to apply
[]List of tags to apply
[]Server Group created successfully
{
"message": "Successfully created entry"
}GET /api/v4.0/conf/{config}/certificates HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"cert_body": "text",
"expires": "2025-12-13",
"id": "text",
"issuer": "text",
"le_auto_renew": true,
"le_auto_replace": true,
"le_hash": "",
"private_key": "text",
"san": [
"text"
],
"subject": "text",
"uploaded": "2025-12-13T06:24:20.464Z",
"revoked": false,
"crl": [
"text"
],
"cdp": [
"text"
],
"side": "server"
}
]
}GET /api/v4.0/conf/{config}/certificates/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"links": [
{
"link": "text",
"provider": "text",
"region": "text"
}
],
"cert_body": "text",
"expires": "2025-12-13",
"id": "text",
"issuer": "text",
"le_auto_renew": true,
"le_auto_replace": true,
"le_hash": "",
"private_key": "text",
"san": [
"text"
],
"subject": "text",
"uploaded": "2025-12-13T06:24:20.464Z",
"revoked": false,
"crl": [
"text"
],
"cdp": [
"text"
],
"side": "server"
}PUT /api/v4.0/conf/{config}/certificates/{entry_id} HTTP/1.1
Host:
Accept: */*
POST /api/v4.0/conf/{config}/certificates/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 350
{
"provider_links": [
{
"link": "text",
"provider": "text",
"region": "text"
}
],
"cert_body": "text",
"expires": "2025-12-13",
"id": "text",
"issuer": "text",
"le_auto_renew": true,
"le_auto_replace": true,
"le_hash": "",
"private_key": "text",
"san": [
"text"
],
"subject": "text",
"uploaded": "2025-12-13T06:24:20.464Z",
"revoked": false,
"crl": [
"text"
],
"cdp": [
"text"
],
"side": "server"
}DELETE /api/v4.0/conf/{config}/certificates/{entry_id} HTTP/1.1
Host:
Accept: */*
GET /api/v4.0/conf/{config}/certificates/{entry_id}/pem HTTP/1.1
Host:
Accept: */*
binaryGET /api/v4.0/conf/{config}/certificates/{entry_id}/pfx HTTP/1.1
Host:
Accept: */*
binary{
"message": "Successfully updated entry"
}POST /api/v4.0/tools/certificates/extractder HTTP/1.1
Host:
Content-Type: multipart/form-data
Accept: */*
Content-Length: 39
{
"fileName": "binary",
"password": "text"
}POST /api/v4.0/tools/certificates/extractpem HTTP/1.1
Host:
Content-Type: multipart/form-data
Accept: */*
Content-Length: 39
{
"fileName": "binary",
"password": "text"
}POST /api/v4.0/tools/certificates/extractpfx HTTP/1.1
Host:
Content-Type: multipart/form-data
Accept: */*
Content-Length: 39
{
"fileName": "binary",
"password": "text"
}GET /api/v4.0/tools/dns-information HTTP/1.1
Host:
Accept: */*
PUT /api/v4.0/tools/publish/{config} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 30
[
{
"name": "text",
"url": "text"
}
]{
"message": "Successfully updated entry"
}{
"message": "Successfully created entry"
}GET /api/v4.0/conf/{config}/server-groups HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"id": "text",
"challenge_cookie_domain": "text",
"description": "",
"mobile_application_group": "text",
"name": "text",
"proxy_template": "text",
"routing_profile": "text",
"security_policy": "text",
"server_names": [
"text"
],
"ssl_certificate": "text",
"client_certificate": "text",
"client_certificate_mode": "on"
}
]
}GET /api/v4.0/conf/{config}/server-groups/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"id": "text",
"challenge_cookie_domain": "text",
"description": "",
"mobile_application_group": "text",
"name": "text",
"proxy_template": "text",
"routing_profile": "text",
"security_policy": "text",
"server_names": [
"text"
],
"ssl_certificate": "text",
"client_certificate": "text",
"client_certificate_mode": "on"
}PUT /api/v4.0/conf/{config}/server-groups/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 293
{
"id": "text",
"challenge_cookie_domain": "text",
"description": "",
"mobile_application_group": "text",
"name": "text",
"proxy_template": "text",
"routing_profile": "text",
"security_policy": "text",
"server_names": [
"text"
],
"ssl_certificate": "text",
"client_certificate": "text",
"client_certificate_mode": "on"
}POST /api/v4.0/conf/{config}/server-groups/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 293
{
"id": "text",
"challenge_cookie_domain": "text",
"description": "",
"mobile_application_group": "text",
"name": "text",
"proxy_template": "text",
"routing_profile": "text",
"security_policy": "text",
"server_names": [
"text"
],
"ssl_certificate": "text",
"client_certificate": "text",
"client_certificate_mode": "on"
}DELETE /api/v4.0/conf/{config}/server-groups/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/security-alerts HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"id": "text",
"name": "text",
"server_groups": [
"text"
],
"dynamic_rules": [
"text"
],
"recipients": [
"[email protected]"
]
}
]
}PUT /api/v4.0/conf/{config}/security-alerts HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 111
[
{
"id": "text",
"name": "text",
"server_groups": [
"text"
],
"dynamic_rules": [
"text"
],
"recipients": [
"[email protected]"
]
}
]{
"message": "Successfully updated entry"
}POST /api/v4.0/conf/{config}/security-alerts HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 111
[
{
"id": "text",
"name": "text",
"server_groups": [
"text"
],
"dynamic_rules": [
"text"
],
"recipients": [
"[email protected]"
]
}
]{
"message": "Successfully created entry"
}DELETE /api/v4.0/conf/{config}/security-alerts HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/security-alerts/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"id": "text",
"name": "text",
"server_groups": [
"text"
],
"dynamic_rules": [
"text"
],
"recipients": [
"[email protected]"
]
}PUT /api/v4.0/conf/{config}/security-alerts/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"id": "text",
"name": "text",
"server_groups": [
"text"
],
"dynamic_rules": [
"text"
],
"recipients": [
"[email protected]"
]
}{
"message": "Successfully updated entry"
}POST /api/v4.0/conf/{config}/security-alerts/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"id": "text",
"name": "text",
"server_groups": [
"text"
],
"dynamic_rules": [
"text"
],
"recipients": [
"[email protected]"
]
}{
"message": "Successfully created entry"
}DELETE /api/v4.0/conf/{config}/security-alerts/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/security-alerts/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-12-13T06:24:20.464Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}GET /api/v4.0/conf/{config}/security-alerts/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"id": "text",
"name": "text",
"server_groups": [
"text"
],
"dynamic_rules": [
"text"
],
"recipients": [
"[email protected]"
]
}
]
}PUT /api/v4.0/conf/{config}/security-alerts/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}{
"data": {
"results": [],
"statistics": {}
},
"status": 1
}GET /api/v4.0/data/logs HTTP/1.1
Host:
Accept: */*
Content Filter Profiles created successfully
Validation Error
Update an existing set of Security Policies for a configuration
Security Policies updated successfully
Validation Error
Create a complete set of Security Policies for a configuration
Security Policies created successfully
Validation Error
Update an individual Security Policy within a configuration
Security Policy updated successfully
Validation Error
Create an individual Security Policy within a configuration
Security Policy created successfully
Validation Error
Delete an individual Security Policy from the specified configuration
Security Policy deleted successfully
Validation Error
Get list of versions of Security Policies in a configuration
Security Policies version list retrieved successfully
Validation Error
Set a previous Security Policy version to be the current one
Security Policy reversion was successful
Validation Error
GET /api/v4.0/conf/{config}/content-filter-profiles HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"action": "",
"active": [
"text"
],
"allsections": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"args": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"content_type": [
"text"
],
"cookies": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"decoding": {
"base64": true,
"dual": false,
"html": false,
"unicode": false
},
"description": "",
"graphql_path": "",
"headers": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"id": "text",
"ignore": [
"text"
],
"ignore_alphanum": true,
"ignore_body": false,
"masking_seed": "text",
"name": "text",
"path": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"report": [
"text"
],
"tags": [
"text"
]
}
]
}POST /api/v4.0/conf/{config}/content-filter-profiles HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1652
[
{
"action": "",
"active": [
"text"
],
"allsections": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"args": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"content_type": [
"text"
],
"cookies": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"decoding": {
"base64": true,
"dual": false,
"html": false,
"unicode": false
},
"description": "",
"graphql_path": "",
"headers": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"id": "text",
"ignore": [
"text"
],
"ignore_alphanum": true,
"ignore_body": false,
"masking_seed": "text",
"name": "text",
"path": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"report": [
"text"
],
"tags": [
"text"
]
}
]DELETE /api/v4.0/conf/{config}/content-filter-profiles HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/content-filter-profiles/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"action": "",
"active": [
"text"
],
"allsections": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"args": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"content_type": [
"text"
],
"cookies": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"decoding": {
"base64": true,
"dual": false,
"html": false,
"unicode": false
},
"description": "",
"graphql_path": "",
"headers": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"id": "text",
"ignore": [
"text"
],
"ignore_alphanum": true,
"ignore_body": false,
"masking_seed": "text",
"name": "text",
"path": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"report": [
"text"
],
"tags": [
"text"
]
}GET /api/v4.0/conf/{config}/content-filter-profiles/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-12-13T06:24:20.464Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}PUT /api/v4.0/conf/{config}/content-filter-profiles/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}Security Policies created successfully
{
"message": "Successfully created entry"
}{
"message": "Successfully updated entry"
}{
"message": "Successfully created entry"
}{
"message": "Successfully updated entry"
}{
"message": "Successfully created entry"
}GET /api/v4.0/conf/{config}/security-policies HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"description": "text",
"id": "text",
"map": [
{
"acl_profile_active": true,
"acl_profile": "text",
"backend_service": "text",
"edge_functions": [
"text"
],
"content_filter_profile_active": true,
"content_filter_profile": "text",
"description": "text",
"id": "text",
"rate_limit_rules": [
"text"
],
"match": "text",
"name": "text"
}
],
"name": "text",
"session": 1,
"session_ids": 1,
"tags": [
"text"
]
}
]
}PUT /api/v4.0/conf/{config}/security-policies HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 361
[
{
"description": "text",
"id": "text",
"map": [
{
"acl_profile_active": true,
"acl_profile": "text",
"backend_service": "text",
"edge_functions": [
"text"
],
"content_filter_profile_active": true,
"content_filter_profile": "text",
"description": "text",
"id": "text",
"rate_limit_rules": [
"text"
],
"match": "text",
"name": "text"
}
],
"name": "text",
"session": 1,
"session_ids": 1,
"tags": [
"text"
]
}
]POST /api/v4.0/conf/{config}/security-policies HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 361
[
{
"description": "text",
"id": "text",
"map": [
{
"acl_profile_active": true,
"acl_profile": "text",
"backend_service": "text",
"edge_functions": [
"text"
],
"content_filter_profile_active": true,
"content_filter_profile": "text",
"description": "text",
"id": "text",
"rate_limit_rules": [
"text"
],
"match": "text",
"name": "text"
}
],
"name": "text",
"session": 1,
"session_ids": 1,
"tags": [
"text"
]
}
]DELETE /api/v4.0/conf/{config}/security-policies HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/security-policies/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"description": "text",
"id": "text",
"map": [
{
"acl_profile_active": true,
"acl_profile": "text",
"backend_service": "text",
"edge_functions": [
"text"
],
"content_filter_profile_active": true,
"content_filter_profile": "text",
"description": "text",
"id": "text",
"rate_limit_rules": [
"text"
],
"match": "text",
"name": "text"
}
],
"name": "text",
"session": 1,
"session_ids": 1,
"tags": [
"text"
]
}PUT /api/v4.0/conf/{config}/security-policies/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 359
{
"description": "text",
"id": "text",
"map": [
{
"acl_profile_active": true,
"acl_profile": "text",
"backend_service": "text",
"edge_functions": [
"text"
],
"content_filter_profile_active": true,
"content_filter_profile": "text",
"description": "text",
"id": "text",
"rate_limit_rules": [
"text"
],
"match": "text",
"name": "text"
}
],
"name": "text",
"session": 1,
"session_ids": 1,
"tags": [
"text"
]
}POST /api/v4.0/conf/{config}/security-policies/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 359
{
"description": "text",
"id": "text",
"map": [
{
"acl_profile_active": true,
"acl_profile": "text",
"backend_service": "text",
"edge_functions": [
"text"
],
"content_filter_profile_active": true,
"content_filter_profile": "text",
"description": "text",
"id": "text",
"rate_limit_rules": [
"text"
],
"match": "text",
"name": "text"
}
],
"name": "text",
"session": 1,
"session_ids": 1,
"tags": [
"text"
]
}DELETE /api/v4.0/conf/{config}/security-policies/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}GET /api/v4.0/conf/{config}/security-policies/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-12-13T06:24:20.464Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}GET /api/v4.0/conf/{config}/security-policies/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"description": "text",
"id": "text",
"map": [
{
"acl_profile_active": true,
"acl_profile": "text",
"backend_service": "text",
"edge_functions": [
"text"
],
"content_filter_profile_active": true,
"content_filter_profile": "text",
"description": "text",
"id": "text",
"rate_limit_rules": [
"text"
],
"match": "text",
"name": "text"
}
],
"name": "text",
"session": 1,
"session_ids": 1,
"tags": [
"text"
]
}
]
}PUT /api/v4.0/conf/{config}/security-policies/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}Add a certificate to a Load Balancer
An enumeration.
falsetrueSuccessfully added certificate to Load Balancer
No content
Validation Error
Internal Server Error
No content
Detach a non-default certificate from the Load Balancer
trueSuccessfully detached certificate from Load Balancer
No content
Validation Error
Internal Server Error
No content
Get regions with available datacenters for each Load Balancer.
Load Balancers retrieved successfully
Input Error
Internal Server Error
Set preferred datacenters for each Load Balancer. "automatic" will choose the best route depending on the load balancer location.
[{"id":"<id>","regions":{"ash":"ffm","ffm":"ffm","hkg":"ffm","lax":"ffm","lon":"ffm","sgp":"ffm","stl":"automatic"}}]Load Balancers retrieved successfully
Input Error
Internal Server Error
{
"message": "Successfully set Load Balancer regions"
}GET /api/v4.3/conf/{config}/load-balancers HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"certificates": [
"text"
],
"default_certificate": "text",
"dns_name": "text",
"listener_name": "text",
"listener_port": 1,
"load_balancer_type": "classic",
"max_certificates": 1,
"name": "text",
"provider": "aws",
"region": "text"
}
]
}PUT /api/v4.3/conf/{config}/load-balancers/{entry_name}/certificates/{certificate_id}?provider=aws®ion=text&listener=text&listener-port=1 HTTP/1.1
Host:
Accept: */*
DELETE /api/v4.3/conf/{config}/load-balancers/{entry_name}/certificates?provider=text®ion=text HTTP/1.1
Host:
Accept: */*
GET /api/v4.3/conf/{config}/load-balancers/regions HTTP/1.1
Host:
Accept: */*
{
"city_codes": "{\"ams\":\"Amsterdam\",\"ash\":\"Ashburn\",\"ffm\":\"Frankfurt\",\"hkg\":\"Hong Kong\",\"lax\":\"Los Angeles\",\"lon\":\"London\",\"sgp\":\"Singapore\",\"stl\":\"Saint Louis\"}\n",
"lbs": "[{\"id\":\"<id>\",\"name\":\"<name>\",\"regions\":{\"ams\":\"automatic\",\"ash\":\"automatic\",\"ffm\":\"automatic\",\"hkg\":\"automatic\",\"lax\":\"automatic\",\"lon\":\"automatic\",\"sgp\":\"automatic\",\"stl\":\"automatic\"},\"upstream_regions\":[\"ffm\",\"lax\"]}]\n"
}POST /api/v4.3/conf/{config}/load-balancers/regions HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 163
{
"lbs": "[{\"id\":\"<id>\",\"regions\":{\"ash\":\"ffm\",\"ffm\":\"ffm\",\"hkg\":\"ffm\",\"lax\":\"ffm\",\"lon\":\"ffm\",\"sgp\":\"ffm\",\"stl\":\"automatic\"}}]\n"
}