Documentação de APIs Cloud > CDM > Roteadores

Roteadores

Esta é uma API de cadastro de roteadores. Estes roteadores são vinculados às unidades.

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

Listar roteadores

GET /api/v1/cdm/sites/site_id/routers

API para listagem de roteadores

Exemplo requisição

GET /api/v1/cdm/sites/Az2v9wN7wpZcCSDubwReG/routers 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

{
  "total": 2,
  "routers": [
    {
      "id": "Az2v9wN7wpZcCSDubwReG",
      "name": "Router01",
      "description": "router",
      "mac": "01:02:03:04:05:09",
      "site_id": "AxUBeHPXLcmPv4XZ58utA",
      "group_id": "AxUBdRob2tRLq9sPCfQFG",
      "model_id": "Ave2Zpw4SW67ycZsyaxgp",
      "server_id": "Ay5bZfDwXeP1oFrQYSwAN",
      "wan1": {
        "dhcp": true,
        "network": "10.5.0.0/24",
        "gateway": "10.5.0.1",
        "ip": "10.5.0.2",
        "down": 1024,
        "up": 1024,
        "qos_id": "LaK2Zpw4SW67ycZsyaxgp"
      },
      "wan2": {
        "dhcp": true,
        "network": "10.16.0.0/24",
        "gateway": "10.16.0.1",
        "ip": "10.16.0.3",
        "down": 1024,
        "up": 1024,
        "qos_id": "LaK2Zpw4SW67ycZsyaxgp" 
      },
      "lan": {
        "dhcp": {
          "enabled": true,
          "start": "10.3.0.2",
          "end": "10.3.0.254",
        },
        "network": "10.3.0.0/24",
        "ip": "10.3.0.1"
      },
      "vpn": {
        "qos_id": "LaK2Zpw4SW67ycZsyaxgp"
      },
    },
    {
      "id": "Az34GpMQm9rMqzFy2ZaSc",
      "name": "Router03",
      "description": "router",
      "mac": "01:02:03:04:08:06",
      "model_id": "Ave2Zpw4SW67ycZsyaxgp",
      "group_id": "AxUBdRob2tRLq9sPCfQFG",
      "server_id": "Ay5bZfDwXeP1oFrQYSwAN",
      "site_id": "Az2v9wN7wpZcCSDubwReG",
      "wan1": {
        "dhcp": true,
        "gateway": "10.20.0.1",
        "network": "10.20.0.0/24",
        "ip": "10.20.0.2",
        "up": 1024,
        "down": 1024,
        "qos_id": "P4s2Zpw4SW67ycZsyaxgp"
      },
      "wan2": {
        "dhcp": true,
        "network": "10.10.0.0/24",
        "gateway": "10.10.1.1",
        "ip": "10.10.0.1",
        "up": 1024,
        "down": 1024,
        "qos_id": "P4s2Zpw4SW67ycZsyaxgp",
      },
      "lan": {
          "dhcp": {
            "enabled": true,
            "start": "10.3.2.2",
            "end": "10.3.2.254"
          },
          "network": "10.3.2.0/24",
          "ip": "10.3.2.1"
      },
      "vpn": {
        "qos_id": "P4s2Zpw4SW67ycZsyaxgp"
      },
    }
  ]
}

Buscar um roteador

GET /api/v1/cdm/sites/site_id/routers/id

API para buscar um roteador

Exemplo requisição

