1 of 20
2 of 20
3 of 20
4 of 20
5 of 20
6 of 20
7 of 20
8 of 20
9 of 20
10 of 20
11 of 20
12 of 20
13 of 20
14 of 20
15 of 20
16 of 20
17 of 20
18 of 20
19 of 20
20 of 20

site

doc

blog

success stories

Edge Firewall

Edit on GitHub

The Edge Firewall API allows you to check, remove or update your existing settings, as well as creating new ones.

Also associate your domains with an Edge Firewall to create your domains consult the documentation for Domains API.

  1. Retrieving a list of Edge Firewall
  2. Retrieving details from an Edge Firewall
  3. Deleting an Edge Firewall
  4. Creating a new Edge Firewall
  5. Overwriting an Edge Firewall
  6. Support documentation

1. Retrieving a list of Edge Firewall

It returns a list of Edge Firewall.

GET /edge_firewall

Required permission: View Edge Firewall

Parameter Description Type Type of Data
Authorization
*required
Authentication through the Token, previously created through the endpoint of Token Creation. header string
Accept
*required
Details about the type of return and version. header string;
application/json;version=3

Request Example

GET /edge_firewall 
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941

Response Example

{
    "count": 36,
    "total_pages": 18,
    "schema_version": 3,
    "links": {
        "previous": null,
        "next": "https://api.azionapi.net/edge_firewall?page=2&page_size=2"
    },
    "results": [
         {
              "id": 200,
              "last_editor": "azion@azion.com",
              "last_modified": "2020-10-27T10:59:35.906016Z",
              "name": "Edge Firewall",
              "is_active": true,
              "edge_functions_enabled": false,
              "network_protection_enabled": true,
              "waf_enabled": true,
              "domains": [
                  160128906,
                  112788979,
                  120379900
              ]
          },
          {
              "id": 201,
              "last_editor": "azion@azion.com.br",
              "last_modified": "2020-10-07T13:30:49.406607Z",
              "name": "Edge Firewall - Rate Limit",
              "is_active": true,
              "edge_functions_enabled": true,
              "network_protection_enabled": true,
              "waf_enabled": true,
              "domains": []
               }
            ]
        }
    ]
}

2. Retrieving details from an Edge Firewall

It returns details of an Edge Firewall.

GET /edge_firewall/:id

Required permission: View Edge Firewall

Parameter Description Type Type of Data
Authorization
*required
Authentication through the Token, previously created through the endpoint of Token Creation. header string
Accept
*required
Details about the type of return and version. header string;
application/json;version=3
:id
*required
The id of the edge application that you plan to retrieve. path number

Request Example

GET /edge_firewall/200
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941

Response Example

{
    "results": {
            "id": 200,
            "last_editor": "azion@azion.com",
            "last_modified": "2020-10-27T10:59:35.906016Z",
            "name": "Edge Firewall",
            "is_active": true,
            "edge_functions_enabled": false,
            "network_protection_enabled": true,
            "waf_enabled": true,
            "domains": [
                160128906,
                112788979,
                120379900
            ]
       },
    "schema_version": 3
}

3. Deleting an Edge Firewall

It deletes an Edge Application. This operation is permanent, that is, there is no way to rollback this information once it has been confirmed by the user.

All information associated with this edge firewall will also be removed.

The API does not require confirmation in order to run this instruction.

DELETE /edge_firewall/:id

Required permission: Edit Edge Firewall

Parameter Description Type Type of Data
Authorization
*required
Authentication through the Token, previously created through the endpoint of Token Creation. header string
Accept
*mandatory
Details about the type of return and version. header string;
application/json;version=3
:id
*required
The id of the edge firewall that you plan to delete. path integer

Request Example

DELETE /edge_firewall/200
Accept: application/json; version=3
Authorization: token 2909f3932069047f4736dc87e72baaddd19c9f75

Response Example

HTTP/2 204

4. Creating a new Edge Firewall

It enables you to create an Edge Firewall.

If you want to link your domains when creating your Edge Firewall, consider the domains field by filling in the list format, the respective domains id’s.

POST /edge_firewall

Required permission: Edit Edge Firewall

Parameter Description Type Type of Data
Authorization
*required
Authentication through the Token, previously created through the endpoint of Token Creation header string
Accept
*required
Details about the type of return and version header string;
application/json;version=3
Content-Type
*required
The type of coding used in the Body (application/json).

Example:
Content-Type: application/json
header string

Request Example

POST /edge_firewall
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941
Content-Type: application/json
{
    "name": "Edge Firewall",
    "domains": [ ],
    "is_active": true,
    "edge_functions_enabled": true,
    "network_protection_enabled": true,
    "waf_enabled": false
}

Response Example

{
    "results": {
        "name": "Edge Firewall",
        "waf_enabled": false,
        "is_active": true,
        "edge_functions_enabled": true,
        "last_modified": "2020-10-27T14:31:23.508950Z",
        "domains": [],
        "last_editor": "azion@azion.com.br",
        "network_protection_enabled": true,
        "id": 299
    },
    "schema_version": 3
}

5. Overwriting an Edge Firewall

It overwrites all the fields of an Edge Firewall, retaining the id.

PUT /edge_firewall/:id

Required permission: Edit Edge Firewall

Parameter Description Type Type of Data
Authorization
*required
Authentication through the Token, previously created through the endpoint of Token Creation. header string
Accept
*required
Details about the type of return and version. header string;
application/json;version=3
Content-Type
*required
The type of coding used in the Body (application/json).

Example:
Content-Type: application/json
header string
:id
required
The Id of the Edge Firewall to be overwritten. path number

Request Example

PUT /edge_firewall/1555421177
Accept: application/json; version=3
Authorization: token ec6aabdc0b6bbeed826a36d8731630e36b6e3f24
Content-Type: application/json
{
    "name": "Edge Firewall changed by API",
    "domains": [
        12312312,
        12321323
    ],
    "is_active": true,
    "edge_functions_enabled": true,
    "network_protection_enabled": true,
    "waf_enabled": true
}

Response Example

{
    "results": {
        "name": "Edge Firewall changed by API",
        "waf_enabled": true,
        "is_active": true,
        "edge_functions_enabled": true,
        "last_modified": "2020-10-27T14:33:49.191317Z",
        "domains": [
            12312312,
            12321323
        ],
        "last_editor": "azion@azion.com.br",
        "network_protection_enabled": true,
        "id": 155
    },
    "schema_version": 3
}

6. Support documentation


Didn’t find what you were looking for? Open a ticket.