Através da API do Content Delivery você pode consultar, remover ou atualizar suas configurações existentes, bem como criar novas configurações de Content Delivery. Para Rules Engine, utilize os endpoints que seguem.

  1. Consulta lista de regras do Rules Engine
  2. Consulta dados de uma regra do Rules Engine
  3. Deletar uma regra do Rules Engine
  4. Criar uma nova regra do Rules Engine
  5. Sobrescrever uma regra do Rules Engine
  6. Atualizar campos de uma regra do Rules Engine

1. Consulta lista de regras do Rules Engine

Retorna a lista de regras do Rules Engine de uma configuração de Content Delivery.

GET /content_delivery/configurations/:conf_id/rules_engine

Permissão necessária: View Content Delivery

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
:conf_id

(obrigatório)

 Id da configuração de Content Delivery a ser consultada.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
 path  number

Exemplo de Requisição

Exemplo de Resposta


2. Consulta dados de uma regra do Rules Engine

Retorna dados de uma regra do Rules Engine de uma configuração de Content Delivery.

GET /content_delivery/configurations/:conf_id/rules_engine/:rule_id

Permissão necessária: View Content Delivery

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
:conf_id

(obrigatório)

Id da configuração de Content Delivery a ser consultada.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
path number
:rule_id

(obrigatório)

Id da regra de Rules Engine a ser consultada.
Para obter o Id de uma origem, consulte a Lista de Rules Engine.
path number

Exemplo de Requisição

Exemplo de Resposta


3. Deletar uma regra do Rules Engine

Remove uma regra do Rules Engine de uma configuração de Content Delivery.

DELETE /content_delivery/configurations/:conf_id/rules_engine/:rule_id

Permissão necessária: Edit Content Delivery

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
:conf_id

(obrigatório)

Id da configuração de Content Delivery que possui a regra que será removida.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
path number
:rule_id

(obrigatório)

Id da regra de Rules Engine a ser removida.
Para obter o Id de uma regra do Rules Engine, consulte a Lista de Rules Engine.
 path number

Exemplo de Requisição

Exemplo de Resposta


4. Criar uma nova regra do Rules Engine

Cria uma nova regra do Rules Engine em uma configuração de Content Delivery.

POST /content_delivery/configurations/:conf_id/rules_engine

Permissão necessária: Edit Content Delivery

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
:conf_id

(obrigatório)

Id da configuração de Content Delivery para a qual a regra do Rules Engine deve ser criada.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
path number
Configuration

(obrigatório)

A regra que se deseja criar deve ser enviada codificada no formato json com os seguintes campos obrigatórios:

  • path (string): o caminho ou URI para a qual a regra deve ser aplicada. Pode ser utilizada regex para especificar o caminho.
  • regex (boolean): define se o caminho especificado no campo “path deve ser tratado como string. Atribua o valor false para tratar o campo “path” como string e o valor true para tratá-lo como regex.
  • protocol_policy (string): atribua o valor “http“, caso o seu conteúdo seja entregue apenas por HTTP, “http,https” para configurar a entrega utilizando esses dois protocolos, ou o valor “redirect_to_https“, se desejar configurar redirecionamento 301 de todas as requisições HTTP para as respectivas URLs em HTTPS.
  • behavior (string): utilize os valores “delivery“, para definir o comportamento de proxy e cache; “redirect“, para informar uma URL para a qual o conteúdo deve ser redirecionado com status code 301; “access_denied“, para bloquear incondicionalmente o acesso a uma página com status code 403; “acceleration” (requer produto Application Acceleration) para utilizar qualquer funcionalidade de aceleração de aplicações;  “image_optimization“, para utilizar qualquer funcionalidade de optimização ou manipulação de imagens.
  • path_origin_id (number): o id da origem cadastrada na configuração de Content Delivery. Para obter o id das configurações, consulte a Lista de Origens.

E os seguintes campos opcionais:

  • gzip (boolean): utilize o valor true para ativar a compressão gzip, ou false, para desativá-la.
  • redirect_to (string): utilizado em conjunto com o behavior “redirect” para definir a URL de destino. Utilize o valor vazio (“”) para outros behaviors, que não o “redirect“.
  • forward_cookies (choice): utilizado em conjunto com o behavior “acceleration” para definir se os cookies devem ser transmitidos para sua origem ou se devem ser filtrados. Utilize o valor “all” para transmitir os cookies para a origem, ou “none” para filtrá-los.
  • waf_rule_set_id (number): o id da rule set do WAF. Para obter o id das rule sets, consulte a Lista de Rule Sets do WAF. Utilize o valor null para definir que nenhuma rule set de WAF deve ser atribuída a esse path.
  • edge_firewall_id (number): o id da rule set do Edge Firewall. Para obter o id das rule sets, consulte a Lista de Rule Sets do Edge Firewall. Utilize o valor null para definir que nenhuma rule set do Edge Firewall deve ser atribuída a esse path.
  • cache_settings_id (number): o id da Cache Setting que você deseja associar a esse path. Para obter o id da Cache Settings, consulte a Lista de Cache Settings. Utilize o valor null para configurar a entrega de objetos respeitando os headers de cache enviados por sua origem.
