API

This page describes Reblaze's API namespaces and endpoints. It assumes you are already familiar with the information contained here, about internal data structures and API usage.

This page is provided for reference purposes. By default, every Reblaze planet includes an instance of Swagger UI, which provides this same information with additional interactive features (building curl commands, submitting API calls directly, etc). Read more about this.

API namespaces: overview

The various namespaces within the API can be organized into three categories of settings. The category listings below include links to more information about the settings themselves; the API calls are documented below.

Namespaces for security settings:

Namespaces for site-related settings:

Backend Services (the services that Reblaze is protecting)
Certificates (for managing SSL certificates)
Edge Functions (for running custom Lua code)
Load Balancers (managing SSL associated with load balancers)
Proxy Templates (parameters for the overall architecture of Reblaze)
Server Groups (site-level properties)

Namespaces for other capabilities:

Configs: for administration of configurations, the fundamental internal data structure
Data queries: for API access to traffic data and managing quarantined traffic sources.
Database: for management of versioning
Planets: for planet-level settings such as interactive challenges
Tags: for retrieval of tag data
Tools: for miscellaneous capabilities
Users: for management of users and API keys

Namespaces in alphabetical order

ACL Profiles

Get ACL Profiles

Get all ACL Profiles in a configuration

GET/api/v4.0/conf/{config}/acl-profiles

Path parameters

config*Config

Response

ACL Profiles retrieved successfully

Body

actionAction

allowAllow

allow_botAllow Bot

denyDeny

deny_botDeny Bot

descriptionDescription

force_denyForce Deny

id*Id

name*Name

passthroughPassthrough

tagsTags

Request

const response = await fetch('/api/v4.0/conf/{config}/acl-profiles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "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"
    ]
  }
]

Create ACL Profiles

Create a complete set of ACL Profiles for a configuration

POST/api/v4.0/conf/{config}/acl-profiles

Path parameters

config*Config

Body

actionAction

allowAllow

allow_botAllow Bot

denyDeny

deny_botDeny Bot

descriptionDescription

force_denyForce Deny

id*Id

name*Name

passthroughPassthrough

tagsTags

Response

ACL Profiles created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/acl-profiles', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text"
      }
    ]),
});
const data = await response.json();

Modify ACL Profiles

Updates an existing set of ACL Profiles for a configuration

PUT/api/v4.0/conf/{config}/acl-profiles

Path parameters

config*Config

Body

actionAction

allowAllow

allow_botAllow Bot

denyDeny

deny_botDeny Bot

descriptionDescription

force_denyForce Deny

id*Id

name*Name

passthroughPassthrough

tagsTags

Response

ACL Profiles updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/acl-profiles', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text"
      }
    ]),
});
const data = await response.json();

Delete ACL Profiles

Delete all ACL Profiles in a configuration

DELETE/api/v4.0/conf/{config}/acl-profiles

Path parameters

config*Config

Response

ACL Profiles deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/acl-profiles', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get single ACL Profile

Get an individual ACL Profile (not the entire set) from the specified configuration

GET/api/v4.0/conf/{config}/acl-profiles/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

ACL Profile retrieved successfully

Body

actionAction

allowAllow

allow_botAllow Bot

denyDeny

deny_botDeny Bot

descriptionDescription

force_denyForce Deny

id*Id

name*Name

passthroughPassthrough

tagsTags

Request

const response = await fetch('/api/v4.0/conf/{config}/acl-profiles/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
  ]
}

Create single ACL Profile

Create an individual ACL Profile within a configuration

POST/api/v4.0/conf/{config}/acl-profiles/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

actionAction

allowAllow

allow_botAllow Bot

denyDeny

deny_botDeny Bot

descriptionDescription

force_denyForce Deny

id*Id

name*Name

passthroughPassthrough

tagsTags

Response

ACL Profile created successfully

Body

message*Response message

Request

const response = await fetch('/api/v4.0/conf/{config}/acl-profiles/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "message": "text"
}

Modify a single ACL Profile

Update an individual ACL Profile within a configuration

PUT/api/v4.0/conf/{config}/acl-profiles/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

actionAction

allowAllow

allow_botAllow Bot

denyDeny

deny_botDeny Bot

descriptionDescription

force_denyForce Deny

id*Id

name*Name

passthroughPassthrough

tagsTags

Response

ACL Profile updated successfully

Body

message*Response message

Request

const response = await fetch('/api/v4.0/conf/{config}/acl-profiles/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text"
      }
    ]),
});
const data = await response.json();

Response

{
  "message": "text"
}

Delete single ACL Profile

Delete an individual ACL Profile (not the entire set) from the specified configuration

DELETE/api/v4.0/conf/{config}/acl-profiles/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

ACL Profile deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/acl-profiles/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get ACL Profiles version list

Get list of versions of ACL Profiles in a configuration

GET/api/v4.0/conf/{config}/acl-profiles/versions

Path parameters

config*Config

Response

ACL Profiles version list retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/acl-profiles/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get version of ACL Profile

Get a specific version of an ACL Profile

GET/api/v4.0/conf/{config}/acl-profiles/versions/{version}

Path parameters

config*Config

version*Version

Response

ACL Profile retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/acl-profiles/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Revert an ACL Profile to the specified version

Set a previous ACL Profile version to be the current one

PUT/api/v4.0/conf/{config}/acl-profiles/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

ACL Profile reversion was successful

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/acl-profiles/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Actions

Get Actions

Get all Actions in a configuration

GET/api/v4.0/conf/{config}/actions

Path parameters

config*Config

Response

Actions retrieved successfully

Body

descriptionDescription

id*Id

name*Name

paramsParams

tags*Tags

type*Type

Request

const response = await fetch('/api/v4.0/conf/{config}/actions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "description": "text",
    "id": "text",
    "name": "text",
    "tags": [
      "text"
    ],
    "type": "text"
  }
]

Create Actions

Create complete set of Actions for a configuration

POST/api/v4.0/conf/{config}/actions

Path parameters

config*Config

Body

descriptionDescription

id*Id

name*Name

paramsParams

tags*Tags

type*Type

Response

Actions created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/actions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "tags": [
          "text"
        ],
        "type": "text"
      }
    ]),
});
const data = await response.json();

Modify Actions

Update an existing set of Actions for a configuration

PUT/api/v4.0/conf/{config}/actions

Path parameters

config*Config

Body

descriptionDescription

id*Id

name*Name

paramsParams

tags*Tags

type*Type

Response

Actions updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/actions', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "tags": [
          "text"
        ],
        "type": "text"
      }
    ]),
});
const data = await response.json();

Delete Actions

Delete all Actions in a configuration

DELETE/api/v4.0/conf/{config}/actions

Path parameters

config*Config

Response

Actions deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/actions', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get single Action

Get an individual Action from the specified configuration

GET/api/v4.0/conf/{config}/actions/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Action retrieved successfully

Body

descriptionDescription

id*Id

name*Name

paramsParams

tags*Tags

type*Type

Request

const response = await fetch('/api/v4.0/conf/{config}/actions/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "description": "text",
  "id": "text",
  "name": "text",
  "tags": [
    "text"
  ],
  "type": "text"
}

Create single Action

Create an individual Action within a configuration

POST/api/v4.0/conf/{config}/actions/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

descriptionDescription

id*Id

name*Name

paramsParams

tags*Tags

type*Type

Response

Action created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/actions/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "tags": [
        "text"
      ],
      "type": "text"
    }),
});
const data = await response.json();

Modify a single Action

Update an individual Action within a configuration

PUT/api/v4.0/conf/{config}/actions/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

descriptionDescription

id*Id

name*Name

paramsParams

tags*Tags

type*Type

Response

Action updated successfully

Body

message*Response message

Request

const response = await fetch('/api/v4.0/conf/{config}/actions/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "tags": [
        "text"
      ],
      "type": "text"
    }),
});
const data = await response.json();

Response

{
  "message": "text"
}

Delete single Action

Delete an individual Action from the specified configuration

DELETE/api/v4.0/conf/{config}/actions/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Action deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/actions/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get Actions version list

Get list of versions of Actions in a configuration

GET/api/v4.0/conf/{config}/actions/versions

Path parameters

config*Config

Response

Actions version list retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/actions/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get version of Actions

Get a specific version of an Action

GET/api/v4.0/conf/{config}/actions/versions/{version}

Path parameters

config*Config

version*Version

Response

Action version retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/actions/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Revert Actions to the specified version

Set a previous Actions version to be the current one

PUT/api/v4.0/conf/{config}/actions/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

Actions reversion was successful

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/actions/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Backend Services

Get Backend Services

Get all Backend Services in a configuration

GET/api/v4.0/conf/{config}/backend-services

Path parameters

config*Config

Response

Backend Services retrieved successfully

Body

back_hosts*Back Hosts

descriptionDescription

http11*Http11

Use HTTP/1.1

id*Id

least_conn*Least Conn

name*Name

sticky*Sticky

Load Balancing stickiness model

noneautocookiecustomcookieiphashleast_conn

sticky_cookie_name*Sticky Cookie Name

Custom cookie name

transport_mode*Transport Mode

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.

defaulthttphttpsport_bridge

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "back_hosts": [
      {
        "backup": false,
        "down": false,
        "host": "text",
        "monitor_state": "text"
      }
    ],
    "description": "text",
    "http11": false,
    "id": "text",
    "least_conn": false,
    "name": "text",
    "sticky": "none",
    "sticky_cookie_name": "text",
    "transport_mode": "default"
  }
]

Create Backend Services

Create a complete set of Backend Services for a configuration

POST/api/v4.0/conf/{config}/backend-services

Path parameters

config*Config

Body

back_hosts*Back Hosts

descriptionDescription

http11*Http11

Use HTTP/1.1

id*Id

least_conn*Least Conn

name*Name

sticky*Sticky

Load Balancing stickiness model

noneautocookiecustomcookieiphashleast_conn

sticky_cookie_name*Sticky Cookie Name

Custom cookie name

transport_mode*Transport Mode

defaulthttphttpsport_bridge

Response

Backend Services created successfully

Body

