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

  1. Consulta lista de rule sets do Edge Firewall
  2. Consulta dados de uma rule set do Edge Firewall
  3. Deletar uma rule set do Edge Firewall
  4. Criar uma nova rule set do Edge Firewall
  5. Sobrescrever uma rule set do Edge Firewall
  6. Atualizar campos de uma rule set do Edge Firewall

1. Consulta lista de rule sets do Edge Firewall

Retorna a lista de rule sets do Edge Firewall.

GET /edge_firewall/rulesets

Permissão necessária: View Security Settings

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)

A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf

header string

Exemplo de Requisição

Exemplo de Resposta


2. Consulta dados de uma rule set do Edge Firewall

Retorna dados de uma rule set do Edge Firewall.

GET /edge_firewall/rulesets/:ruleset_id

Permissão necessária: View Security Settings

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)

A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf

header string
:ruleset_id

(obrigatório)

Id da rule set de Edge Firewall a ser consultada.
Para obter o Id de uma rule set, consulte a Lista de Rule Sets.
path number

Exemplo de Requisição

Exemplo de Resposta


3. Deletar uma rule set do Edge Firewall

Remove uma rule set do Edge Firewall. A rule set não pode estar em uso para ser removida.

DELETE /edge_firewall/rulesets/:ruleset_id

Permissão necessária: Edit Security Settings

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)

A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf

header string
:ruleset_id

(obrigatório)

Id da rule set de Edge Firewall a ser removida.
Para obter o Id de uma rule set do Edge Firewall, consulte a Lista de Rule Sets.
 path number

Exemplo de Requisição

Exemplo de Resposta


4. Criar uma nova rule set do Edge Firewall

Cria uma nova rule set do Edge Firewall.

POST /edge_firewall/rulesets

Permissão necessária: Edit Security Settings

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)

A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf

header string
Content-Type

(obrigatório)

O tipo de codificação utilizada no Body (application/json).

ex.:

Content-Type: application/json

header string
Configuration

(obrigatório)

A rule set que se deseja criar deve ser enviada codificada no formato json com os seguintes campos:

  • name (string): campo obrigatório que define o nome da rule set do Edge Firewall.
  • block_access_by_referer (boolean): utilize true para ativar o bloqueio da entrega de conteúdo baseada no HTTP Referrer; ou false para desativar o bloqueio.
  • allow_blank_referer (boolean):  defina o valor de allow_blank_referer como true se desejar permitir a entrega de conteúdo para uma requisição sem Referrer; ou false se desejar bloquear, caso você tenha ativado o bloqueio por HTTP Referrer.
  • accepted_domains (array): caso você tenha ativado o bloqueio por HTTP Referrer, liste os domínios para os quais as requisições devem ser liberadas.
  • geo_block (choice): utilize o valor “whitelist“, para ativar o bloqueio para todos os países, com exceção dos que você listar; “blacklist” para listar apenas os países que deseja bloquear; ou “disabled” para desativar o bloqueio por geo localização.
  • geo_countries (array): caso você tenha ativado geo_block por whitelist ou blacklist, liste os códigos de 3 letras dos países (ISO 3166-1 alpha-3) que deseja liberar ou bloquear, de acordo com sua seleção de geo_block.
  • ip_blocking_rule (choice): utilize o valor “allow_from_all“, para configurar o Edge Firewall para permitir o acesso de todos os IPs, por defaul, e definir uma blacklist no campo ip_blocking_address; ou utilize o valor “deny_from_all”, para bloquer o acesso de todos os IPs, por default, com exceção da whitelist configurada no campo ip_blocking_address.
  • ip_blocking_addresses (array): liste os endereços IP, ou máscaras CIDR, que você bloquear ou liberar. Caso você tenha configurado ip_blocking_rule como “allow_from_all”, este campo funciona como uma blacklist para bloquear os IPs listados; deixe o array vazio, caso não deseje bloquear nenhum endereço. Caso você tenha configurado ip_blocking_rule como “deny_from_all”, este campo funciona como uma whitelist para liberar apenas os IPs listados.
  • require_secure_token (boolean): utilize true para ativar a validação de secure token ou false, para desativar.
  • secret (string): caso tenha ativado a validação de secure token, defina a secret que será utilizada para composição do hash. Caso contrário, utilize null.
  • is_active (boolean): utilze true para ativar a rule set, ou false, caso deseje criar a rule set, sem ativá-la.
body json

Exemplo de Requisição

