Skip to main content
PUT
/
api
/
v1
/
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": "jsmith@example.com",
  "endpoint": "127.0.0.1",
  "services": [
    "Caching"
  ]
}
'
{
  "error": 0,
  "messages": "<array>",
  "data": {
    "id": 2,
    "organization": {
      "id": 123,
      "name": "<string>",
      "logo": "<string>"
    },
    "email": "jsmith@example.com",
    "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

​
id
integer
required

Body

​
organization
number

Organization unique identifier for which the Cloud Defender is installed.

Examples:

5

10

15

​
fqdn
string

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

Example:

"sample.com"

​
email
string<email>

Email address of the Cloud Defender manager.

Example:

"jdoe@sample.com"

​
endpoint
string<ipv4>

Web application exposed interface address.

Example:

"11.22.33.44"

​
services
enum<string>[]

The services you need to activate for the web application.

Available options:
Caching,
DDoS,
OneFirewall,
WAF

Response

​
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
array

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

Example:
[]
​
data
object