message*Response message

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "http11": false,
        "transport_mode": "default",
        "sticky": "none",
        "sticky_cookie_name": "text",
        "least_conn": false,
        "back_hosts": [
          {
            "host": "text",
            "down": false,
            "monitor_state": "text",
            "backup": false
          }
        ]
      }
    ]),
});
const data = await response.json();

Response

{
  "message": "text"
}

Modify Backend Services

Updates an existing set of Backend Services for a configuration

PUT/api/v4.0/conf/{config}/backend-services

Path parameters

config*Config

Body

back_hosts*Back Hosts

descriptionDescription

http11*Http11

Use HTTP/1.1

id*Id

least_conn*Least Conn

name*Name

sticky*Sticky

Load Balancing stickiness model

noneautocookiecustomcookieiphashleast_conn

sticky_cookie_name*Sticky Cookie Name

Custom cookie name

transport_mode*Transport Mode

defaulthttphttpsport_bridge

Response

Backend Services updated successfully

Body

message*Response message

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "http11": false,
        "transport_mode": "default",
        "sticky": "none",
        "sticky_cookie_name": "text",
        "least_conn": false,
        "back_hosts": [
          {
            "host": "text",
            "down": false,
            "monitor_state": "text",
            "backup": false
          }
        ]
      }
    ]),
});
const data = await response.json();

Response

{
  "message": "text"
}

Delete Backend Services

Delete all Backend Services in a configuration

DELETE/api/v4.0/conf/{config}/backend-services

Path parameters

config*Config

Response

Backend Services deleted successfully

Body

message*Response message

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "text"
}

Get single Backend Service

Get an individual Backend Service from the specified configuration

GET/api/v4.0/conf/{config}/backend-services/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Backend Service retrieved successfully

Body

back_hosts*Back Hosts

descriptionDescription

http11*Http11

Use HTTP/1.1

id*Id

least_conn*Least Conn

name*Name

sticky*Sticky

Load Balancing stickiness model

noneautocookiecustomcookieiphashleast_conn

sticky_cookie_name*Sticky Cookie Name

Custom cookie name

transport_mode*Transport Mode

defaulthttphttpsport_bridge

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "back_hosts": [
    {
      "backup": false,
      "down": false,
      "host": "text",
      "monitor_state": "text"
    }
  ],
  "description": "text",
  "http11": false,
  "id": "text",
  "least_conn": false,
  "name": "text",
  "sticky": "none",
  "sticky_cookie_name": "text",
  "transport_mode": "default"
}

Create single Backend Service

Create an individual Backend Service within a configuration

POST/api/v4.0/conf/{config}/backend-services/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

back_hosts*Back Hosts

descriptionDescription

http11*Http11

Use HTTP/1.1

id*Id

least_conn*Least Conn

name*Name

sticky*Sticky

Load Balancing stickiness model

noneautocookiecustomcookieiphashleast_conn

sticky_cookie_name*Sticky Cookie Name

Custom cookie name

transport_mode*Transport Mode

defaulthttphttpsport_bridge

Response

Backend Service created successfully

Body

message*Response message

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "http11": false,
      "transport_mode": "default",
      "sticky": "none",
      "sticky_cookie_name": "text",
      "least_conn": false,
      "back_hosts": [
        {
          "host": "text",
          "down": false,
          "monitor_state": "text",
          "backup": false
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "message": "text"
}

Modify a single Backend Service

Update an individual Backend Service within a configuration

PUT/api/v4.0/conf/{config}/backend-services/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

back_hosts*Back Hosts

descriptionDescription

http11*Http11

Use HTTP/1.1

id*Id

least_conn*Least Conn

name*Name

sticky*Sticky

Load Balancing stickiness model

noneautocookiecustomcookieiphashleast_conn

sticky_cookie_name*Sticky Cookie Name

Custom cookie name

transport_mode*Transport Mode

defaulthttphttpsport_bridge

Response

Backend Service updated successfully

Body

message*Response message

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "http11": false,
      "transport_mode": "default",
      "sticky": "none",
      "sticky_cookie_name": "text",
      "least_conn": false,
      "back_hosts": [
        {
          "host": "text",
          "down": false,
          "monitor_state": "text",
          "backup": false
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "message": "text"
}

Delete single Backend Service

Delete an individual Backend Service from the specified configuration

DELETE/api/v4.0/conf/{config}/backend-services/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Backend Service deleted successfully

Body

message*Response message

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "text"
}

Get Backend Service usage by ID

Show where a specific Backend Service is being used

GET/api/v4.0/conf/{config}/backend-services/{entry_id}/links

Path parameters

config*Config

entry_id*Id

Response

Backend Service usage retrieved successfully

Body

db_key*Db Key

Key of object containing certificate or provider/load balancer

item*Item

Entry type (site/load balancer region)

name*Name

Object name (site/load balancer name)

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services/{entry_id}/links', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "db_key": "text",
    "item": "text",
    "name": "text"
  }
]

Get Backend Services version list

Get list of versions of Backend Services in a configuration

GET/api/v4.0/conf/{config}/backend-services/versions

Path parameters

config*Config

Response

Backend Services version list retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get version of Backend Service

Get a specific version of a Backend Service

GET/api/v4.0/conf/{config}/backend-services/versions/{version}

Path parameters

config*Config

version*Version

Response

Backend Service retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Revert a Backend Service to the specified version

Set a previous Backend Service version to be the current one

PUT/api/v4.0/conf/{config}/backend-services/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

Backend Service reversion was successful

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Certificates

List Certificates

Get a list of the planet's certificates for a configuration

GET/api/v4.0/conf/{config}/certificates

Path parameters

config*Config

Response

Certificates were retrieved successfully

Body

cert_bodyCert Body

expiresExpires

id*Id

Unique id

issuerIssuer

le_auto_renewLe Auto Renew

le_auto_replaceLe Auto Replace

le_hashLe Hash

private_keyPrivate Key

provider_linksProvider Links

sanSan

subjectSubject

uploadedUploaded

Request

const response = await fetch('/api/v4.0/conf/{config}/certificates', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "cert_body": "text",
    "expires": "2024-07-26",
    "id": "text",
    "issuer": "text",
    "le_auto_renew": true,
    "le_auto_replace": true,
    "le_hash": "text",
    "private_key": "text",
    "provider_links": [
      {
        "link": "text",
        "provider": "text",
        "region": "text"
      }
    ],
    "san": [
      "text"
    ],
    "subject": "text",
    "uploaded": "2024-07-26T15:37:20.792Z"
  }
]

Get Certificate

Get a specific Certificate for a configuration

GET/api/v4.0/conf/{config}/certificates/{entry_id}

Path parameters

config*Config

entry_id*Id

Response

Certificate was retrieved successfully

Body

cert_bodyCert Body

expiresExpires

id*Id

Unique id

issuerIssuer

le_auto_renewLe Auto Renew

le_auto_replaceLe Auto Replace

le_hashLe Hash

private_keyPrivate Key

provider_linksProvider Links

sanSan

subjectSubject

uploadedUploaded

Request

const response = await fetch('/api/v4.0/conf/{config}/certificates/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "cert_body": "text",
  "expires": "2024-07-26",
  "id": "text",
  "issuer": "text",
  "le_auto_renew": true,
  "le_auto_replace": true,
  "le_hash": "text",
  "private_key": "text",
  "provider_links": [
    {
      "link": "text",
      "provider": "text",
      "region": "text"
    }
  ],
  "san": [
    "text"
  ],
  "subject": "text",
  "uploaded": "2024-07-26T15:37:20.792Z"
}

Add Certificate

Can accept domains and replace_cert can be sent as queries. Load from pfx, pems or create certificate (generate or upload and replace based on input parameters). ("le_" parameters refer to Let's Encrypt.)

POST/api/v4.0/conf/{config}/certificates/{entry_id}

Path parameters

config*Config

entry_id*Id

Query parameters

Body

cert_bodyCert Body

expiresExpires

id*Id

Unique id

issuerIssuer

le_auto_renewLe Auto Renew

le_auto_replaceLe Auto Replace

le_hashLe Hash

private_keyPrivate Key

provider_linksProvider Links

sanSan

subjectSubject

uploadedUploaded

Response

Certificate created

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/certificates/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text"
    }),
});
const data = await response.json();

Modify Certificate