1
2
3
4
5
6
7
8
9
10
11
12
13
{
   "name": "Regra para liberar apenas Brasil",
   "block_access_by_referer": false,
   "accepted_domains": [],
   "geo_block": "whitelist",
   "geo_countries": ["BRA"],
   "ip_blocking_rule": "allow_from_all",
   "ip_blocking_addresses": [],
   "require_secure_token": true,
   "secret":"myscret",
   "is_active": true
}
 

Exemplo de Resposta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
   "id": 536,
   "name": "Regra para liberar apenas Brasil",
   "block_access_by_referer": false,
   "allow_blank_referer": false,
   "geo_block": "whitelist",
   "accepted_domains": [],
   "geo_countries": ["BRA"],
   "ip_blocking_rule": "allow_from_all",
   "ip_blocking_addresses": [],
   "require_secure_token": true,
   "secret": "myscret",
   "is_active": true
}
 


5. Sobrescrever uma rule set do Edge Firewall

Sobrescreve todos os campos de uma rule set do Edge Firewall, preservando o id. Os campos opcionais não informados serão substituídos pelos valores default. Considere utilizar o método PATCH no lugar de PUT, para atualizar somente alguns campos de uma rule set, sem alterar o valor dos demais.

PUT /edge_firewall/rulesets/:ruleset_id

Permissão necessária: Edit Security Settings

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)

A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf

header string
Content-Type

(obrigatório)

O tipo de codificação utilizada no Body (application/json).

ex.:

Content-Type: application/json

header string
:ruleset_id

(obrigratório)

Id da rule set de Edge Firewall a ser sobrescrita.
Para obter o Id de uma rule set do Edge Firewall, consulte a Lista de Rule Sets.
path number
Configuration

(obrigatório)

Os novos valores de cada campo da rule set. Os campos não preenchidos serão substituídos pelo valor default, com exceção dos campos obrigatórios, que precisam ser preenchidos. Se você desejar alterar apenas um dos campos, utilize o método PATCH ao invés do PUT.

  • name (string): campo obrigatório que define o nome da rule set do Edge Firewall.
  • block_access_by_referer (boolean): utilize true para ativar o bloqueio da entrega de conteúdo baseada no HTTP Referrer; ou false para desativar o bloqueio.
  • allow_blank_referer (boolean):  defina o valor de allow_blank_referer como true se desejar permitir a entrega de conteúdo para uma requisição sem Referrer; ou false se desejar bloquear, caso você tenha ativado o bloqueio por HTTP Referrer.
  • accepted_domains (array): caso você tenha ativado o bloqueio por HTTP Referrer, liste os domínios para os quais as requisições devem ser liberadas.
  • geo_block (choice): utilize o valor “whitelist“, para ativar o bloqueio para todos os países, com exceção dos que você listar; “blacklist” para listar apenas os países que deseja bloquear; ou “disabled” para desativar o bloqueio por geo localização.
  • geo_countries (array): caso você tenha ativado geo_block por whitelist ou blacklist, liste os códigos de 3 letras dos países (ISO 3166-1 alpha-3) que deseja liberar ou bloquear, de acordo com sua seleção de geo_block.
  • ip_blocking_rule (choice): utilize o valor “allow_from_all“, para configurar o Edge Firewall para permitir o acesso de todos os IPs, por defaul, e definir uma blacklist no campo ip_blocking_address; ou utilize o valor “deny_from_all”, para bloquer o acesso de todos os IPs, por default, com exceção da whitelist configurada no campo ip_blocking_address.
  • ip_blocking_addresses (array): liste os endereços IP, ou máscaras CIDR, que você bloquear ou liberar. Caso você tenha configurado ip_blocking_rule como “allow_from_all”, este campo funciona como uma blacklist para bloquear os IPs listados; deixe o array vazio, caso não deseje bloquear nenhum endereço. Caso você tenha configurado ip_blocking_rule como “deny_from_all”, este campo funciona como uma whitelist para liberar apenas os IPs listados.
  • require_secure_token (boolean): utilize true para ativar a validação de secure token ou false, para desativar.
  • secret (string): caso tenha ativado a validação de secure token, defina a secret que será utilizada para composição do hash. Caso contrário, utilize null.
  • is_active (boolean): utilze true para ativar a rule set, ou false, para desativá-la.
body json

Exemplo de Requisição

