Grupos de Regras

Esta é uma API de cadastro de grupos de regras. Os grupos de regras de firewall podem estar vinculados aos roteadores ou aos grupos de unidades.

Esta API é autenticada usando OAuth2, ver documentação de autenticação

Listar grupos

GET /api/v1/cdm/routers/router_id/fw/rule_type/rules-groups

API para listar grupos de regras do roteador

Exemplo requisição

GET /api/v1/cdm/routers/Aoyc5feKgmFGhgESFuaoL/fw/out/rules-groups HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>
GET /api/v1/cdm/groups/group_id/fw/rule_type/rules-groups

API para listar grupos de regras do grupo de unidades

Exemplo requisição

GET /api/v1/cdm/groups/Az2UVtjQjme78S4RC6JnL/fw/out/rules-groups HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

Exemplo resposta

A resposta da API terá a mesma estrutura para os grupos de regras associados aos roteadores ou aos grupos de unidades

HTTP/1.1 200 OK
Content-Type: application/json

{
  "rules_groups": [
    {
      "id": "FaDc5feKgmFGhgESFuaoa",
      "name": "Grupo01",
      "priority": 3,
      "rules": []
    }
  ]
}

Buscar um grupo

GET /api/v1/cdm/routers/router_id/fw/rule_type/rules-groups/id

API para buscar um grupo de regras do roteador

Exemplo requisição

GET /api/v1/cdm/routers/Az2VFVWuwDXMo1XZPDvBZ/fw/snat/rules-groups/Az2VEbTkUTV1fVvk7KXtn HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>
GET /api/v1/cdm/groups/group_id/fw/rule_type/rules-groups/id

API para buscar um grupo de regras do grupo de unidades

Exemplo requisição

GET /api/v1/cdm/routers/Az2VHYT8u2moGdPwKsRRB/fw/out/rules-groups/FaDc5feKgmFGhgESFuaoa HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

Exemplo resposta

A resposta da API terá a mesma estrutura para os grupos de regras associados aos roteadores ou aos grupos de unidades

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "FaDc5feKgmFGhgESFuaoa",
  "name": "Grupo01",
  "priority": 3,
  "rules": []
}

Criar um grupo

POST /api/v1/cdm/routers/router_id/fw/rule_type/rules-groups

API para criação de um novo grupo de regras do roteador

Exemplo requisição

POST /api/v1/cdm/routers/Df6PLfeKgmFGhgESFuaoL/fw/policy-routing/rules-groups HTTP/1.1
Host: cdm.exemplo.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "name": "Group01",
  "priority": 5
}
POST /api/v1/cdm/groups/group_id/fw/rule_type/rules-groups

API para criação de um novo grupo de regras do grupo de unidades

Exemplo requisição

POST /api/v1/cdm/groups/Az2VdcD4CbFoAZT577xYf/fw/out/rules-groups HTTP/1.1
Host: cdm.exemplo.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "name": "Group02",
  "priority": 10
}

Exemplo resposta

A resposta da API terá a mesma estrutura para os grupos de regras associados aos roteadores ou aos grupos de unidades

HTTP/1.1 202 Accepted
Content-Type: application/json

{
  "id": "Aoyc5feKgmFGhgESFupoi",
  "name": "Group02",
  "priority": 10
}

Atualizar grupo

PUT /api/v1/cdm/routers/router_id/fw/rule_type/rules-groups/id

API para atualização de um grupo de regras do roteador

Exemplo requisição

PUT /api/v1/cdm/routers/Aoyc5feKgmFGhgESFuaoL/fw/in/rules-groups/AIjVOqqDRoHhLijSo31kV HTTP/1.1
Host: cdm.exemplo.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "priority": 25
}
PUT /api/v1/cdm/groups/group_id/fw/rule_type/rules-groups/id

API para atualização de um grupo de regras do grupo de unidades

Exemplo requisição

PUT /api/v1/cdm/groups/Az2VtFEjGAATqbCicgprt/fw/policy-routing/rules-groups/FaDc5feKgmFGhgESFuaoa HTTP/1.1
Host: cdm.exemplo.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "priority": 5
}

Exemplo resposta

A resposta da API terá a mesma estrutura para os grupos de regras associados aos roteadores ou aos grupos de unidades

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "FaDc5feKgmFGhgESFuaoa",
  "name": "Group-Policy-new",
  "priority": 5
}

Apagar grupo

DELETE /api/v1/cdm/routers/router_id/fw/rule_type/rules-groups/id

API para apagar um grupo de regras do roteador

Exemplo requisição

DELETE /api/v1/cdm/routers/Aoyc5feKgmFGhgESFuaoL/fw/in/rules-groups/AiDc5J2B4cZ1eamsuS5t HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>
DELETE /api/v1/cdm/groups/group_id/fw/rule_type/rules-groups/id

API para apagar um grupo de regras do grupo de unidades

Exemplo requisição

DELETE /api/v1/cdm/groups/Ay2WLJz4HE5nPxTNo3Qo8/fw/out/rules-groups/AiDWMS5ZtMWDjT4sBG7jz HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

Exemplo resposta

A resposta da API terá a mesma estrutura para os grupos de regras associados aos roteadores ou aos grupos de unidades

HTTP/1.1 200 OK
Content-Type: application/json

Formato dos dados

Parâmetros da url

idstring Identificador do grupo de regras
rule_typestring Identificador do tipo da regra inclusa no grupo de regras | Tipos de regra válidos para os grupos de regras do roteador | |:-----| | `in` [Regras de entrada](/cdm/in_rules) | | `out` [Regras de saída](/cdm/out_rules) | | `snat` [NAT de origem](/cdm/source_nat_rules) | | `policy-routing` [Políticas de roteamento](/cdm/policy_routing_rules) | | Tipos de regra válidos para os grupos de regras do grupo de unidades | |:-----| | `out` [Regras de saída](/cdm/out_rules) | | `policy-routing` [Políticas de roteamento](/cdm/policy_routing_rules) |
router_idstring Identificador do roteador ao qual o grupo de regras pertence
group_idstring Identificador do grupo de unidades ao qual o grupo de regras pertence

Requisição

namestringrequerido único Nome do grupo de regras
priorityintrequerido Prioridade do grupo de regras

Resposta

idstring Identificador do grupo de regras
namestring Nome do grupo de regras
priorityint Prioridade do grupo de regras
rulesarray<object> Lista de regras que fazem parte do grupo de regras. As regras variam de acordo com o `rule_type` e as documentações podem ser visualizadas em: * [Regras de Entrada](/cdm/in_rules) * [Regras de Saída](/cdm/out_rules) * [NAT de origem](/cdm/source_nat_rules) * [Políticas do roteamento](/cdm/policy_routing_rules)