Change settings for a specific certificate. ("le_" parameters refer to Let's Encrypt.)

PUT/api/v4.0/conf/{config}/certificates/{entry_id}

Path parameters

config*Config

entry_id*Id

Query parameters

Response

Certificate modified successfully

Request

const response = await fetch('/api/v4.0/conf/{config}/certificates/{entry_id}', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Delete Certificate

Delete an individual Certificate from the specified configuration

DELETE/api/v4.0/conf/{config}/certificates/{entry_id}

Path parameters

config*Config

entry_id*Id

Response

Certificate deleted successfully

Request

const response = await fetch('/api/v4.0/conf/{config}/certificates/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get certificate usage

Get usage of a specific Certificate by its id

GET/api/v4.0/conf/{config}/certificates/{entry_id}/links

Path parameters

config*Config

entry_id*Id

Response

Certificate info retrieved successfully

Body

db_key*Db Key

Key of object containing certificate or provider/load balancer

item*Item

Entry type (site/load balancer region)

name*Name

Object name (site/load balancer name)

Request

const response = await fetch('/api/v4.0/conf/{config}/certificates/{entry_id}/links', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "db_key": "text",
    "item": "text",
    "name": "text"
  }
]

Get Certificate Pfx

GET/api/v4.0/conf/{config}/certificates/{entry_id}/pfx

Path parameters

config*Config

entry_id*Id

Response

Certificate's pfx retrieved successfully

Body

Response Export Api V4.0 Reblaze Configs Certificates PFXG

Request

const response = await fetch('/api/v4.0/conf/{config}/certificates/{entry_id}/pfx', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

binary

Configs

Get Configurations

Get detailed list of existing configurations

GET/api/v4.0/conf/configs

Response

List of configurations was retrieved successfully

Body

dateDate

description*Description

id*Id

logsLogs

versionVersion

Request

const response = await fetch('/api/v4.0/conf/configs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "date": "2024-07-26T15:37:20.792Z",
    "description": "text",
    "id": "text",
    "logs": [
      {
        "date": "2024-07-26T15:37:20.792Z",
        "version": "text"
      }
    ],
    "version": "text"
  }
]

Get Versions of a Config

Retrieve a complete configuration

GET/api/v4.0/conf/configs/{config}

Path parameters

config*Config

Response

Configuration retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/configs/{config}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get Versions of a Config

Get all versions of a given configuration

GET/api/v4.0/conf/configs/{config}/versions

Path parameters

config*Config

Response

Config versions retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/configs/{config}/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Revert a Config to a Version

Set a previous version of a configuration to be the current one

PUT/api/v4.0/conf/configs/{config}/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

Configuration reversion was successful

Body

any

Request

const response = await fetch('/api/v4.0/conf/configs/{config}/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Content Filter Profiles

Get Content Filter Profiles

Get all Content Filter Profiles in a configuration

GET/api/v4.0/conf/{config}/content-filter-profiles

Path parameters

config*Config

Response

Content Filter Profiles retrieved successfully

Body

actionAction

activeActive

allsectionsAllsections

argsArgs

content_typeContent Type

cookiesCookies

decodingDecoding

descriptionDescription

graphql_pathGraphql Path

headersHeaders

id*Id

ignoreIgnore

ignore_alphanum*Ignore Alphanum

ignore_body*Ignore Body

masking_seed*Masking Seed

name*Name

pathPath

reportReport

tagsTags

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "action": "text",
    "active": [
      "text"
    ],
    "content_type": [
      "text"
    ],
    "description": "text",
    "graphql_path": "text",
    "id": "text",
    "ignore": [
      "text"
    ],
    "ignore_alphanum": false,
    "ignore_body": false,
    "masking_seed": "text",
    "name": "text",
    "report": [
      "text"
    ],
    "tags": [
      "text"
    ]
  }
]

Create Content Filter Profiles

Create a complete set of Content Filter Profiles for a configuration

POST/api/v4.0/conf/{config}/content-filter-profiles

Path parameters

config*Config

Body

actionAction

activeActive

allsectionsAllsections

argsArgs

content_typeContent Type

cookiesCookies

decodingDecoding

descriptionDescription

graphql_pathGraphql Path

headersHeaders

id*Id

ignoreIgnore

ignore_alphanum*Ignore Alphanum

ignore_body*Ignore Body

masking_seed*Masking Seed

name*Name

pathPath

reportReport

tagsTags

Response

Content Filter Profiles created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "ignore_alphanum": false,
        "masking_seed": "text",
        "ignore_body": false
      }
    ]),
});
const data = await response.json();

Modify Content Filter Profiles

Update an existing set of Content Filter Profiles for a configuration

PUT/api/v4.0/conf/{config}/content-filter-profiles

Path parameters

config*Config

Body

actionAction

activeActive

allsectionsAllsections

argsArgs

content_typeContent Type

cookiesCookies

decodingDecoding

descriptionDescription

graphql_pathGraphql Path

headersHeaders

id*Id

ignoreIgnore

ignore_alphanum*Ignore Alphanum

ignore_body*Ignore Body

masking_seed*Masking Seed

name*Name

pathPath

reportReport

tagsTags

Response

Content Filter Profiles updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "ignore_alphanum": false,
        "masking_seed": "text",
        "ignore_body": false
      }
    ]),
});
const data = await response.json();

Delete Content Filter Profiles

Delete all Content Filter Profiles in a configuration

DELETE/api/v4.0/conf/{config}/content-filter-profiles

Path parameters

config*Config

Response

Content Filter Profiles deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get single Content Filter Profile

Get a Content Filter Profile from the specified configuration

GET/api/v4.0/conf/{config}/content-filter-profiles/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Content Filter Profile retrieved successfully

Body

actionAction

activeActive

allsectionsAllsections

argsArgs

content_typeContent Type

cookiesCookies

decodingDecoding

descriptionDescription

graphql_pathGraphql Path

headersHeaders

id*Id

ignoreIgnore

ignore_alphanum*Ignore Alphanum

ignore_body*Ignore Body

masking_seed*Masking Seed

name*Name

pathPath

reportReport

tagsTags

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "action": "text",
  "active": [
    "text"
  ],
  "content_type": [
    "text"
  ],
  "description": "text",
  "graphql_path": "text",
  "id": "text",
  "ignore": [
    "text"
  ],
  "ignore_alphanum": false,
  "ignore_body": false,
  "masking_seed": "text",
  "name": "text",
  "report": [
    "text"
  ],
  "tags": [
    "text"
  ]
}

Create single Content Filter Profile

Create an individual Content Filter Profile within a configuration

POST/api/v4.0/conf/{config}/content-filter-profiles/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

actionAction

activeActive

allsectionsAllsections

argsArgs

content_typeContent Type

cookiesCookies

decodingDecoding

descriptionDescription

graphql_pathGraphql Path

headersHeaders

id*Id

ignoreIgnore

ignore_alphanum*Ignore Alphanum

ignore_body*Ignore Body

masking_seed*Masking Seed

name*Name

pathPath

reportReport

tagsTags

Response

Content Filter Profile created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "ignore_alphanum": false,
      "masking_seed": "text",
      "ignore_body": false
    }),
});
const data = await response.json();

Modify a single Content Filter Profile

Update an individual Content Filter Profile within a configuration

PUT/api/v4.0/conf/{config}/content-filter-profiles/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

actionAction

activeActive

allsectionsAllsections

argsArgs

content_typeContent Type

cookiesCookies

decodingDecoding

descriptionDescription

graphql_pathGraphql Path

headersHeaders

id*Id

ignoreIgnore

ignore_alphanum*Ignore Alphanum

ignore_body*Ignore Body

masking_seed*Masking Seed

name*Name

pathPath

reportReport

tagsTags

Response

Content Filter Profile updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "ignore_alphanum": false,
      "masking_seed": "text",
      "ignore_body": false
    }),
});
const data = await response.json();

Delete single Content Filter Profile

Delete an individual Content Filter Profile from the specified configuration

DELETE/api/v4.0/conf/{config}/content-filter-profiles/{entry_id}

Path parameters

config*Config

entry_id*Entry ID

Response

Content Filter Profile deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get Content Filter Profiles version list

Get list of versions of Content Filter Profiles in a configuration

GET/api/v4.0/conf/{config}/content-filter-profiles/versions

Path parameters

config*Config

Response

Content Filter Profiles version list retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get version of Content Filter Profile

Get a specific version of a Content Filter Profile

GET/api/v4.0/conf/{config}/content-filter-profiles/versions/{version}

Path parameters

config*Config

version*Version

Response

Content Filter Profile retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Revert a Content Filter Profile to the specified version

Set a previous Content Filter Profile version to be the current one

PUT/api/v4.0/conf/{config}/content-filter-profiles/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

Content Filter Profile reversion was successful

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Content Filter Rules

Get Content Filter Rules

Get all Content Filter Rules in a configuration

GET/api/v4.0/conf/{config}/content-filter-rules

Path parameters

config*Config

Response

Content Filter Rules retrieved successfully

Body

category*Category

certainity*Certainity

descriptionDescription

id*Id

msg*Msg

name*Name

operand*Operand

risk*Risk

severity*Severity

subcategory*Subcategory

tagsTags

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-rules', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "category": "text",
    "description": "text",
    "id": "text",
    "msg": "text",
    "name": "text",
    "operand": "text",
    "subcategory": "text",
    "tags": [
      "text"
    ]
  }
]

Create Content Filter Rules

Create a complete set of Content Filter Rules for a configuration

POST/api/v4.0/conf/{config}/content-filter-rules

Path parameters

config*Config

Body

category*Category

certainity*Certainity

descriptionDescription

id*Id

msg*Msg

name*Name

operand*Operand

risk*Risk

severity*Severity

subcategory*Subcategory

tagsTags

Response

Content Filter Rules created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-rules', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "msg": "text",
        "operand": "text",
        "category": "text",
        "subcategory": "text"
      }
    ]),
});
const data = await response.json();

Modify Content Filter Rules

Update an existing set of Content Filter Rules for a configuration

PUT/api/v4.0/conf/{config}/content-filter-rules

Path parameters

config*Config

Body

category*Category

certainity*Certainity

descriptionDescription

id*Id

msg*Msg

name*Name

operand*Operand

risk*Risk

severity*Severity

subcategory*Subcategory

tagsTags

Response

Content Filter Rules updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-rules', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "msg": "text",
        "operand": "text",
        "category": "text",
        "subcategory": "text"
      }
    ]),
});
const data = await response.json();

Delete Content Filter Rules

Delete all Content Filter Rules in a configuration

DELETE/api/v4.0/conf/{config}/content-filter-rules

Path parameters

config*Config

Response

Content Filter Rules deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-rules', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get single Content Filter Rule

Get a Content Filter Rule from the specified configuration

GET/api/v4.0/conf/{config}/content-filter-rules/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Content Filter Rule retrieved successfully

Body

category*Category

certainity*Certainity

descriptionDescription

id*Id

msg*Msg

name*Name

operand*Operand

risk*Risk

severity*Severity

subcategory*Subcategory

tagsTags

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-rules/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "category": "text",
  "description": "text",
  "id": "text",
  "msg": "text",
  "name": "text",
  "operand": "text",
  "subcategory": "text",
  "tags": [
    "text"
  ]
}

Create single Content Filter Rule

Create an individual Content Filter Rule within a configuration

POST/api/v4.0/conf/{config}/content-filter-rules/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

category*Category

certainity*Certainity

descriptionDescription

id*Id

msg*Msg

name*Name

operand*Operand

risk*Risk

severity*Severity

subcategory*Subcategory

tagsTags

Response

Content Filter Rule created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-rules/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "msg": "text",
      "operand": "text",
      "category": "text",
      "subcategory": "text"
    }),
});
const data = await response.json();

Modify a single Content Filter Rule

Update an individual Content Filter Rule within a configuration

PUT/api/v4.0/conf/{config}/content-filter-rules/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

category*Category

certainity*Certainity

descriptionDescription

id*Id

msg*Msg