GET /api/v1/cdm/sites/Az2v9wN7wpZcCSDubwReG/routers/AIOu5fCL63DkVPaTAjxNG 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": "AxTmXY91958aeEuCL8suQ",
  "name": "Router01",
  "description": "router",
  "mac": "01:02:03:04:05:09",
  "site_id": "AxUBeHPXLcmPv4XZ58utA",
  "group_id": "AxUBdRob2tRLq9sPCfQFG",
  "model_id": "Ave2Zpw4SW67ycZsyaxgp",
  "server_id": "Ay5bZfDwXeP1oFrQYSwAN",
  "wan1": {
    "dhcp": true,
    "network": "10.20.0.0/24",
    "gateway": "10.20.0.1",
    "ip": "10.20.0.2",
    "up": 1024,
    "down": 1024,
    "qos_id": "P4s2Zpw4SW67ycZsyaxgp",
  },
  "wan2": {
    "dhcp": true,
    "network": "10.10.0.0/24",
    "gateway": "10.10.1.1",
    "ip": "10.10.0.1",
    "up": 1024,
    "down": 1024,
    "qos_id": "P4s2Zpw4SW67ycZsyaxgp",
  },
  "lan": {
      "dhcp": {
        "enabled": true,
        "start": "10.3.0.2",
        "end": "10.3.0.254"
      },
      "network": "10.3.0.0/24",
      "ip": "10.3.0.1"
  },
  "vpn": {
    "qos_id": "Bve2Zpw4SW67ycZsyaxgp"
  }
}

Criar um roteador

POST /api/v1/cdm/sites/site_id/routers

API para criação de um roteador

Exemplo requisição

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

{
  "name": "Router03",
  "description": "router",
  "mac": "11:12:13:14:15:19",
  "site_id": "AxUBeHPXLcmPv4XZ58utA",
  "model_id": "Ave2Zpw4SW67ycZsyaxgp",
  "server_id": "Ay5bZfDwXeP1oFrQYSwAN",
  "wan1": {
    "dhcp": true,
    "network": "10.10.0.0/24",
    "gateway": "10.10.0.1",
    "ip": "10.10.0.3",
    "up": 1024,
    "down": 1024,
    "qos_id": "AyGy7sgXWVLTbCJdGnG3W",
  },
  "wan2": {
    "dhcp": true,
    "network": "10.16.0.0/24",
    "gateway": "10.16.0.1",
    "ip": "10.16.0.3",
    "up": 1024,
    "down": 1024,
    "qos_id": "AyGy7sgXWVLTbCJdGnG3W",
  },
  "lan": {
    "dhcp": {
        "enabled": true,
        "start": "10.3.5.2",
        "end": "10.3.5.254"
    },
    "network": "10.3.5.0/24",
    "ip": "10.3.5.1"
  },
  "vpn": {
    "qos_id": "AyGy7sgXWVLTbCJdGnG3W"
  }
}

Exemplo resposta

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

{
  "id": "AzA61uegDuCt6qzw1SzXR",
  "name": "Router03",
  "description": "router",
  "server_id": "Ay5bZfDwXeP1oFrQYSwAN",
  "model_id": "Ave2Zpw4SW67ycZsyaxgp",
  "site_id": "AxUBeHPXLcmPv4XZ58utA",
  "group_id": "AxUBdRob2tRLq9sPCfQFG",
  "mac": "11:12:13:14:15:19",
  "wan1": {
    "dhcp": true,
    "network": "10.10.0.0/24",
    "gateway": "10.10.0.1",
    "ip": "10.10.0.3",
    "up": 1024,
    "down": 1024,
    "qos_id": "AyGy7sgXWVLTbCJdGnG3W",
  },
  "wan2": {
    "dhcp": true,
    "network": "10.16.0.0/24",
    "gateway": "10.16.0.1",
    "ip": "10.16.0.3",
    "up": 1024,
    "down": 1024,
    "qos_id": "AyGy7sgXWVLTbCJdGnG3W",
  },
  "lan": {
    "dhcp": {
        "enabled": true,
        "start": "10.3.5.2",
        "end": "10.3.5.254"
    },
    "network": "10.3.5.0/24",
    "ip": "10.3.5.1"
  },
  "vpn": {
    "qos_id": "AyGy7sgXWVLTbCJdGnG3W"
  }
}

Atualizar um roteador

PUT /api/v1/cdm/sites/site_id/routers/id

API para atualização de um roteador

Exemplo requisição

PUT /api/v1/cdm/sites/Az2v9wN7wpZcCSDubwReG/routers/Az2vFaTMM2SDJftZscqN8 HTTP/1.1
Host: cdm.exemplo.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "description": "UpdateDescription",
}

Exemplo resposta

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