1
2
3
4
5
6
7
8
9
10
11
12
{
   "name": "Secure Token",
   "block_access_by_referer": false,
   "accepted_domains": [],
   "geo_block": "disabled",
   "geo_countries": [],
   "ip_blocking_rule": "allow_from_all",
   "ip_blocking_addresses": [],
   "require_secure_token": true,
   "secret": "myscret"
}
 

Exemplo de Resposta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
   "id": 536,
   "name": "Secure Token",
   "block_access_by_referer": false,
   "accepted_domains": [],
   "geo_block": "disabled",
   "geo_countries": [],
   "ip_blocking_rule": "allow_from_all",
   "ip_blocking_addresses": [],
   "require_secure_token": true,
   "secret": "myscret",
   "is_active": true
}
 


6. Atualizar campos de uma rule set do Edge Firewall

Atualiza um ou mais campos de uma rule set do Edge Firewall, preservando o valor dos campos não informados.

PATCH /edge_firewall/rulesets/:ruleset_id

Permissão necessária: Edit Security Settings

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)

A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf

header string
Content-Type

(obrigatório)

O tipo de codificação utilizada no Body (application/json).

ex.:

Content-Type: application/json

header string
:ruleset_id

(obrigatório)

Id da rule set de Edge Firewall a ser atualizada.
Para obter o Id de uma rule set do Edge Firewall, consulte a Lista de Rule Sets.
path number
Configuration

(obrigatório)

Devem ser informados um ou mais campos a serem atualizados. Os campos não informados não terão o seu valor alterado.

  • name (string): define o nome da rule set do Edge Firewall.
  • block_access_by_referer (boolean): utilize true para ativar o bloqueio da entrega de conteúdo baseada no HTTP Referrer; ou false para desativar o bloqueio.
  • allow_blank_referer (boolean):  defina o valor de allow_blank_referer como true se desejar permitir a entrega de conteúdo para uma requisição sem Referrer; ou false se desejar bloquear, caso você tenha ativado o bloqueio por HTTP Referrer.
  • accepted_domains (array): caso você tenha ativado o bloqueio por HTTP Referrer, liste os domínios para os quais as requisições devem ser liberadas.
  • geo_block (choice): utilize o valor “whitelist“, para ativar o bloqueio para todos os países, com exceção dos que você listar; “blacklist” para listar apenas os países que deseja bloquear; ou “disabled” para desativar o bloqueio por geo localização.
  • geo_countries (array): caso você tenha ativado geo_block por whitelist ou blacklist, liste os códigos de 3 letras dos países (ISO 3166-1 alpha-3) que deseja liberar ou bloquear, de acordo com sua seleção de geo_block.
  • ip_blocking_rule (choice): utilize o valor “allow_from_all“, para configurar o Edge Firewall para permitir o acesso de todos os IPs, por defaul, e definir uma blacklist no campo ip_blocking_address; ou utilize o valor “deny_from_all”, para bloquer o acesso de todos os IPs, por default, com exceção da whitelist configurada no campo ip_blocking_address.
  • ip_blocking_addresses (array): liste os endereços IP, ou máscaras CIDR, que você bloquear ou liberar. Caso você tenha configurado ip_blocking_rule como “allow_from_all”, este campo funciona como uma blacklist para bloquear os IPs listados; deixe o array vazio, caso não deseje bloquear nenhum endereço. Caso você tenha configurado ip_blocking_rule como “deny_from_all”, este campo funciona como uma whitelist para liberar apenas os IPs listados.
  • require_secure_token (boolean): utilize true para ativar a validação de secure token ou false, para desativar.
  • secret (string): caso tenha ativado a validação de secure token, defina a secret que será utilizada para composição do hash. Caso contrário, utilize null.
  • is_active (boolean): utilze true para ativar a rule set, ou false, para desativá-la.
body json

Exemplo de Requisição

1
2
3
4
5
6
7
8
{
   "accepted_domains": [
      {"url": "*.azion.com"},
      {"url": "*.azion.com.br"},
      {"url":"anotherdomain.com"}
   ]
}
 

Exemplo de Resposta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
   "id": 533,
   "name": "Bloqueio por HTTP Referrer",
   "block_access_by_referer": true,
   "allow_blank_referer": true,
   "geo_block": "disabled",
   "accepted_domains": [
      {"url":"*.azion.com"},
      {"url":"*.azion.com.br"},
      {"url":"anotherdomain.com"}
   ],
   "geo_countries": [],
   "ip_blocking_rule": "allow_from_all",
   "ip_blocking_addresses": [],
   "require_secure_token": false,
   "secret": null,
   "is_active": true
}