name*Name

operand*Operand

risk*Risk

severity*Severity

subcategory*Subcategory

tagsTags

Response

Content Filter Rule updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-rules/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "msg": "text",
      "operand": "text",
      "category": "text",
      "subcategory": "text"
    }),
});
const data = await response.json();

Delete single Content Filter Rule

Delete an individual Content Filter Rule from the specified configuration

DELETE/api/v4.0/conf/{config}/content-filter-rules/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Content Filter Rule deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-rules/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get Content Filter Rules version list

Get list of versions of Content Filter Rules in a configuration

GET/api/v4.0/conf/{config}/content-filter-rules/versions

Path parameters

config*Config

Response

Content Filter Rules version list retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-rules/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get version of Content Filter Rule set

Get a specific version of a Content Filter Rule set

GET/api/v4.0/conf/{config}/content-filter-rules/versions/{version}

Path parameters

config*Config

version*Version

Response

Content Filter Rule set retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-rules/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Revert a Content Filter Rule set to the specified version

Set a previous Content Filter Rule set version to be the current one

PUT/api/v4.0/conf/{config}/content-filter-rules/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

Content Filter Rule reversion was successful

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/content-filter-rules/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Data queries

Two of the Data queries routes below manage quarantined traffic sources. The rest are for retrieving traffic data; see API Access to Traffic Data for instructions on using them.

Get log lines

Get log lines by a filter

GET/api/v4.0/data/logs

Query parameters

Header parameters

Response

Logs has been received successfully

Body

data*object

status*integer

Request

const response = await fetch('/api/v4.0/data/logs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": {
    "results": []
  }
}

Get quarantined list

GET/api/v4.0/data/quarantined

Query parameters

Header parameters

Response

Query for quarantined has been run successfully

Body

data*object

status*integer

Request

const response = await fetch('/api/v4.0/data/quarantined', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": {
    "results": []
  }
}

Delete record(s) from quarantined list

DELETE/api/v4.0/data/quarantined

Header parameters

Body

configstring

idsarray of string

rule_idsarray of string

Response

Record(s) was/were successfully deleted

Body

data*object

status*integer

Request

const response = await fetch('/api/v4.0/data/quarantined', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "data": {
    "results": []
  }
}

Get stats

Get stats (time_period, counter, hostname, bandwidth, latency) by a filter

GET/api/v4.0/data/stats

Query parameters

Header parameters

Response

Stats has been received successfully

Body

data*object

status*integer

Request

const response = await fetch('/api/v4.0/data/stats', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": {
    "results": []
  }
}

Get timeline

Get timeline (time_period, sessions, remote_addr, all_hits, blocked, origin_blocked, challenge, is_human, statuses stats, origin statuses stats, bytes_sent) by a filter

GET/api/v4.0/data/timeline

Query parameters

Header parameters

Response

Timeline has been received successfully

Body

data*object

status*integer

Request

const response = await fetch('/api/v4.0/data/timeline', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": {
    "results": []
  }
}

Query any database directly

Send string with filters to get filters into JSON format.

POST/api/v4.0/data/timeline/parse

Body

query*one of

Response

Filter string has been converted successfullylters

Body

object

Request

const response = await fetch('/api/v4.0/data/timeline/parse', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "query": "text"
    }),
});
const data = await response.json();

Get Topx

Get topx stats by a filter

GET/api/v4.0/data/topx

Query parameters

Header parameters

Response

Topx has been received successfully

Body

data*object

status*integer

Request

const response = await fetch('/api/v4.0/data/topx', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": {
    "results": []
  }
}

Dynamic Rules

Get Dynamic Rules

Get all Dynamic Rules in a configuration

GET/api/v4.0/conf/{config}/dynamic-rules

Path parameters

config*Config

Response

Dynamic Rules retrieved successfully

Body

action*Action

active*Active

descriptionDescription

excludeExclude

id*Id

Unique id

includeInclude

name*Name

tagsTags

target*Target

threshold*Threshold

timeframe*Timeframe

ttl*Ttl

Request

const response = await fetch('/api/v4.0/conf/{config}/dynamic-rules', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "action": "text",
    "active": false,
    "description": "text",
    "exclude": [
      "text"
    ],
    "id": "text",
    "include": [
      "text"
    ],
    "name": "text",
    "tags": [
      "text"
    ],
    "target": "text"
  }
]

Get specific Dynamic Rule

Get a Dynamic Rule from the specified configuration

GET/api/v4.0/conf/{config}/dynamic-rules/{entry_id}

Path parameters

config*Config

entry_id*Entry ID

Response

Dynamic Rule retrieved successfully

Body

action*Action

active*Active

descriptionDescription

excludeExclude

id*Id

Unique id

includeInclude

name*Name

tagsTags

target*Target

threshold*Threshold

timeframe*Timeframe

ttl*Ttl

Request

const response = await fetch('/api/v4.0/conf/{config}/dynamic-rules/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "action": "text",
  "active": false,
  "description": "text",
  "exclude": [
    "text"
  ],
  "id": "text",
  "include": [
    "text"
  ],
  "name": "text",
  "tags": [
    "text"
  ],
  "target": "text"
}

Create Dynamic Rule

Create an individual Dynamic Rule within a configuration

POST/api/v4.0/conf/{config}/dynamic-rules/{entry_id}

Path parameters

config*Config

entry_id*Id

Body

action*Action

active*Active

descriptionDescription

excludeExclude

id*Id

Unique id

includeInclude

name*Name

tagsTags

target*Target

threshold*Threshold

timeframe*Timeframe

ttl*Ttl

Response

Dynamic Rule created successfully

Body

id*Id

Request

const response = await fetch('/api/v4.0/conf/{config}/dynamic-rules/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "active": false,
      "target": "text",
      "action": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text"
}

Modify Dynamic Rule

Update an individual Dynamic Rule within a configuration

PUT/api/v4.0/conf/{config}/dynamic-rules/{entry_id}

Path parameters

config*Config

entry_id*Id

Body

action*Action

active*Active

descriptionDescription

excludeExclude

id*Id

Unique id

includeInclude

name*Name

tagsTags

target*Target

threshold*Threshold

timeframe*Timeframe

ttl*Ttl

Response

Dynamic Rule updated successfully

Request

const response = await fetch('/api/v4.0/conf/{config}/dynamic-rules/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "active": false,
      "target": "text",
      "action": "text"
    }),
});
const data = await response.json();

Delete Dynamic Rule

Delete an individual Dynamic Rule from the specified configuration

DELETE/api/v4.0/conf/{config}/dynamic-rules/{entry_id}

Path parameters

config*Config

entry_id*Id

Response

Dynamic Rule deleted successfully

Request

const response = await fetch('/api/v4.0/conf/{config}/dynamic-rules/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Edge Functions

Get Edge Functions

Get all Edge Functions in a configuration

GET/api/v4.0/conf/{config}/edge-functions

Path parameters

config*Config

Response

Edge Functions retrieved successfully

Body

code*Code

Edge Function Code

descriptionDescription

id*Id

Unique id

name*Name

phase*Phase

requestresponse

Request

const response = await fetch('/api/v4.0/conf/{config}/edge-functions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "code": "text",
    "description": "text",
    "id": "text",
    "name": "text",
    "phase": "request"
  }
]

Create Edge Functions

Create a complete set of Edge Functions for a configuration

POST/api/v4.0/conf/{config}/edge-functions

Path parameters

config*Config

Body

code*Code

Edge Function Code

descriptionDescription

id*Id

Unique id

name*Name

phase*Phase

requestresponse

Response

Edge Functions created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/edge-functions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "code": "text",
        "phase": "request"
      }
    ]),
});
const data = await response.json();

Modify Edge Functions

Update an existing set of Edge Functions for a configuration

PUT/api/v4.0/conf/{config}/edge-functions

Path parameters

config*Config

Body

code*Code

Edge Function Code

descriptionDescription

id*Id

Unique id

name*Name

phase*Phase

requestresponse

Response

Edge Functions updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/edge-functions', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "code": "text",
        "phase": "request"
      }
    ]),
});
const data = await response.json();

Delete Edge Functions

Delete all Edge Functions in a configuration

DELETE/api/v4.0/conf/{config}/edge-functions

Path parameters

config*Config

Response

Edge Functions deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/edge-functions', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get specific Edge Function

Get an Edge Function from the specified configuration

GET/api/v4.0/conf/{config}/edge-functions/{entry_id}

Path parameters

config*Config

entry_id*Entry ID

Response

Edge Function retrieved successfully

Body

code*Code

Edge Function Code

descriptionDescription

id*Id

Unique id

name*Name

phase*Phase

requestresponse

Request

const response = await fetch('/api/v4.0/conf/{config}/edge-functions/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "code": "text",
  "description": "text",
  "id": "text",
  "name": "text",
  "phase": "request"
}

Create single Edge Function

Create an individual Edge Function within a configuration

POST/api/v4.0/conf/{config}/edge-functions/{entry_id}

Path parameters

config*Config

entry_id*Entry ID

Body

code*Code

Edge Function Code

descriptionDescription

id*Id

Unique id

name*Name

phase*Phase

requestresponse

Response

Edge Function created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/edge-functions/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "code": "text",
      "phase": "request"
    }),
});
const data = await response.json();

Modify a single Edge Function

Update an individual Edge Function within a configuration

PUT/api/v4.0/conf/{config}/edge-functions/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

code*Code

Edge Function Code

descriptionDescription

id*Id

Unique id

name*Name

phase*Phase

requestresponse

Response

Edge Function updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/edge-functions/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "code": "text",
      "phase": "request"
    }),
});
const data = await response.json();

Delete single Edge Function

Delete an individual Edge Function from the specified configuration

DELETE/api/v4.0/conf/{config}/edge-functions/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Edge Function deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/edge-functions/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get usage of an Edge Function

Get usage of an individual Edge Function within a configuration

GET/api/v4.0/conf/{config}/edge-functions/{entry_id}/links

Path parameters

config*Config

entry_id*Id

Response

Edge Function usage retrieved successfully

Body

db_key*Db Key

Key of object containing certificate or provider/load balancer

item*Item