body json

Exemplo de Requisição

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
   "path": "/mypath",
   "regex": false,
   "protocol_policy": "http,https",
   "behavior": "delivery",
   "gzip": true,
   "redirect_to": "",
   "path_origin_id": 1017,
   "forward_cookies": "none",
   "waf_rule_set_id": null,
   "edge_firewall_id": null,
   "cache_settings_id": null
}
 

Exemplo de Resposta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
   "id": 2460,
   "path": "/mypath",
   "regex": false,
   "protocol_policy": "http,https",
   "behavior": "delivery",
   "gzip": true,
   "redirect_to": "",
   "path_origin_id": 1017,
   "forward_cookies": "none",
   "waf_rule_set_id": null,
   "edge_firewall_id": null,
   "cache_settings_id": null
}
 


5. Sobrescrever uma regra do Rules Engine

Sobrescreve todos os campos de uma regra do Rules Engine, 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 da configuração sem alterar o valor dos demais.

PUT /content_delivery/configurations/:conf_id/rules_engine/:rule_id

Permissão necessária: Edit Content Delivery

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
:conf_id

(obrigatório)

Id da configuração de Content Delivery para a qual a regra do Rules Engine deve ser substituída.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
path number
:rule_id

(obrigratório)

Id da regra de Rules Engine a ser sobrescrita.
Para obter o Id de uma regra do Rules Engine, consulte a Lista de Rules Engine.
path number
Configuration

(obrigatório)

Os novos valores de cada campo da configuração. Os campos não preenchidos serão substituídos pelo valor default. Se você desejar alterar apenas um dos campos, utilize o método PATCH ao invés do PUT.

  • path (string): o caminho ou URI para a qual a regra deve ser aplicada. Pode ser utilizada regex para especificar o caminho.
  • regex (boolean): define se o caminho especificado no campo “path deve ser tratado como string. Atribua o valor false para tratar o campo “path” como string e o valor true para tratá-lo como regex.
  • protocol_policy (string): atribua o valor “http“, caso o seu conteúdo seja entregue apenas por HTTP, “http,https” para configurar a entrega utilizando esses dois protocolos, ou o valor “redirect_to_https“, se desejar configurar redirecionamento 301 de todas as requisições HTTP para as respectivas URLs em HTTPS.
  • behavior (string): utilize os valores “delivery“, para definir o comportamento de proxy e cache; “redirect“, para informar uma URL para a qual o conteúdo deve ser redirecionado com status code 301; “access_denied“, para bloquear incondicionalmente o acesso a uma página com status code 403; “acceleration” (requer produto Application Acceleration) para utilizar qualquer funcionalidade de aceleração de aplicações;  “image_optimization“, para utilizar qualquer funcionalidade de optimização ou manipulação de imagens.
  • gzip (boolean): utilize o valor true para ativar a compressão gzip, ou false, para desativá-la.
  • redirect_to (string): utilizado em conjunto com o behavior “redirect” para definir a URL de destino. Utilize o valor vazio “” para outros behaviors, que não o “redirect“.
  • path_origin_id (number): o id da origem cadastrada na configuração de Content Delivery. Para obter o id das configurações, consulte a Lista de Origens.
  • forward_cookies (choice): utilizado em conjunto com o behavior “acceleration” para definir se os cookies devem ser transmitidos para sua origem ou se devem ser filtrados. Utilize o valor “all” para transmitir os cookies para a origem, ou “none” para filtrá-los.
  • waf_rule_set_id (number): o id da rule set do WAF. Para obter o id das rule sets, consulte a Lista de Rule Sets do WAF. Utilize o valor null para definir que nenhuma rule set de WAF deve ser atribuída a esse path.
  • edge_firewall_id (number): o id da rule set do Edge Firewall. Para obter o id das rule sets, consulte a Lista de Rule Sets do Edge Firewall. Utilize o valor null para definir que nenhuma rule set de Edge Firewall deve ser atribuída a esse path.
  • cache_settings_id (number): o id da Cache Setting que você deseja associar a esse path. Para obter o id da Cache Settings, consulte a Lista de Cache Settings. Utilize o valor null para configurar a entrega de objetos respeitando os headers de cache enviados por sua origem.
