Estas são as APIs para cadastro de políticas de roteamento do roteador e do grupo de unidades
As APIs são autenticadas usando OAuth2, ver documentação de autenticação
router_id
/fw/policy-routing/rules/id
API para buscar uma política de roteamento do roteador
group_id
/fw/policy-routing/rules/id
API para buscar uma política de roteamento do grupo de unidades
GET /api/v1/cdm/routers/AyUHTfrYDw3Yp6W9m3ppC/fw/policy-routing/rules/Aoyc5feKgmFGhgESFupoL HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "Aoyc5feKgmFGhgESFupoL",
"rules_group_id": "Aoyc5feKgmFGhgESF5d2f",
"description": "Policy Routing 01",
"interface": "wan1",
"source_ip": "192.168.16.1",
"dest_any": true,
"protocol": "tcp",
"port": 8080,
"priority": 5
}
router_id
/fw/policy-routing/rules/new
API de busca de dados necessários para criação de uma política de roteamento do roteador
group_id
/fw/policy-routing/rules/new
API de busca de dados necessários para criação de uma política de roteamento do grupo de unidades
GET /api/v1/cdm/groups/BF9HTfrYDw3Yp6W9m3ppC/fw/policy-routing/rules/new HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>
HTTP/1.1 200 OK
Content-Type: application/json
{
"rules_groups": [
{
"id": "AyUKCnMcDYhYQzUz1MHp7",
"name": "Grupo01"
},
{
"id": "AyUKDTkbRaStLrsRUodVk",
"name": "Grupo02"
},
{
"id": "AyUKDtevfEmBi1tG99Hv3",
"name": "Grupo03"
},
]
}
router_id
/fw/policy-routing/rules
API para criação de uma nova política de roteamento do roteador
group_id
/fw/policy-routing/rules
API para criação de uma nova política de roteamento do grupo de unidades
POST /api/v1/cdm/routers/AyUHTfrYDw3Yp6W9m3ppC/fw/policy-routing/rules HTTP/1.1
Host: cdm.exemplo.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <Access-Token>
{
"rules_group_id": "Aoyc5feKgmFGhgESF5d2f",
"description": "Policy Routing 01",
"interface": "wan1",
"source_ip": "192.168.16.1",
"dest_any": true,
"protocol": "tcp",
"port": 8080,
"priority": 5
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "Aoyc5feKgmFGhgESFupoL",
"rules_group_id": "Aoyc5feKgmFGhgESF5d2f",
"description": "Policy Routing 01",
"interface": "wan1",
"source_ip": "192.168.16.1",
"dest_any": true,
"protocol": "tcp",
"port": 8080,
"priority": 5
}
router_id
/fw/policy-routing/rules/id
API para atualização de uma política de roteamento do roteador
group_id
/fw/policy-routing/rules/id
API para atualização de uma política de roteamento do grupo de unidades
PUT /api/v1/cdm/routers/AyUHTfrYDw3Yp6W9m3ppC/fw/policy-routing/rules/Aoyc5feKgmFGhgESFupoL HTTP/1.1
Host: cdm.exemplo.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <Access-Token>
{
"port": 8089,
"priority": 3
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "Aoyc5feKgmFGhgESFupoL",
"rules_group_id": "Aoyc5feKgmFGhgESF5d2f",
"description": "Policy Routing 01",
"interface": "wan1",
"source_ip": "192.168.16.1",
"dest_any": true,
"protocol": "tcp",
"port": 8089,
"priority": 3
}
router_id
/fw/policy-routing/rules/id
API para apagar uma política de roteamento do roteador
group_id
/fw/policy-routing/rules/id
API para apagar uma política de roteamento do grupo de unidades
DELETE /api/v1/cdm/routers/AyUHTfrYDw3Yp6W9m3ppC/fw/policy-routing/rules/AyUJUnsgV8FPifMrGRLwx HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>
HTTP/1.1 200 OK
Content-Type: application/json
Os protocos TCP
, UDP
e TCP/UDP
estão associados a utilização de portas. Dessa forma, ao cadastrar uma política de roteamento utilizando esses protocolos, é necessário utilizar uma porta (port
) ou uma faixa de portas (port_range
)
A política de roteamento pode ser aplicada sobre uma porta específica (port
) ou sobre uma faixa de portas (port_range
)
ATENÇÃO: a política de roteamento pode ter somente uma das formas preenchida
portinteger
Porta para a qual a política de roteamento será aplicada
Valor mínimo: 1
Valor máximo: 65000
port_range.startinteger
Início da faixa de portas para a qual a política de roteamento 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 política de roteamento 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 política de roteamento 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 política de roteamento deve ter somente uma das formas de origem preenchida
source_anyboolean
A política de roteamento será aplicada para todas as origens
Valor padrão: false
source_ipstring
IP de origem para o qual a política de roteamento será aplicada
Exemplo: 192.168.0.5
source_netstring
Rede de origem para a qual a política de roteamento será aplicada
Exemplo: 192.168.0.0/24
A política de roteamento será aplicada sobre um destino, que pode ser definido de três formas: como um endereço único (dest_ip
), uma rede (dest_net
) ou todos os endereços (dest_any=true
)
ATENÇÃO: a política de roteamento deve ter somente uma das formas de destino preenchida
dest_anystring
A política de roteamento será aplicada para todos os destinos
Valor padrão: false
dest_ipstring
IP de destino para o qual a política de roteamento será aplicada
Exemplo: 192.168.0.5
dest_netstring
Rede de destino para o qual a política de roteamento será aplicada
Exemplo: 192.168.16.0/24