Entry type (site/load balancer region)

name*Name

Object name (site/load balancer name)

Request

const response = await fetch('/api/v4.0/conf/{config}/edge-functions/{entry_id}/links', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "db_key": "text",
    "item": "text",
    "name": "text"
  }
]

Get Edge Functions version list

Get list of versions of Edge Functions in a configuration

GET/api/v4.0/conf/{config}/edge-functions/versions

Path parameters

config*Config

Response

Edge Functions version list retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/edge-functions/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get version of Edge Function

Get a specific version of an Edge Function

GET/api/v4.0/conf/{config}/edge-functions/versions/{version}

Path parameters

config*Config

version*Version

Response

Edge Function retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/edge-functions/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Revert an Edge Function to the specified version

Set a previous Edge Function version to be the current one

PUT/api/v4.0/conf/{config}/edge-functions/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

Edge Function reversion was successful

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/edge-functions/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Flow Control Policies

Get Flow Control Policies

Get all Flow Control Policies in a configuration

GET/api/v4.0/conf/{config}/flow-control-policies

Path parameters

config*Config

Response

Flow Control Policies retrieved successfully

Body

active*Active

descriptionDescription

excludeExclude

id*Id

includeInclude

key*Key

name*Name

sequence*Sequence

tagsTags

timeframe*Timeframe

Request

const response = await fetch('/api/v4.0/conf/{config}/flow-control-policies', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "active": false,
    "description": "text",
    "exclude": [
      "text"
    ],
    "id": "text",
    "include": [
      "text"
    ],
    "key": [],
    "name": "text",
    "sequence": [],
    "tags": [
      "text"
    ]
  }
]

Create Flow Control Policies

Create a complete set of Flow Control Policies for a configuration

POST/api/v4.0/conf/{config}/flow-control-policies

Path parameters

config*Config

Body

active*Active

descriptionDescription

excludeExclude

id*Id

includeInclude

key*Key

name*Name

sequence*Sequence

tagsTags

timeframe*Timeframe

Response

Flow Control Policies created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/flow-control-policies', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "key": [],
        "sequence": [],
        "active": false
      }
    ]),
});
const data = await response.json();

Modify Flow Control Policies

Update an existing set of Flow Control Policies for a configuration

PUT/api/v4.0/conf/{config}/flow-control-policies

Path parameters

config*Config

Body

active*Active

descriptionDescription

excludeExclude

id*Id

includeInclude

key*Key

name*Name

sequence*Sequence

tagsTags

timeframe*Timeframe

Response

Flow Control Policies updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/flow-control-policies', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "key": [],
        "sequence": [],
        "active": false
      }
    ]),
});
const data = await response.json();

Delete Flow Control Policies

Delete all Flow Control Policies in a configuration

DELETE/api/v4.0/conf/{config}/flow-control-policies

Path parameters

config*Config

Response

Flow Control Policies deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/flow-control-policies', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get specific Flow Control Policy

Get a Flow Control Policy from the specified configuration

GET/api/v4.0/conf/{config}/flow-control-policies/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Flow Control Policy retrieved successfully

Body

active*Active

descriptionDescription

excludeExclude

id*Id

includeInclude

key*Key

name*Name

sequence*Sequence

tagsTags

timeframe*Timeframe

Request

const response = await fetch('/api/v4.0/conf/{config}/flow-control-policies/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "active": false,
  "description": "text",
  "exclude": [
    "text"
  ],
  "id": "text",
  "include": [
    "text"
  ],
  "key": [],
  "name": "text",
  "sequence": [],
  "tags": [
    "text"
  ]
}

Create single Flow Control Policy

Create an individual Flow Control Policy within a configuration

POST/api/v4.0/conf/{config}/flow-control-policies/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

active*Active

descriptionDescription

excludeExclude

id*Id

includeInclude

key*Key

name*Name

sequence*Sequence

tagsTags

timeframe*Timeframe

Response

Flow Control Policy created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/flow-control-policies/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "key": [],
      "sequence": [],
      "active": false
    }),
});
const data = await response.json();

Modify a single Flow Control Policy

Update an individual Flow Control Policy within a configuration

PUT/api/v4.0/conf/{config}/flow-control-policies/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

active*Active

descriptionDescription

excludeExclude

id*Id

includeInclude

key*Key

name*Name

sequence*Sequence

tagsTags

timeframe*Timeframe

Response

Flow Control Policy updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/flow-control-policies/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "key": [],
      "sequence": [],
      "active": false
    }),
});
const data = await response.json();

Delete single Flow Control Policy

Delete an individual Flow Control Policy from the specified configuration

DELETE/api/v4.0/conf/{config}/flow-control-policies/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Flow Control Policy deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/flow-control-policies/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get Flow Control Policies version list

Get list of versions of Flow Control Policies in a configuration

GET/api/v4.0/conf/{config}/flow-control-policies/versions

Path parameters

config*Config

Response

Flow Control Policies version list retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/flow-control-policies/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get version of Flow Control Policy

Get a specific version of a Flow Control Policy

GET/api/v4.0/conf/{config}/flow-control-policies/versions/{version}

Path parameters

config*Config

version*Version

Response

Flow Control Policy retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/flow-control-policies/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Revert a Flow Control Policy to the specified version

Set a previous Flow Control Policy version to be the current one

PUT/api/v4.0/conf/{config}/flow-control-policies/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

Flow Control Policy reversion was successful

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/flow-control-policies/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Global Filters

Get Global Filters

Get all Global Filters in a configuration

GET/api/v4.0/conf/{config}/global-filters

Path parameters

config*Config

Response

Global Filters retrieved successfully

Body

actionAction

active*Active

descriptionDescription

id*Id

mdate*Mdate

name*Name

ruleRule

source*Source

tagsTags

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "active": false,
    "description": "text",
    "id": "text",
    "mdate": "text",
    "name": "text",
    "source": "text",
    "tags": [
      "text"
    ]
  }
]

Create Global Filters

Create a complete set of Global Filters for a configuration

POST/api/v4.0/conf/{config}/global-filters

Path parameters

config*Config

Body

actionAction

active*Active

descriptionDescription

id*Id

mdate*Mdate

name*Name

ruleRule

source*Source

tagsTags

Response

Global Filters created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "source": "text",
        "mdate": "text",
        "active": false
      }
    ]),
});
const data = await response.json();

Modify Global Filters

Update an existing set of Global Filters for a configuration

PUT/api/v4.0/conf/{config}/global-filters

Path parameters

config*Config

Body

actionAction

active*Active

descriptionDescription

id*Id

mdate*Mdate

name*Name

ruleRule

source*Source

tagsTags

Response

Global Filters updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "source": "text",
        "mdate": "text",
        "active": false
      }
    ]),
});
const data = await response.json();

Delete Global Filters

Delete all Global Filters in a configuration

DELETE/api/v4.0/conf/{config}/global-filters

Path parameters

config*Config

Response

Global Filters deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get specific Global Filter

Get a Global Filter from the specified configuration

GET/api/v4.0/conf/{config}/global-filters/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Global Filter retrieved successfully

Body

actionAction

active*Active

descriptionDescription

id*Id

mdate*Mdate

name*Name

ruleRule

source*Source

tagsTags

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "active": false,
  "description": "text",
  "id": "text",
  "mdate": "text",
  "name": "text",
  "source": "text",
  "tags": [
    "text"
  ]
}

Create single Global Filter

Create an individual Global Filter within a configuration

POST/api/v4.0/conf/{config}/global-filters/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

actionAction

active*Active

descriptionDescription

id*Id

mdate*Mdate

name*Name

ruleRule

source*Source

tagsTags

Response

Global Filter created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "source": "text",
      "mdate": "text",
      "active": false
    }),
});
const data = await response.json();

Modify a single Global Filter

Update an individual Global Filter within a configuration

PUT/api/v4.0/conf/{config}/global-filters/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

actionAction

active*Active

descriptionDescription

id*Id

mdate*Mdate

name*Name

ruleRule

source*Source

tagsTags

Response

Global Filter updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "source": "text",
      "mdate": "text",
      "active": false
    }),
});
const data = await response.json();

Delete single Global Filter

Delete an individual Global Filter from the specified configuration

DELETE/api/v4.0/conf/{config}/global-filters/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Global Filter deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get Global Filters version list

Get list of versions of Global Filters in a configuration

GET/api/v4.0/conf/{config}/global-filters/versions

Path parameters

config*Config

Response

Global Filters version list retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get version of Global Filter

Get a specific version of a Global Filter

GET/api/v4.0/conf/{config}/global-filters/versions/{version}

Path parameters

config*Config

version*Version

Response

Global Filter retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Revert a Global Filter to the specified version

Set a previous Global Filter version to be the current one

PUT/api/v4.0/conf/{config}/global-filters/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

Global Filter reversion was successful

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Load Balancers

Get Load Balancers

Get all Load Balancers in a configuration

GET/api/v4.0/conf/{config}/load-balancers

Path parameters

config*Config

Response

Load Balancers retrieved successfully

Body

certificates*Certificates

default_certificate*Default Certificate

dns_name*Dns Name

listener_name*Listener Name

listener_port*Listener Port

Port in AWS or IP in GCP

load_balancer_type*Load Balancer Type

classicapplication

max_certificates*Max Certificates

name*Name

provider*CloudProviderEnum

An enumeration.

awsgcp

region*Region

Request

const response = await fetch('/api/v4.0/conf/{config}/load-balancers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "certificates": [
      "text"
    ],
    "default_certificate": "text",
    "dns_name": "text",
    "listener_name": "text",
    "load_balancer_type": "classic",
    "name": "text",
    "provider": "aws",
    "region": "text"
  }
]

Planets

Get Planet

Get planet-wide settings and values

GET/api/v4.0/conf/{config}/planets

Path parameters

config*Config

Response

Planet info successfully retrieved

Body

ichallenge*IChallenge

name*Name

trusted_nets*Trusted Nets

Request

const response = await fetch('/api/v4.0/conf/{config}/planets', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "ichallenge": {
    "palette": [
      "text"
    ]
  },
  "name": "text",
  "trusted_nets": [
    {
      "address": "text",
      "comment": "text"
    }
  ]
}

