Edge Firewall

Edite no GitHub

Através da API do Edge Firewall você pode consultar, remover ou atualizar suas Edge Firewall Rule Sets existentes, bem como criar novas Rule Sets.

Associe também seus domínios à um Edge Firewall, para criar seus domínios consulte a documentação de API de Domains

Obter lista de Edge Firewall

Obter dados de um Edge Firewall

Deletar um Edge Firewall

Criar um novo Edge Firewall

Sobrescrever um Edge Firewall existente

Documentação de suporte

1. Obter lista de Edge Firewall

Retorna a lista de Edge Firewall.

GET /edge_firewall

Permissão necessária: View Edge Firewall

Parâmetro	Descrição	Tipo	Tipo de Dado
Authorization *obrigatório	A autenticação por Token previamente criado através do endpoint de Criação de Token.	header	string
Accept *obrigatório	Informações sobre o tipo de retorno e versão.	header	string; application/json;version=3

Exemplo de Requisição

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

Exemplo de Resposta

{
    "count": 4,
    "total_pages": 1,
    "schema_version": 3,
    "links": {
        "previous": null,
        "next": null
    },
    "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. Obter dados de um Edge Firewall

Retorna detalhes de um Edge Firewall.

GET /edge_firewall/:id

Permissão necessária: View Edge Firewall

Parâmetro	Descrição	Tipo	Tipo de Dado
Authorization *obrigatório	A autenticação por Token previamente criado através do endpoint de Criação de Token.	header	string
Accept *obrigatório	Informações sobre o tipo de retorno e versão.	header	string; application/json;version=3
:id *obrigatório	O id da edge firewall que se pretende obter.	path	integer

Exemplo de Requisição

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

Exemplo de Resposta

{
    "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. Deletar um Edge Firewall

Remove um Edge Firewall. Essa operação é definitiva, ou seja, não existe nenhuma forma de se realizar rollback dessas informações após a confirmação pelo usuário.

Todas as informações associadas a esse edge firewall, como Rules do Rules Engine ou Edge Functions Instances também serão removidas.

A API não exige confirmação para a execução dessa ação.

DELETE /edge_firewall/:id

Permissão necessária: Edit Edge Firewall

Parâmetro	Descrição	Tipo	Tipo de Dado
Authorization *obrigatório	A autenticação por Token previamente criado através do endpoint de Criação de Token.	header	string
Accept *obrigatório	Informações sobre o tipo de retorno e versão.	header	string; application/json;version=3
:id *obrigatório	O id do edge firewall que se pretende excluir.	path	number

Exemplo de Requisição

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

Exemplo de Resposta

HTTP/2 204

4. Criar um novo Edge Firewall

Possibilita a criação de um novo Edge Firewall.

Se deseja vincular seus domínios na criação do seu Edge Firewall, considere o campo domains preenchendo no formato de lista, os id’s respectivos dos domains.

POST /edge_firewall

Permissão necessária: Edit Edge Firewall

Parâmetro	Descrição	Tipo	Tipo de Dado
Authorization *obrigatório	A autenticação por Token previamente criado através do endpoint de Criação de Token.	header	string
Accept *obrigatório	Informações sobre o tipo de retorno e versão.	header	string; application/json;version=3
Content-Type *obrigatório	O tipo de codificação utilizada no Body (application/json). Exemplo: Content-Type: application/json	header	string

Exemplo de Requisição

POST /edge_firewall
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941
Content-Type: application/json

{
    "name": "Novo Edge Firewall",
    "domains": [ ],
    "is_active": true,
    "edge_functions_enabled": true,
    "network_protection_enabled": true,
    "waf_enabled": false
}

Exemplo de Resposta

{
    "results": {
        "name": "Novo 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. Sobrescrever um Edge Firewall

Sobrescreve todos os campos de um Edge Firewall Rule Set, preservando o id.

PUT /edge_firewall/:id

Permissão necessária: Edit Fdge Firewall

Parâmetro	Descrição	Tipo	Tipo de Dado
Authorization *obrigatório	A autenticação por Token previamente criado através do endpoint de Criação de Token.	header	string
Accept *obrigatório	Informações sobre o tipo de retorno e versão.	header	string; application/json;version=3
Content-Type *obrigatório	O tipo de codificação utilizada no Body (application/json). Exemplo: Content-Type: application/json	header	string
:id *obrigatório	Id do Edge Firewall a ser sobrescrito.	path	number

Exemplo de Requisição

PUT /edge_firewall/155
Accept: application/json; version=3
Authorization: token ec6aabdc0b6bbeed826a36d8731630e36b6e3f24
Content-Type: application/json

{
    "name": "Edge Firewall alterado pela API",
    "domains": [
        12312312,
        12321323
    ],
    "is_active": true,
    "edge_functions_enabled": true,
    "network_protection_enabled": true,
    "waf_enabled": true
}

Exemplo de Resposta

{
    "results": {
        "name": "Edge Firewall alterado pela 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. Documentação de suporte

Não encontrou o que procurava? Abra um ticket.