Get Cloud Defender configuration list

Retrieves Cloud Defender list configured in the Web Application.

The list contains only Cloud Defenders for organizations you can manage.

Authorizations

X-Aegister-Token

string

header

required

Query Parameters

limit

number

default:50

Max number of reponse items.

offset

number

default:0

Offset response items.

order

string

Order results by item field

organization

number

Filter by Organization ID

services

string[]

Filter by Service

Response

200

application/json

error

integer

Any value different from 0 indicates an error.
More details can be found in messages.

Required range: 0 <= x <= 0

Example:

0

messages

any[]

If error is 1, contains zero or more details on the error.

Example:

[]

total

number

Total number of items that meet the list filter.
This doesn't represent the number of items inside the data array.

Required range: x >= 0

Example:

20

data

object[]

Show child attributes

data.id

number

Cloud Defender unique identifier.

Required range: x >= 1

Example:

2

data.organization

object

Show child attributes

data.organization.id

number

Unique identifier for the Organization.

Example:

5

data.organization.name

string

Organization common name.

Example:

"Sample Organization"

data.organization.logo

string

Organization logo URL.

Example:

"https://sample.com/logo.svg"

data.email

string

Email address of the technical point of contact responsible for managing and overseeing the security aspects of your organization's devices. This email will be used for communication related to security alerts, updates, and important notifications.

Example:

"[e-mail]"

data.fqdn

string

(Fully Qualified Domain Name) is your web application domain name.

Example:

"sample.com"

data.check

object

Show child attributes

data.check.stat

object

Show child attributes

data.check.stat.fqdn

integer

If 1 indicates FQDN service is Active.

Required range: 0 <= x <= 1

Example:

1

data.check.stat.proxy

integer

If 1 indicates Proxy service is Active.

Required range: 0 <= x <= 1

Example:

1

data.check.stat.endpoint

integer

If 1 indicates Endpoint service is Active.

Required range: 0 <= x <= 1

Example:

1

data.check.stat.datetime

string

Latest timestamp this stat object has been updated.

data.check.status

integer

Indicates if all services are up and running.

Required range: 0 <= x <= 1

Example:

1

data.check.web_stat

object[]

Contains historic data about Cloud Defender.
Resolution is one Hour.

Show child attributes

data.check.web_stat.datetime

string

data.check.web_stat.waf_protection

number

Total blocked requests in the time elapsed from this object datetime and the one immediately before.

Required range: x >= 0

Example:

50

data.check.web_stat.total_managed_requests

number

Total requests in the time elapsed from this object datetime and the one immediately before.

Required range: x >= 0

Example:

200

data.endpoint

string

Web application exposed interface address.

Example:

"11.22.33.44"

data.services

enum<string>[]

Enabled services for this Cloud Defender

The enabled service.

Available options:

Caching,

DDoS,

OneFirewall,

WAF