Modify Planet

Modify settings of a planet

PUT/api/v4.0/conf/{config}/planets/{entry_id}

Path parameters

config*Config

entry_id*Entry

Planet ID

Body

ichallenge*IChallenge

name*Name

trusted_nets*Trusted Nets

Response

Planet updated successfully

Request

const response = await fetch('/api/v4.0/conf/{config}/planets/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "trusted_nets": [
        {
          "address": "text",
          "comment": "text"
        }
      ],
      "ichallenge": {
        "palette": [
          "text"
        ]
      }
    }),
});
const data = await response.json();

Proxy Templates

Get Proxy Templates

Get all Proxy Templates in a configuration

GET/api/v4.0/conf/{config}/proxy-templates

Path parameters

config*Config

Response

Proxy Templates retrieved successfully

Body

acao_header*Acao Header

client_body_timeout*Client Body Timeout

client_header_buffer_size*Client Header Buffer Size

client_header_timeout*Client Header Timeout

client_max_body_size*Client Max Body Size

conf_specificConf Specific

custom_listener*Custom Listener

descriptionDescription

keepalive_timeout*Keepalive Timeout

large_client_header_buffers_count*Large Client Header Buffers Count

large_client_header_buffers_size*Large Client Header Buffers Size

limit_req_burst*Limit Req Burst

limit_req_rate*Limit Req Rate

mask_headers*Mask Headers

name*Name

proxy_connect_timeout*Proxy Connect Timeout

proxy_read_timeout*Proxy Read Timeout

proxy_send_timeout*Proxy Send Timeout

send_timeout*Send Timeout

ssl_conf_specificSsl Conf Specific

upstream_host*Upstream Host

xff_header_name*Xff Header Name

xrealip_header_name*Xrealip Header Name

Request

const response = await fetch('/api/v4.0/conf/{config}/proxy-templates', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "acao_header": false,
    "client_body_timeout": "text",
    "client_header_buffer_size": "text",
    "client_header_timeout": "text",
    "client_max_body_size": "text",
    "conf_specific": "text",
    "custom_listener": false,
    "description": "text",
    "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_conf_specific": "text",
    "upstream_host": "text",
    "xff_header_name": "text",
    "xrealip_header_name": "text"
  }
]

Get Proxy Template

Get a Proxy Template from the specified configuration

GET/api/v4.0/conf/{config}/proxy-templates/{entry_id}

Path parameters

config*Config

entry_id*Id

Response

Proxy Template retrieved successfully

Body

acao_header*Acao Header

client_body_timeout*Client Body Timeout

client_header_buffer_size*Client Header Buffer Size

client_header_timeout*Client Header Timeout

client_max_body_size*Client Max Body Size

conf_specificConf Specific

custom_listener*Custom Listener

descriptionDescription

keepalive_timeout*Keepalive Timeout

large_client_header_buffers_count*Large Client Header Buffers Count

large_client_header_buffers_size*Large Client Header Buffers Size

limit_req_burst*Limit Req Burst

limit_req_rate*Limit Req Rate

mask_headers*Mask Headers

name*Name

proxy_connect_timeout*Proxy Connect Timeout

proxy_read_timeout*Proxy Read Timeout

proxy_send_timeout*Proxy Send Timeout

send_timeout*Send Timeout

ssl_conf_specificSsl Conf Specific

upstream_host*Upstream Host

xff_header_name*Xff Header Name

xrealip_header_name*Xrealip Header Name

Request

const response = await fetch('/api/v4.0/conf/{config}/proxy-templates/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "acao_header": false,
  "client_body_timeout": "text",
  "client_header_buffer_size": "text",
  "client_header_timeout": "text",
  "client_max_body_size": "text",
  "conf_specific": "text",
  "custom_listener": false,
  "description": "text",
  "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_conf_specific": "text",
  "upstream_host": "text",
  "xff_header_name": "text",
  "xrealip_header_name": "text"
}

Create Proxy Template

Create an individual Proxy Template within a configuration

POST/api/v4.0/conf/{config}/proxy-templates/{entry_id}

Path parameters

config*Config

entry_id*Id

Body

acao_header*Acao Header

client_body_timeout*Client Body Timeout

client_header_buffer_size*Client Header Buffer Size

client_header_timeout*Client Header Timeout

client_max_body_size*Client Max Body Size

conf_specificConf Specific

custom_listener*Custom Listener

descriptionDescription

keepalive_timeout*Keepalive Timeout

large_client_header_buffers_count*Large Client Header Buffers Count

large_client_header_buffers_size*Large Client Header Buffers Size

limit_req_burst*Limit Req Burst

limit_req_rate*Limit Req Rate

mask_headers*Mask Headers

name*Name

proxy_connect_timeout*Proxy Connect Timeout

proxy_read_timeout*Proxy Read Timeout

proxy_send_timeout*Proxy Send Timeout

send_timeout*Send Timeout

ssl_conf_specificSsl Conf Specific

upstream_host*Upstream Host

xff_header_name*Xff Header Name

xrealip_header_name*Xrealip Header Name

Response

Proxy Template created successfully

Body

id*Id

Request

const response = await fetch('/api/v4.0/conf/{config}/proxy-templates/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "acao_header": false,
      "xff_header_name": "text",
      "proxy_connect_timeout": "text",
      "proxy_read_timeout": "text",
      "proxy_send_timeout": "text",
      "upstream_host": "text",
      "client_body_timeout": "text",
      "client_header_timeout": "text",
      "keepalive_timeout": "text",
      "send_timeout": "text",
      "client_max_body_size": "text",
      "limit_req_rate": "text",
      "limit_req_burst": "text",
      "mask_headers": "text",
      "xrealip_header_name": "text",
      "custom_listener": false,
      "client_header_buffer_size": "text",
      "large_client_header_buffers_count": "text",
      "large_client_header_buffers_size": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text"
}

Modify Proxy Template

Update an individual Proxy Template within a configuration

PUT/api/v4.0/conf/{config}/proxy-templates/{entry_id}

Path parameters

config*Config

entry_id*Id

Body

acao_header*Acao Header

client_body_timeout*Client Body Timeout

client_header_buffer_size*Client Header Buffer Size

client_header_timeout*Client Header Timeout

client_max_body_size*Client Max Body Size

conf_specificConf Specific

custom_listener*Custom Listener

descriptionDescription

keepalive_timeout*Keepalive Timeout

large_client_header_buffers_count*Large Client Header Buffers Count

large_client_header_buffers_size*Large Client Header Buffers Size

limit_req_burst*Limit Req Burst

limit_req_rate*Limit Req Rate

mask_headers*Mask Headers

name*Name

proxy_connect_timeout*Proxy Connect Timeout

proxy_read_timeout*Proxy Read Timeout

proxy_send_timeout*Proxy Send Timeout

send_timeout*Send Timeout

ssl_conf_specificSsl Conf Specific

upstream_host*Upstream Host

xff_header_name*Xff Header Name

xrealip_header_name*Xrealip Header Name

Response

Proxy Template updated successfully

Request

const response = await fetch('/api/v4.0/conf/{config}/proxy-templates/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "acao_header": false,
      "xff_header_name": "text",
      "proxy_connect_timeout": "text",
      "proxy_read_timeout": "text",
      "proxy_send_timeout": "text",
      "upstream_host": "text",
      "client_body_timeout": "text",
      "client_header_timeout": "text",
      "keepalive_timeout": "text",
      "send_timeout": "text",
      "client_max_body_size": "text",
      "limit_req_rate": "text",
      "limit_req_burst": "text",
      "mask_headers": "text",
      "xrealip_header_name": "text",
      "custom_listener": false,
      "client_header_buffer_size": "text",
      "large_client_header_buffers_count": "text",
      "large_client_header_buffers_size": "text"
    }),
});
const data = await response.json();

Delete Proxy Template

Delete an individual Proxy Template from the specified configuration

DELETE/api/v4.0/conf/{config}/proxy-templates/{entry_id}

Path parameters

config*Config

entry_id*Id

Response

Proxy Template deleted successfully

Request

const response = await fetch('/api/v4.0/conf/{config}/proxy-templates/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get usage of a Proxy Template

Get list of sites that use the specified Proxy Template

GET/api/v4.0/conf/{config}/proxy-templates/{entry_id}/links

Path parameters

config*Config

entry_id*Id

Response

Proxy Template usage retrieved successfully

Body

db_key*Db Key

Key of object containing certificate or provider/load balancer

item*Item

Entry type (site/load balancer region)

name*Name

Object name (site/load balancer name)

Request

const response = await fetch('/api/v4.0/conf/{config}/proxy-templates/{entry_id}/links', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "db_key": "text",
    "item": "text",
    "name": "text"
  }
]

Rate Limit Rules

Get Rate Limit Rules

Get all Rate Limit Rules in a configuration

GET/api/v4.0/conf/{config}/rate-limit-rules

Path parameters

config*Config

Response

Rate Limit Rules retrieved successfully

Body

action*Action

active*Active

descriptionDescription

excludeExclude

global*Global

id*Id

includeInclude

is_action_banIs Action Ban

keyKey

last_activatedLast Activated

name*Name

pairwithPairwith

tagsTags

threshold*Threshold

timeframe*Timeframe

ttlTtl

Request

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "action": "text",
    "active": false,
    "description": "text",
    "global": false,
    "id": "text",
    "is_action_ban": false,
    "name": "text",
    "tags": [
      "text"
    ]
  }
]

Create Rate Limit Rules

Create a complete set of Rate Limit Rules for a configuration

POST/api/v4.0/conf/{config}/rate-limit-rules

Path parameters

config*Config

Body

action*Action

active*Active

descriptionDescription

excludeExclude

global*Global

id*Id

includeInclude

is_action_banIs Action Ban

keyKey

last_activatedLast Activated

name*Name

pairwithPairwith

tagsTags

threshold*Threshold

timeframe*Timeframe

ttlTtl

Response

Rate Limit Rules created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "global": false,
        "active": false,
        "action": "text"
      }
    ]),
});
const data = await response.json();

Modify Rate Limit Rules