{
  "id": "Az2vFaTMM2SDJftZscqN8",
  "name": "Router03",
  "description": "UpdateDescription",
  "server_id": "Ay5bZfDwXeP1oFrQYSwAN",
  "model_id": "Ave2Zpw4SW67ycZsyaxgp",
  "site_id": "AxUBeHPXLcmPv4XZ58utA",
  "group_id": "AxUBdRob2tRLq9sPCfQFG",
  "mac": "11:12:13:14:15:19",
  "wan1": {
    "dhcp": true,
    "network": "10.10.0.0/24",
    "gateway": "10.10.0.1",
    "ip": "10.10.0.3",
    "up": 1024,
    "down": 1024,
    "qos_id": "AyGy7sgXWVLTbCJdGnG3W"
  },
  "wan2": {
    "dhcp": true,
    "network": "10.16.0.0/24",
    "gateway": "10.16.0.1",
    "ip": "10.16.0.3",
    "up": 1024,
    "down": 1024,
    "qos_id": "AyGy7sgXWVLTbCJdGnG3W"
  },
  "lan": {
    "dhcp": {
        "enabled": true,
        "start": "10.3.5.2",
        "end": "10.3.5.254"
    },
    "network": "10.3.5.0/24",
    "ip": "10.3.5.1"
  },
  "vpn": {
    "qos_id": "AyGy7sgXWVLTbCJdGnG3W"
  }
}

Apagar um roteador

DELETE /api/v1/cdm/sites/site_id/routers/id

API para remoção de um roteador

Exemplo requisição

DELETE /api/v1/cdm/sites/Az2v9wN7wpZcCSDub2wReG/routers/Az2vFaTMM2SDJftZscqN8 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

site_idstring Identificador da unidade a qual o roteador pertence

idstring Identificador do roteador

Requisição

namestringrequerido único Nome do roteador

descriptionstring Descrição do roteador

server_idstringrequerido ID do servidor que será utilizado pelo roteador para realizar uma conexão VPN

model_idstringrequerido ID do modelo que será utilizado pelo roteador

site_idstringrequerido ID da unidade a qual o roteador irá pertencer

macstringrequerido único MAC Address do roteador

wan1 Interface de rede WAN1 do roteador

Esse campo não é obrigatório no momento do cadastro. Se não for informado, o campo wan1.dhcp é criado como True (DHCP habilitado), e os campos wan1.up e wan1.down recebem o valor 1024. Os demais campos da interface WAN1 são criados com o valor vazio

Quando informada a inteface wan1 no momento do cadastro do roteador, os campos necessários para essa interface são:

wan1.dhcpboolean

Indica se o DHCP estará habilitado ou desabilitado na interface de rede WAN1 do roteador

wan1.networkstring

Endereço de rede da interface WAN1 do roteador

Rede deve ser válida

wan1.gatewaystring

Endereço gateway da interface de rede WAN1 do roteador

Gateway deve ser válido

wan1.ipstring

Endereço IP da interface de rede WAN1 do roteador

IP deve ser válido

wan1.upint

Velocidade de upload da interface de rede WAN1 do roteador

Valor Mínimo: 1000
Valor Máximo: 5.000.000

wan1.downint

Velocidade de download da interface de rede WAN1 do roteador

Valor Mínimo: 1000
Valor Máximo: 5.000.000

wan1.qos_idstring

ID do QoS que a interface de rede WAN1 do roteador irá utilizar

wan2

Interface de rede WAN2 do roteador

Esse campo não é obrigatório no momento do cadastro. Se não for informado, o campo wan2.dhcp é criado como True (DHCP habilitado), e os campos wan2.up e wan2.down recebem o valor 1024. Os demais campos da interface WAN2 são criados com o valor vazio

Quando informada a inteface de rede wan2 no momento do cadastro do roteador, os campos necessários para essa interface são:

wan2.dhcpboolean

Indica se o DHCP estará habilitado ou desabilitado na interface de rede WAN2 do roteador

wan2.networkstring

Endereço de rede da interface WAN2 do roteador

Rede deve ser válida

wan2.gatewaystring

Endereço gateway da interface de rede WAN2 do roteador

Gateway deve ser válido

wan2.ipstring

Endereço IP da interface de rede WAN2 do roteador