body json

Exemplo de Requisição

1
2
3
4
5
6
7
8
{
   "path": "/mypath",
   "regex": false,
   "protocol_policy": "http,https",
   "behavior": "redirect",
   "redirect_to": "https://mydomain.com/newpath"
}
 

Exemplo de Resposta

1
2
3
4
5
6
7
8
9
{
   "id": 2460,
   "path": "/mypath",
   "regex": false,
   "protocol_policy": "http,https",
   "behavior": "redirect",
   "redirect_to": "https://mydomain.com/newpath"
}
 


6. Atualizar campos de uma regra do Rules Engine

Atualiza um ou mais campos de uma regra do Rules Engine de uma configuração de Content Delivery, preservando o valor dos campos não informados.

PATCH /content_delivery/configurations/:conf_id/rules_engine/:rule_id

Permissão necessária: Edit Content Delivery

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
:conf_id

(obrigatório)

Id da configuração de Content Delivery para a qual a regra do Rules Engine deve ser atualizada.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
path number
:rule_id

(obrigatório)

Id da regra de Rules Engine a ser atualizada.
Para obter o Id de uma regra do Rules Engine, consulte a Lista de Rules Engine.
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.

  • path (string): o caminho ou URI para a qual a regra deve ser aplicada. Pode ser utilizada regex para especificar o caminho.
  • regex (boolean): define se o caminho especificado no campo “path deve ser tratado como string. Atribua o valor false para tratar o campo “path” como string e o valor true para tratá-lo como regex.
  • protocol_policy (string): atribua o valor “http“, caso o seu conteúdo seja entregue apenas por HTTP, “http,https” para configurar a entrega utilizando esses dois protocolos, ou o valor “redirect_to_https“, se desejar configurar redirecionamento 301 de todas as requisições HTTP para as respectivas URLs em HTTPS.
  • behavior (string): utilize os valores “delivery“, para definir o comportamento de proxy e cache; “redirect“, para informar uma URL para a qual o conteúdo deve ser redirecionado com status code 301; “access_denied“, para bloquear incondicionalmente o acesso a uma página com status code 403; “acceleration” (requer produto Application Acceleration) para utilizar qualquer funcionalidade de aceleração de aplicações;  “image_optimization“, para utilizar qualquer funcionalidade de optimização ou manipulação de imagens.
  • gzip (boolean): utilize o valor true para ativar a compressão gzip, ou false, para desativá-la.
  • redirect_to (string): utilizado em conjunto com o behavior “redirect” para definir a URL de destino. Utilize o valor vazio (“”) para outros behaviors, que não o “redirect“.
  • path_origin_id (number): o id da origem cadastrada na configuração de Content Delivery. Para obter o id das configurações, consulte a Lista de Origens.
  • forward_cookies (choice): utilizado em conjunto com o behavior “acceleration” para definir se os cookies devem ser transmitidos para sua origem ou se devem ser filtrados. Utilize o valor “all” para transmitir os cookies para a origem, ou “none” para filtrá-los.
  • waf_rule_set_id (number): o id da rule set do WAF. Para obter o id das rule sets, consulte a Lista de Rule Sets do WAF. Utilize o valor null para definir que nenhuma rule set de WAF deve ser atribuída a esse path.
  • edge_firewall_id (number): o id da rule set do Edge Firewall. Para obter o id das rule sets, consulte a Lista de Rule Sets do Edge Firewall. Utilize o valor null para definir que nenhuma rule set de Edge Firewall deve ser atribuída a esse path.
  • cache_settings_id (number): o id da Cache Setting que você deseja associar a esse path. Para obter o id da Cache Settings, consulte a Lista de Cache Settings. Utilize o valor null para configurar a entrega de objetos respeitando os headers de cache enviados por sua origem.
body json

Exemplo de Requisição

1
2
3
4
5
6
{
   "behavior": "delivery",
   "path_origin_id": 1017,
   "cache_settings_id": 706
}
 

Exemplo de Resposta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
   "id": 2460,
   "path": "/mypath",
   "regex": false,
   "protocol_policy": "http,https",
   "behavior": "delivery",
   "gzip": true,
   "redirect_to": "",
   "path_origin_id": 1017,
   "forward_cookies": "none",
   "waf_rule_set_id": null,
   "edge_firewall_id": null,
   "cache_settings_id": 706
}