Edit Cloud Defender configuration

cURL

curl --request PUT \
  --url https://app.aegister.com/api/v1/cloud-defender/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Aegister-Token: <api-key>' \
  --data '
{
  "organization": 123,
  "fqdn": "<string>",
  "email": "[email protected]",
  "endpoint": "127.0.0.1",
  "services": [
    "Caching"
  ]
}
'

{
  "error": 0,
  "messages": "<array>",
  "data": {
    "id": 2,
    "organization": {
      "id": 123,
      "name": "<string>",
      "logo": "<string>"
    },
    "email": "[email protected]",
    "fqdn": "<string>",
    "check": {
      "stat": {
        "fqdn": 0,
        "proxy": 0,
        "endpoint": 0,
        "datetime": "2023-11-07T05:31:56Z"
      },
      "status": 0,
      "web_stat": [
        {
          "datetime": "2023-11-07T05:31:56Z",
          "waf_protection": 1,
          "total_managed_requests": 1
        }
      ]
    },
    "endpoint": "127.0.0.1",
    "services": [
      "Caching"
    ]
  }
}

PUT

api

cloud-defender

{id}

cURL

curl --request PUT \
  --url https://app.aegister.com/api/v1/cloud-defender/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Aegister-Token: <api-key>' \
  --data '
{
  "organization": 123,
  "fqdn": "<string>",
  "email": "[email protected]",
  "endpoint": "127.0.0.1",
  "services": [
    "Caching"
  ]
}
'

{
  "error": 0,
  "messages": "<array>",
  "data": {
    "id": 2,
    "organization": {
      "id": 123,
      "name": "<string>",
      "logo": "<string>"
    },
    "email": "[email protected]",
    "fqdn": "<string>",
    "check": {
      "stat": {
        "fqdn": 0,
        "proxy": 0,
        "endpoint": 0,
        "datetime": "2023-11-07T05:31:56Z"
      },
      "status": 0,
      "web_stat": [
        {
          "datetime": "2023-11-07T05:31:56Z",
          "waf_protection": 1,
          "total_managed_requests": 1
        }
      ]
    },
    "endpoint": "127.0.0.1",
    "services": [
      "Caching"
    ]
  }
}

Authorizations

X-Aegister-Token

string

header

required

Path Parameters

integer

required

Body

organization

number

Organization unique identifier for which the Cloud Defender is installed.

fqdn

string

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

string<email>

Email address of the Cloud Defender manager.

endpoint

string<ipv4>

Web application exposed interface address.

services

enum<string>[]

The services you need to activate for the web application.

Opzioni disponibili:

Caching,

DDoS,

OneFirewall,

WAF

Response

error

integer

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

Intervallo richiesto: 0 <= x <= 0

messages

array

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

data

object

Mostra attributi figli

data.id

number

Cloud Defender unique identifier.

Intervallo richiesto: x >= 1

data.organization

object

Mostra attributi figli

data.organization.id

number

Unique identifier for the Organization.

data.organization.name

string

Organization common name.

data.organization.logo

string<uri>

Organization logo URL.

data.email

string<email>

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.

data.fqdn

string<hostname>

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

data.check

object

Mostra attributi figli

data.check.stat

object

Mostra attributi figli

data.check.stat.fqdn

integer

If 1 indicates FQDN service is Active.

Intervallo richiesto: 0 <= x <= 1

data.check.stat.proxy

integer

If 1 indicates Proxy service is Active.

Intervallo richiesto: 0 <= x <= 1

data.check.stat.endpoint

integer

If 1 indicates Endpoint service is Active.

Intervallo richiesto: 0 <= x <= 1

data.check.stat.datetime

string<date-time>

Latest timestamp this stat object has been updated.

data.check.status

integer

Indicates if all services are up and running.

Intervallo richiesto: 0 <= x <= 1

data.check.web_stat

object[]

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

Mostra attributi figli

data.check.web_stat.datetime

string<date-time>

data.check.web_stat.waf_protection

number

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

Intervallo richiesto: x >= 0

data.check.web_stat.total_managed_requests

number

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

Intervallo richiesto: x >= 0

data.endpoint

string<ipv4>

Web application exposed interface address.

data.services

enum<string>[]

Enabled services for this Cloud Defender

The enabled service.

Opzioni disponibili:

Caching,

DDoS,

OneFirewall,

WAF

Create Cloud Defender Delete Cloud Defender

⌘I

API Documentation

Endpoints

Edit Cloud Defender configuration

Authorizations

Path Parameters

Body

Response