Update an existing set of Rate Limit Rules for a configuration

PUT/api/v4.0/conf/{config}/rate-limit-rules

Path parameters

config*Config

Body

action*Action

active*Active

descriptionDescription

excludeExclude

global*Global

id*Id

includeInclude

is_action_banIs Action Ban

keyKey

last_activatedLast Activated

name*Name

pairwithPairwith

tagsTags

threshold*Threshold

timeframe*Timeframe

ttlTtl

Response

Rate Limit Rules updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "global": false,
        "active": false,
        "action": "text"
      }
    ]),
});
const data = await response.json();

Delete Rate Limit Rules

Delete all Rate Limit Rules in a configuration

DELETE/api/v4.0/conf/{config}/rate-limit-rules

Path parameters

config*Config

Response

Rate Limit Rules deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get specific Rate Limit Rule

Get a Rate Limit Rule from the specified configuration

GET/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Rate Limit Rule retrieved successfully

Body

action*Action

active*Active

descriptionDescription

excludeExclude

global*Global

id*Id

includeInclude

is_action_banIs Action Ban

keyKey

last_activatedLast Activated

name*Name

pairwithPairwith

tagsTags

threshold*Threshold

timeframe*Timeframe

ttlTtl

Request

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "action": "text",
  "active": false,
  "description": "text",
  "global": false,
  "id": "text",
  "is_action_ban": false,
  "name": "text",
  "tags": [
    "text"
  ]
}

Create single Rate Limit Rule

Create an individual Rate Limit Rule within a configuration

POST/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

action*Action

active*Active

descriptionDescription

excludeExclude

global*Global

id*Id

includeInclude

is_action_banIs Action Ban

keyKey

last_activatedLast Activated

name*Name

pairwithPairwith

tagsTags

threshold*Threshold

timeframe*Timeframe

ttlTtl

Response

Rate Limit Rule created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "global": false,
      "active": false,
      "action": "text"
    }),
});
const data = await response.json();

Modify a single Rate Limit Rule

Update an individual Rate Limit Rule within a configuration

PUT/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

action*Action

active*Active

descriptionDescription

excludeExclude

global*Global

id*Id

includeInclude

is_action_banIs Action Ban

keyKey

last_activatedLast Activated

name*Name

pairwithPairwith

tagsTags

threshold*Threshold

timeframe*Timeframe

ttlTtl

Response

Rate Limit Rule updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "global": false,
      "active": false,
      "action": "text"
    }),
});
const data = await response.json();

Delete single Rate Limit Rule

Delete an individual Rate Limit Rule from the specified configuration

DELETE/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Rate Limit Rule deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get Rate Limit Rules version list

Get list of versions of Rate Limit Rules in a configuration

GET/api/v4.0/conf/{config}/rate-limit-rules/versions

Path parameters

config*Config

Response

Rate Limit Rules version list retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get version of Rate Limit Rule

Get a specific version of a Rate Limit Rule

GET/api/v4.0/conf/{config}/rate-limit-rules/versions/{version}

Path parameters

config*Config

version*Version

Response

Rate Limit Rule retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Revert a Rate Limit Rule to the specified version

Set a previous Rate Limit Rule version to be the current one

PUT/api/v4.0/conf/{config}/rate-limit-rules/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

Rate Limit Rule reversion was successful

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Security Policies

Get Security Policies

Get all Security Policies in a configuration

GET/api/v4.0/conf/{config}/security-policies

Path parameters

config*Config

Response

Security Policies retrieved successfully

Body

descriptionDescription

id*Id

mapMap

match*Match

name*Name

sessionSession

session_idsSession Ids

tagsTags

Request

const response = await fetch('/api/v4.0/conf/{config}/security-policies', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "description": "text",
    "id": "text",
    "map": [
      {
        "acl_active": false,
        "acl_profile": "text",
        "backend_id": "text",
        "cloud_functions": [
          "text"
        ],
        "content_filter_active": false,
        "content_filter_profile": "text",
        "description": "text",
        "id": "text",
        "limit_ids": [
          "text"
        ],
        "match": "text",
        "name": "text"
      }
    ],
    "match": "text",
    "name": "text",
    "tags": [
      "text"
    ]
  }
]

Create Security Policies

Create a complete set of Security Policies for a configuration

POST/api/v4.0/conf/{config}/security-policies

Path parameters

config*Config

Body

descriptionDescription

id*Id

mapMap

match*Match

name*Name

sessionSession

session_idsSession Ids

tagsTags

Response

Security Policies created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/security-policies', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "match": "text"
      }
    ]),
});
const data = await response.json();

Modify Security Policies

Update an existing set of Security Policies for a configuration

PUT/api/v4.0/conf/{config}/security-policies

Path parameters

config*Config

Body

descriptionDescription

id*Id

mapMap

match*Match

name*Name

sessionSession

session_idsSession Ids

tagsTags

Response

Security Policies updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/security-policies', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "match": "text"
      }
    ]),
});
const data = await response.json();

Delete Security Policies

Delete all Security Policies in a configuration

DELETE/api/v4.0/conf/{config}/security-policies

Path parameters

config*Config

Response

Security Policies deleted successfully

Body

descriptionDescription

id*Id

mapMap

match*Match

name*Name

sessionSession

session_idsSession Ids

tagsTags

Request

const response = await fetch('/api/v4.0/conf/{config}/security-policies', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "description": "text",
    "id": "text",
    "map": [
      {
        "acl_active": false,
        "acl_profile": "text",
        "backend_id": "text",
        "cloud_functions": [
          "text"
        ],
        "content_filter_active": false,
        "content_filter_profile": "text",
        "description": "text",
        "id": "text",
        "limit_ids": [
          "text"
        ],
        "match": "text",
        "name": "text"
      }
    ],
    "match": "text",
    "name": "text",
    "tags": [
      "text"
    ]
  }
]

Get specific Security Policy

Get a Security Policy from the specified configuration

GET/api/v4.0/conf/{config}/security-policies/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Security Policy retrieved successfully

Body

descriptionDescription

id*Id

mapMap

match*Match

name*Name

sessionSession

session_idsSession Ids

tagsTags

Request

const response = await fetch('/api/v4.0/conf/{config}/security-policies/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "description": "text",
  "id": "text",
  "map": [
    {
      "acl_active": false,
      "acl_profile": "text",
      "backend_id": "text",
      "cloud_functions": [
        "text"
      ],
      "content_filter_active": false,
      "content_filter_profile": "text",
      "description": "text",
      "id": "text",
      "limit_ids": [
        "text"
      ],
      "match": "text",
      "name": "text"
    }
  ],
  "match": "text",
  "name": "text",
  "tags": [
    "text"
  ]
}

Create single Security Policy

Create an individual Security Policy within a configuration

POST/api/v4.0/conf/{config}/security-policies/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

descriptionDescription

id*Id

mapMap

match*Match

name*Name

sessionSession

session_idsSession Ids

tagsTags

Response

Security Policy created successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/security-policies/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "match": "text"
    }),
});
const data = await response.json();

Modify a single Security Policy

Update an individual Security Policy within a configuration

PUT/api/v4.0/conf/{config}/security-policies/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

descriptionDescription

id*Id

mapMap

match*Match

name*Name

sessionSession

session_idsSession Ids

tagsTags

Response

Security Policy updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/security-policies/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "match": "text"
    }),
});
const data = await response.json();

Delete single Security Policy

Delete an individual Security Policy from the specified configuration

DELETE/api/v4.0/conf/{config}/security-policies/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Security Policy deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/security-policies/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get Security Policies version list

Get list of versions of Security Policies in a configuration

GET/api/v4.0/conf/{config}/security-policies/versions

Path parameters

config*Config

Response

Security Policies version list retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/security-policies/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get version of Security Policy

Get a specific version of a Security Policy

GET/api/v4.0/conf/{config}/security-policies/versions/{version}

Path parameters

config*Config

version*Version

Response

Security Policy retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/security-policies/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Revert a Security Policy to the specified version

Set a previous Security Policy version to be the current one

PUT/api/v4.0/conf/{config}/security-policies/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

Security Policy reversion was successful

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/security-policies/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Server Groups

Get all Server Groups (sites/domains)

Get all Server Groups in a configuration. (Usually, each Server Group represents a site or domain.)

GET/api/v4.0/conf/{config}/server-groups

Path parameters

config*Config

Response

Server Groups retrieved successfully

Body

challenge_cookie_domain*Challenge's Cookie Domain

The domain for a challenge's cookie.

descriptionDescription

id*Id

Unique id

mobile_sdkMobile SDK Settings

ID of Mobile SDK used for site.

name*Name

site name

proxy_template*Proxy Template

ID of Proxy template used for site.

routing_profile*Routing profile

ID of Routing profile used for site.

security_policy*Security Policy

ID of security policy applied on site.

server_names*Server Names

host names corresponding to the site.

ssl_certificateSSL Certificate

ID of SSL certificate attached to site.

Request

const response = await fetch('/api/v4.0/conf/{config}/server-groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "challenge_cookie_domain": "text",
    "description": "text",
    "id": "text",
    "mobile_sdk": "text",
    "name": "text",
    "proxy_template": "text",
    "routing_profile": "text",
    "security_policy": "text",
    "server_names": [
      "text"
    ],
    "ssl_certificate": "text"
  }
]

Get a specific Server Group (a specific site/domain)

Get a Server Group from the specified configuration

GET/api/v4.0/conf/{config}/server-groups/{entry_id}

Path parameters

config*Config

entry_id*Id

Response

Server Group retrieved successfully

Body

challenge_cookie_domain*Challenge's Cookie Domain

The domain for a challenge's cookie.

descriptionDescription

id*Id

Unique id

mobile_sdkMobile SDK Settings

ID of Mobile SDK used for site.

name*Name

site name

proxy_template*Proxy Template

ID of Proxy template used for site.

routing_profile*Routing profile

ID of Routing profile used for site.

security_policy*Security Policy

ID of security policy applied on site.

server_names*Server Names

host names corresponding to the site.

ssl_certificateSSL Certificate

ID of SSL certificate attached to site.

Request