IP deve ser válido

wan2.upint

Velocidade de upload da interface de rede WAN2 do roteador

Valor Mínimo: 1000
Valor Máximo: 5.000.000

wan2.downint

Velocidade de download da interface de rede WAN2 do roteador

Valor Mínimo: 1000
Valor Máximo: 5.000.000

wan2.qos_idstring

ID do QoS que a interface de rede WAN2 do roteador irá utilizar

lan

Interface de rede LAN do roteador

Esse campo não é obrigatório no momento do cadastro. Se não for informado, os campos lan.dhcp, lan.network e lan.ip são criados de forma automática com base no prefixo da rede do grupo de unidades ao qual o roteador pertence

Quando informada a inteface de rede lan no momento do cadastro do roteador, os campos necessários para essa interface são:

lan.networkstring

Endereço de rede da interface LAN do roteador

Rede deve ser válida

lan.ipstring

Endereço IP da interface de rede LAN do roteador

IP deve ser válido

lan.dhcp.enableboolean

Indica se o DHCP estará habilitado ou desabilitado na interface de rede LAN do roteador

lan.dhcp.startstring

Início da faixa de IP’s do DHCP da interface de rede LAN do roteador

IP deve ser válido
IP deve estar dentro da faixa de ips da rede
Somente é requerido quando o campo dhcp.enabled estiver habilitado

lan.dhcp.endstring

Final da faixa de IP’s do DHCP da interface de rede LAN do roteador

IP deve ser válido
IP deve estar dentro da faixa de ips da rede
Somente é requerido quando o campo dhcp.enabled estiver habilitado

vpn

Interface de rede VPN do roteador

Esse campo não é obrigatório no momento do cadastro. Se não for informado, o campo vpn.qos_id, é criado de forma automática com o valor vazio

Quando informada a inteface de rede vpn no momento do cadastro do roteador, o campo necessário para essa interface é:

vpn.qos_idstring

ID do QoS que a interface de rede VPN do roteador irá utilizar

Resposta

idstring ID do roteador

namestring Nome do roteador

descriptionstring Descrição do roteador

macstring MAC Address do roteador

site_idstring ID da unidade a qual o roteador pertence

group_idstring ID do grupo de unidades ao qual o roteador pertence

model_idstring ID do modelo utilizado pelo roteador

server_idstring ID do servidor utilizado pelo roteador para realizar uma conexão VPN

wan1.dhcpboolean Indica se o DHCP está habilitado ou desabilitado na interface de rede WAN1 do roteador

wan1.networkstring Endereço de rede da interface WAN1 do roteador

wan1.gatewaystring Endereço gateway da interface de rede WAN1 do roteador

wan1.ipstring Endereço IP da interface de rede WAN1 do roteador

wan1.upint Velocidade de *upload* da interface de rede WAN1 do roteador

wan1.downint Velocidade de *download* da interface de rede WAN1 do roteador

wan1.qos_idstring ID do QoS que a interface de rede WAN1 do roteador utiliza

wan2.dhcpboolean Indica se o DHCP está habilitado ou desabilitado na interface de rede WAN2 do roteador

wan2.networkstring Endereço de rede da interface WAN2 do roteador

wan2.gatewaystring Endereço gateway da interface de rede WAN2 do roteador

wan2.ipstring Endereço IP da interface de rede WAN2 do roteador

wan2.upint Velocidade de *upload* da interface de rede WAN2 do roteador

wan2.downint Velocidade de *download* da interface de rede WAN2 do roteador

wan2.qos_idstring ID do QoS que a interface de rede WAN2 do roteador utiliza

lan.networkstring Endereço de rede da interface LAN do roteador

lan.ipstring Endereço IP da interface de rede LAN do roteador

lan.dhcp.enableboolean Indica se o DHCP está habilitado ou desabilitado na interface de rede LAN do roteador

lan.dhcp.startstring Início da faixa de IP's do DHCP da interface de rede LAN do roteador

lan.dhcp.endstring Final da faixa de IP's do DHCP da interface de rede LAN do roteador

vpn.qos_idstring ID do QoS que a interface de rede VPN do roteador utiliza