Conexões

Esta é uma API de consulta da abstração das interfaces de rede, dos clientes OpenVPN e das instâncias OpenVPN do servidor.

Listar Conexões

API de listagem de conexões.

GET /api/networks/connections
GET /api/networks/connections?type[]=wan&type[]=lan
GET /api/networks/connections?exlude[]=ovpn-server&exclude[]=ovpn-client

Exemplo de requisição

GET /api/networks/connections?type[]=wan HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

response = sdk.networks.get_connections(type=["wan"])
print(response.payload)

const resp = await sdk.networks.getConnections({"type":["wan"]});
console.log(resp.payload);

Exemplo de resposta

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

{
  "connections": [
    {
      "id": "iface:1",
      "type": "wan",
      "name": "embratel",
      "iface": "conn01",
      "gateway": "192.168.1.1",
      "networks" : ["192.168.1.0/24", "10.5.0.0/16"],
      "created_at": "2018-10-01T12:20:02.932000+00:00",
      "updated_at": "2018-10-01T12:20:02.932000+00:00",
    },
  ],
}

[
  Connection(
    id="iface:1",
    type="wan",
    name="embratel",
    iface="conn01",
    gateway="192.168.1.1",
    networks=["192.168.1.0/24", "10.5.0.0/16"],
    created_at=DateTime(2018, 10, 1, 12, 20, 2, tzinfo=Timezone('+00:00')),
    updated_at=DateTime(2018, 10, 1, 12, 20, 2, tzinfo=Timezone('+00:00'))
  ),
]

[
  {
    id: "iface:1",
    type: "wan",
    name: "embratel",
    iface: "conn01",
    gateway: "192.168.1.1",
    networks: ["192.168.1.0/24", "10.5.0.0/16"],
    createdAt: "2018-10-01T12:20:02Z",
    updatedAt: "2018-10-01T12:20:02Z"
  }
];

Buscar Conexão

API de busca de uma conexão.

GET /api/networks/connections/id

Exemplo de requisição

GET /api/networks/connections/iface:1 HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

response = sdk.networks.get_connection(id="iface:1")
print(response.payload)

const response = await sdk.networks.getConnection({ id: "iface:1" });
console.log(response.payload);

Exemplo de resposta

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

{
  "id": "iface:1",
  "type": "wan",
  "name": "embratel",
  "iface": "conn01",
  "gateway": "192.168.1.1",
  "networks" : ["192.168.1.0/24", "10.5.0.0/16"],
  "created_at": "2018-10-01T12:20:02.932000+00:00",
  "updated_at": "2018-10-01T12:20:02.932000+00:00",
}

Connection(
    id="iface:1",
    type="wan",
    name="embratel",
    iface="conn01",
    gateway="192.168.1.1",
    networks=["192.168.1.0/24", "10.5.0.0/16"],
    created_at=DateTime(2018, 10, 1, 12, 20, 2, tzinfo=Timezone('+00:00')),
    updated_at=DateTime(2018, 10, 1, 12, 20, 2, tzinfo=Timezone('+00:00'))
)

{
  id: "iface:1",
  type: "wan",
  name: "embratel",
  iface: "conn01",
  gateway: "192.168.1.1",
  networks: ["192.168.1.0/24", "10.5.0.0/16"],
  createdAt: "2018-10-01T12:20:02Z",
  updatedAt: "2018-10-01T12:20:02Z"
}

Formato dos dados

Parâmetros da url

Campo Descrição
id string

Idendificador da conexão

Formato: type:id

Onde type representa o tipo da conexão. O valores possíveis de type são:

Exemplo: uma interface de rede com id=1 é representada por iface:1
type array<string>

Filtra conexões pelos tipos informados

Todos os tipos de conexão são retornados caso este parâmetro e o parâmetro exclude não forem informados

Valores possíveis: wan, lan, dmz, guest, ovpn-client, ovpn-server

  • wan, lan, dmz, guest representam interfaces de rede
  • ovpn-client representa clientes OpenVPN
  • ovpn-server representa instâncias OpenVPN
exclude array<string>

Filtro que ignora os tipos de conexões informadas

Este parâmetro é ignorado caso o parâmetro type for informado

Valores possíveis: wan, lan, dmz, guest, ovpn-client, ovpn-server

  • wan, lan, dmz, guest representam interfaces de rede
  • ovpn-client representa clientes OpenVPN
  • ovpn-server representa instâncias OpenVPN

Resposta

Campo Descrição
id string

Identificador da conexão
type string

Tipo da conexão representada

Valores possíveis: wan, lan, dmz, guest, ovpn-client, ovpn-server
name string

Nome da conexão
iface string

Nome da interface de rede física da conexão
gateway string

Gateway da conexão

Obs: Este campo não é retornado para Clientes OpenVPN
networks array<string>

Lista de redes da conexão

Obs: Para clientes OpenVPN uma lista vazia é retornada
created_at string

Data de criação

Formato: ISO-8601
updated_at string

Data da última edição

Formato: ISO-8601