Regras de Entrada

Esta é uma API de cadastro de regras de entrada do roteador.

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

Buscar uma regra de entrada

GET /api/v1/cdm/routers/router_id/fw/in/rules/id

API para buscar uma regra de entrada do roteador

Exemplo requisição

GET /api/v1/cdm/routers/AyUHTfrYDw3Yp6W9m3ppC/fw/in/rules/Aoyc5feKgmFGhgESFupoL HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

Exemplo resposta

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

{
  "id": "Aoyc5feKgmFGhgESFupoL",
  "rules_group_id": "Aoyc5feKgmFGhgESF5d2f",
  "description": "Regra 01",
  "source_ip": "192.168.16.1",
  "original_dest_ip": "203.50.3.21",
  "translated_dest_ip": "192.168.1.1",
  "external_port": 80,
  "internal_port": 80,
  "protocol": "tcp",
  "priority": 1,
}

Dados para criação de uma nova regra de entrada

GET /api/v1/cdm/routers/router_id/fw/in/rules/new

API de busca de dados necessários para criação de uma regra de entrada do roteador

Exemplo requisição

GET /api/v1/cdm/routers/AyUHTfrYDw3Yp6W9m3ppC/fw/in/rules/new HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

Exemplo resposta

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

{
  "rules_groups": [
    {
      "id": "AyUKCnMcDYhYQzUz1MHp7",
      "name": "Grupo01"
    },
    {
      "id": "AyUKDTkbRaStLrsRUodVk",
      "name": "Grupo02"
    },
    {
      "id": "AyUKDtevfEmBi1tG99Hv3",
      "name": "Grupo03"
    },
  ]
}

Criar uma regra de entrada

POST /api/v1/cdm/routers/router_id/fw/in/rules

API para criação de uma nova regra de entrada do roteador

Exemplo requisição

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

{
  "rules_group_id": "Aoyc5feKgmFGhgESF5d2f",
  "description": "Regra 05",
  "source_net": "192.168.1.0/24",
  "original_dest_net": "203.50.3.0/28",
  "translated_dest_ip": "192.168.16.1",
  "port_range": {
    "start": 3000,
    "end": 3500,
  },
  "protocol": "tcp-udp",
  "priority": 5,
}

Exemplo resposta

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

{
  "id": "AyUJUnsgV8FPifMrGRLwx",
  "rules_group_id": "Aoyc5feKgmFGhgESF5d2f",
  "description": "Regra 05",
  "source_net": "192.168.1.0/24",
  "original_dest_net": "203.50.3.0/28",
  "translated_dest_ip": "192.168.16.1",
  "port_range": {
    "start": 3000,
    "end": 3500,
  },
  "protocol": "tcp-udp",
  "priority": 5,
}

Atualizar uma regra de entrada

PUT /api/v1/cdm/routers/router_id/fw/in/rules/id

API para atualização de uma regra de entrada do roteador

Exemplo requisição

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

{
  "priority": 9
}

Exemplo resposta

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

{
  "id": "AyUJUnsgV8FPifMrGRLwx",
  "rules_group_id": "Aoyc5feKgmFGhgESF5d2f",
  "description": "Regra 05",
  "source_net": "192.168.1.0/24",
  "original_dest_net": "203.50.3.0/28",
  "translated_dest_ip": "192.168.16.1",
  "port_range": {
    "start": 3000,
    "end": 3500,
  },
  "protocol": "tcp-udp",
  "priority": 9,
}

Apagar uma regra de entrada

DELETE /api/v1/cdm/routers/router_id/fw/in/rules/id

API para apagar uma regra de entrada do roteador

Exemplo requisição

DELETE /api/v1/cdm/routers/AyUHTfrYDw3Yp6W9m3ppC/fw/in/rules/AyUJUnsgV8FPifMrGRLwx HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

Exemplo resposta

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

Formato dos dados

Parâmetros da url

idstring Identificador da regra de entrada do roteador
router_idstring Identificador do roteador ao qual a regra de entrada pertence

Requisição

rules_group_idstringrequerido Grupo de regras ao qual a regra de entrada do roteador pertence
descriptionstringrequerido único Descrição sobre a regra de entrada do roteador
prioritystringrequerido Prioridade da regra de entrada do roteador Valor mínimo: 1
Valor máximo: 99
protocolstringrequerido Protocolo sobre o qual a regra de entrada do roteador atua Protocolos possíveis: * tcp * udp * tcp/udp * ip * icmp * pptp * ipsec