const response = await fetch('/api/v4.0/conf/{config}/server-groups/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "challenge_cookie_domain": "text",
  "description": "text",
  "id": "text",
  "mobile_sdk": "text",
  "name": "text",
  "proxy_template": "text",
  "routing_profile": "text",
  "security_policy": "text",
  "server_names": [
    "text"
  ],
  "ssl_certificate": "text"
}

Create Server Group (a site/domain)

Create a Server Group within a configuration

POST/api/v4.0/conf/{config}/server-groups/{entry_id}

Path parameters

config*Config

entry_id*Id

Body

challenge_cookie_domain*Challenge's Cookie Domain

The domain for a challenge's cookie.

descriptionDescription

id*Id

Unique id

mobile_sdkMobile SDK Settings

ID of Mobile SDK used for site.

name*Name

site name

proxy_template*Proxy Template

ID of Proxy template used for site.

routing_profile*Routing profile

ID of Routing profile used for site.

security_policy*Security Policy

ID of security policy applied on site.

server_names*Server Names

host names corresponding to the site.

ssl_certificateSSL Certificate

ID of SSL certificate attached to site.

Response

Server Group created successfully

Body

id*Id

Request

const response = await fetch('/api/v4.0/conf/{config}/server-groups/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "server_names": [
        "text"
      ],
      "security_policy": "text",
      "routing_profile": "text",
      "proxy_template": "text",
      "challenge_cookie_domain": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text"
}

Modify Server Group (a site/domain)

Update an individual Server Group within a configuration

PUT/api/v4.0/conf/{config}/server-groups/{entry_id}

Path parameters

config*Config

entry_id*Id

Body

challenge_cookie_domain*Challenge's Cookie Domain

The domain for a challenge's cookie.

descriptionDescription

id*Id

Unique id

mobile_sdkMobile SDK Settings

ID of Mobile SDK used for site.

name*Name

site name

proxy_template*Proxy Template

ID of Proxy template used for site.

routing_profile*Routing profile

ID of Routing profile used for site.

security_policy*Security Policy

ID of security policy applied on site.

server_names*Server Names

host names corresponding to the site.

ssl_certificateSSL Certificate

ID of SSL certificate attached to site.

Response

Server Group updated successfully

Request

const response = await fetch('/api/v4.0/conf/{config}/server-groups/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "server_names": [
        "text"
      ],
      "security_policy": "text",
      "routing_profile": "text",
      "proxy_template": "text",
      "challenge_cookie_domain": "text"
    }),
});
const data = await response.json();

Delete a Server Group (a site/domain)

Delete a Server Group from the specified configuration

DELETE/api/v4.0/conf/{config}/server-groups/{entry_id}

Path parameters

config*Config

entry_id*Id

Response

Server Group deleted successfully

Request

const response = await fetch('/api/v4.0/conf/{config}/server-groups/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get All Tags

Get all tags in the system

GET/api/v4.0/conf/{config}/tags

Path parameters

config*Config

Response

Tags retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/tags', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get Tag Usage

Get usage of a tag in the configuration

GET/api/v4.0/conf/{config}/tags/{entry_id}

Path parameters

config*Config

entry_id*Tag

Response

Tag usage was retrieved successfully

Body

any

Request

const response = await fetch('/api/v4.0/conf/{config}/tags/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Tools

Extract Pfx

POST/api/v4.0/tools/certificates/extractpfx

Body

fileName*Filename

password*Password

Response

Request was successful

Body

any

Request

const response = await fetch('/api/v4.0/tools/certificates/extractpfx', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "fileName": "binary",
      "password": "text"
    }),
});
const data = await response.json();

Get Planet DNS information

Get DNS zone ID and predefined records

GET/api/v4.0/tools/dns-information

Response

Successfully retrieved DNS information

Body

any

Request

const response = await fetch('/api/v4.0/tools/dns-information', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Publish

Publish the current version of the specified configuration

PUT/api/v4.0/tools/publish/{config}

Path parameters

config*Config

Body

nameName

urlUrl

Response

Configuration published successfully

Request

const response = await fetch('/api/v4.0/tools/publish/{config}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {}
    ]),
});
const data = await response.json();

Users

Get list of users

GET/api/v4.0/accounts/users

Response

Users were retrieved successfully

Body

id*Id

name*Name

users*Users

Request

const response = await fetch('/api/v4.0/accounts/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "name": "text",
    "users": [
      {
        "contact_name": "text",
        "email": "name@gmail.com",
        "id": "text",
        "mobile": "text",
        "org_id": "text",
        "org_name": "text"
      }
    ]
  }
]

Create new user

POST/api/v4.0/accounts/users

Body

acl*Acl

contact_name*Contact Name

email*Email

mobile*Mobile

org_id*Org Id

Response

New user was created successfully

Body

id*Id

Request

const response = await fetch('/api/v4.0/accounts/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "mobile": "text",
      "contact_name": "text",
      "email": "name@gmail.com",
      "org_id": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text"
}

Get user details

GET/api/v4.0/accounts/{entry_id}

Path parameters

entry_id*Account ID

Account ID

Response

User details were retrieved successfully

Body

acl*Acl

contact_name*Contact Name

email*Email

id*Id

mobile*Mobile

org_id*Org Id

org_name*Org Name

otpseed*Otpseed

Request

const response = await fetch('/api/v4.0/accounts/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "contact_name": "text",
  "email": "name@gmail.com",
  "id": "text",
  "mobile": "text",
  "org_id": "text",
  "org_name": "text",
  "otpseed": "text"
}

Modify user

Update details of a user

PUT/api/v4.0/accounts/{entry_id}

Path parameters

entry_id*Account ID

Account ID

Body

acl*Acl

contact_name*Contact Name

mobile*Mobile

Response

User updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/accounts/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "mobile": "text",
      "contact_name": "text"
    }),
});
const data = await response.json();

Delete user

Delete user by user id

DELETE/api/v4.0/accounts/{entry_id}

Path parameters

entry_id*Account ID

Account ID

Response

User was deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/accounts/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get all API keys associated with the planet

GET/api/v4.0/accounts/api-keys

Response

API keys received successfully

Body

account_id*Account Id

created_by*Created By

created_time*Created Time

email*Email

id*Id

key*Key

title*Title

Request

const response = await fetch('/api/v4.0/accounts/api-keys', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "account_id": "text",
    "created_by": "text",
    "created_time": 0,
    "email": "text",
    "id": "text",
    "key": "text",
    "title": "text"
  }
]

Delete an API key

Revokes API key and makes it unavailable for use

PUT/api/v4.0/accounts/api-keys/{entry_id}

Path parameters

entry_id*Key Id

API key ID

Response

API key was revoked successfully

Body

any

Request

const response = await fetch('/api/v4.0/accounts/api-keys/{entry_id}', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Get API keys for a user

GET/api/v4.0/accounts/{entry_id}/api-keys

Path parameters

entry_id*Account ID

Account ID

Response

API keys for specified user were retrieved successfully

Body

account_id*Account Id

created_by*Created By

created_time*Created Time

email*Email

id*Id

key*Key

title*Title

Request

const response = await fetch('/api/v4.0/accounts/{entry_id}/api-keys', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "account_id": "text",
    "created_by": "text",
    "created_time": 0,
    "email": "text",
    "id": "text",
    "key": "text",
    "title": "text"
  }
]

Generate an API key for a user

POST/api/v4.0/accounts/{entry_id}/api-keys

Path parameters

entry_id*Account ID

Account ID

Body

title*Title

Response

API key for specified user was generated successfully

Body

any

Request

const response = await fetch('/api/v4.0/accounts/{entry_id}/api-keys', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text"
    }),
});
const data = await response.json();

Get SSO Config for the planet

GET/api/v4.0/accounts/sso

Response

SSO config retrieved successfully

Body

enabledEnabled

Is that profile enabled or not.

params*Params

SSO provider parameters

protocol*all of

SSO protocol

provider*all of

SSO provider

title*Title

Title of the SSO profile that will be displayed on the login page.

Request

const response = await fetch('/api/v4.0/accounts/sso', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "enabled": false,
  "params": {
    "client_id": "text",
    "client_secret": "text",
    "issuer": "text",
    "roles": [
      {
        "idp_group": "text",
        "reblaze_groups": [
          "reblaze-events-viewer"
        ]
      }
    ],
    "roles_claim_key": "text"
  },
  "protocol": {},
  "provider": {},
  "title": "text"
}

Add/Update SSO Config of OAuth2 protocol for the planet

POST/api/v4.0/accounts/sso/oauth2

Body

enabledEnabled

Is that profile enabled or not.

params*Params

SSO provider OAuth2 protocol parameters

protocol*all of

SSO protocol

provider*all of

SSO provider

title*Title

Title of the SSO profile that will be displayed on the login page.

Response

SSO config was updated successfully

Body

cert_thumbprintCert Thumbprint

Certificate thumbprint to show user certificate if correct. Is used only for user output.

code*Code

message*Message

Request

const response = await fetch('/api/v4.0/accounts/sso/oauth2', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "provider": {},
      "protocol": {},
      "params": {
        "client_id": "text",
        "client_secret": "text",
        "issuer": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "cert_thumbprint": "text",
  "message": "text"
}

Add/Update SSO Config of SAML2 protocol for the planet

POST/api/v4.0/accounts/sso/saml2

Body

enabledEnabled

Is that profile enabled or not.

params*Params

SSO provider SAML2 protocol parameters

protocol*all of

SSO protocol

provider*all of

SSO provider

title*Title

Title of the SSO profile that will be displayed on the login page.

Response

SSO config was updated successfully

Body

cert_thumbprintCert Thumbprint

Certificate thumbprint to show user certificate if correct. Is used only for user output.

code*Code

message*Message

Request

const response = await fetch('/api/v4.0/accounts/sso/saml2', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "provider": {},
      "protocol": {},
      "params": {
        "tenantId": "text",
        "entityId": "text",
        "login_url": "https://example.com"
      }
    }),
});
const data = await response.json();

Response

{
  "cert_thumbprint": "text",
  "message": "text"
}

PreviousAcronyms NextAPI Access to Traffic Data

Last updated 1 month ago