Os protocos TCP, UDP e TCP/UDP estão associados a utilização de portas. Dessa forma, ao cadastrar uma regra de entrada utilizando esses protocolos, é necessário utilizar uma porta (interna/externa ou faixa de portas)

A regra de entrada do roteador pode ser aplicada sobre portas específicas (internal_port e external_port) ou sobre uma faixa de portas (port_range)

ATENÇÃO: a regra de entrada do roteador pode ter somente uma das formas preenchida

internal_portinteger

Porta interna para a qual a regra de entrada do roteador será aplicada

Valor mínimo: 1
Valor máximo: 65000

OBS: Se o campo internal_port estiver preenchido, o campo external_port deve, obrigatoriamente, estar preenchido também

external_portinteger

Porta externa para a qual a regra de entrada do roteador será aplicada

Valor mínimo: 1
Valor máximo: 65000

OBS: Se o campo external_port estiver preenchido, o campo internal_port deve, obrigatoriamente, estar preenchido também

port_range.startinteger

Início da faixa de portas para a qual a regra de entrada do roteador será aplicada

Valor mínimo: 1
Valor máximo: 65000

OBS: Se o campo start estiver preenchido, o campo end deve, obrigatoriamente, estar preenchido também

port_range.endinteger

Final da faixa de portas para a qual a regra de entrada do roteador será aplicada

Valor mínimo: 1
Valor máximo: 65000

OBS: Se o campo end estiver preenchido, o campo start deve, obrigatoriamente, estar preenchido também

A regra de entrada do roteador será aplicada sobre uma origem que pode ser definida de três formas: como um endereço único (source_ip), uma rede (source_net) ou todos os endereços (source_any=true)

ATENÇÃO: a regra de entrada deve ter somente uma das formas de origem preenchida

source_anyboolean

A regra de entrada do roteador será aplicada para todas as origens

Valor padrão: false

source_ipstring

IP de origem para o qual a regra de entrada do roteador será aplicada

Exemplo: 192.168.0.5

source_netstring

Rede de origem para a qual a regra de entrada do roteador será aplicada

Exemplo: 192.168.0.0/24

A regra de entrada do roteador será aplicada sobre um destino original, que pode ser definido de duas formas: como um endereço de destino original (original_dest_ip) ou uma rede de destino original (original_dest_net)

ATENÇÃO: a regra de entrada deve ter somente uma das formas de destino original preenchida

original_dest_ipstring

IP de destino original para o qual a regra de entrada do roteador será aplicada

Exemplo: 203.50.3.21

original_dest_netstring

Rede de destino original para a qual a regra de entrada do roteador será aplicada

Exemplo: 192.168.1.1

translated_dest_ipstringrequerido

IP de destino final para o qual a regra de entrada do roteador será aplicada

Exemplo: 192.168.1.1

Resposta

idstring Identificador da regra de entrada do roteador
rules_group_idstring Grupo de regras ao qual a regra de entrada do roteador pertence
descriptionstring Descrição sobre a regra de entrada do roteador
prioritystring Prioridade da regra de entrada do roteador
protocolstring Protocolo sobre o qual a regra de entrada do roteador atua Protocolos possíveis: * tcp * udp * tcp/udp * ip * icmp * pptp * ipsec
internal_portinteger Porta interna para a qual a regra de entrada do roteador será aplicada
external_portinteger Porta externa para a qual a regra de entrada do roteador será aplicada
port_range.startinteger Início da faixa de portas para a qual a regra de entrada do roteador será aplicada
port_range.endinteger Final da faixa de portas para a qual a regra de entrada do roteador será aplicada
source_anyboolean A regra de entrada do roteador será aplicada para todas as origens
source_ipstring IP de origem para o qual a regra de entrada do roteador será aplicada
source_netstring Rede de origem para a qual a regra de entrada do roteador será aplicada
original_dest_ipstring IP de destino original para o qual a regra de entrada do roteador será aplicada
original_dest_netstring Rede de destino original para a qual a regra de entrada do roteador será aplicada
translated_dest_ipstring IP de destino final para o qual a regra de entrada do roteador será aplicada
rules_groupsarray<object> Grupos de regras de entrada que pertencem ao roteador