Regras Classe do Tipo Porta

Esta é uma API de gerenciamento regras de classes do tipo porta.

Listar Regras

API de listagem de regras do tipo porta para uma classe existente.

GET /api/dbc/classes/class_id/rules/port

Exemplo de requisição

GET /api/dbc/classes/1/rules/port HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

response = sdk.dbc.get_port_rules(class_id=1)
print(response.payload)

const response = sdk.dbc.getPortRules({ classId: 1 });
console.log(response.payload);

Exemplo de resposta

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

{
  "port_rules": [
    {
      "id": 1,
      "class_id": 1,
      "protocol": "tcp",
      "port_type": "single",
      "port": "8000",
      "created_at": "2017-10-05T12:20:02.932000+00:00",
      "updated_at": "2017-11-05T12:20:02.932000+00:00",
    },
  ],
}

[
    PortRule(
        id=1,
        class_id=1,
        protocol="tcp",
        port_type="single",
        port="8000",
        created_at=DateTime(2017, 10, 5, 12, 20, 2, tzinfo=Timezone('+00:00')),
        updated_at=DateTime(2017, 10, 5, 12, 20, 2, tzinfo=Timezone('+00:00')),
    ),
]

[
  {
    id: 1,
    classId: 1,
    protocol: "tcp",
    portType: "single",
    port: "8000",
    createdAt: "2017-10-05T15:20:02.000Z",
    updatedAt: "2017-11-05T15:20:02.000Z"
  }
];

Buscar Regra

API de busca de uma regra existente.

GET /api/dbc/classes/class_id/rules/port/id

Exemplo de requisição

GET /api/dbc/classes/1/rules/port/1 HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

response = sdk.dbc.get_port_rule(class_id=1, id=1)
print(response.payload)

const response = sdk.dbc.getPortRule({ classId: 1, id: 1 });
console.log(response.payload);

Exemplo de resposta

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

{
  "id": 1,
  "class_id": 1,
  "protocol": "tcp",
  "port_type": "single",
  "port": "8000",
  "created_at": "2017-10-05T12:20:02.932000+00:00",
  "updated_at": "2017-11-05T12:20:02.932000+00:00",
}

PortRule(
    id=1,
    class_id=1,
    protocol="tcp",
    port_type="single",
    port="8000",
    created_at=DateTime(2017, 10, 5, 12, 20, 2, tzinfo=Timezone('+00:00')),
    updated_at=DateTime(2017, 10, 5, 12, 20, 2, tzinfo=Timezone('+00:00')),
)

{
  id: 1,
  classId: 1,
  protocol: "tcp",
  portType: "single",
  port: "8000",
  createdAt: "2017-10-05T15:20:02.000Z",
  updatedAt: "2017-11-05T15:20:02.000Z",
}

Cadastrar Regra

API de cadastro de uma regra.

POST /api/dbc/classes/class_id/rules/port

Exemplo de requisição

POST /api/dbc/classes/1/rules/port HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "protocol": "tcp",
  "port_type": "single",
  "port": "8000",
  "apply": false,
}

from itflex_sdk.dbc.types import CreatePortRuleRequest

request = CreatePortRuleRequest(
    class_id=1,
    protocol="tcp",
    port_type="single",
    port="8000",
    apply=False,
)
response = sdk.dbc.create_port_rule(request)
print(response.payload)

const rule = sdk.dbc.types.PortRule();
rule.classId = 1;
rule.protocol = "tcp";
rule.portType = "single";
rule.port = "8000";
rule.apply = false;

const response = sdk.dbc.createPortRule(rule);
console.log(response.payload);

Exemplo de resposta

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

{
  "id": 1,
  "class_id": 1,
  "protocol": "tcp",
  "port_type": "single",
  "port": "8000",
  "created_at": "2017-10-05T12:20:02.932000+00:00",
  "updated_at": "2017-11-05T12:20:02.932000+00:00",
}

PortRule(
    id=1,
    class_id=1,
    protocol="tcp",
    port_type="single",
    port="8000",
    created_at=DateTime(2017, 10, 5, 12, 20, 2, tzinfo=Timezone('+00:00')),
    updated_at=DateTime(2017, 10, 5, 12, 20, 2, tzinfo=Timezone('+00:00')),
)

{
  id: 1,
  classId: 1,
  protocol: "tcp",
  portType: "single",
  port: "8000",
  createdAt: "2017-10-05T15:20:02.000Z",
  updatedAt: "2017-11-05T15:20:02.000Z"
}

Editar Regra

API de edição de uma regra existente.

PUT /api/dbc/classes/class_id/rules/port/id

Exemplo de requisição

PUT /api/dbc/classes/1/rules/port/1 HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "protocol": "tcp/udp",
  "port_type": "single",
  "port": "8002",
  "apply": false,
}

from itflex_sdk.dbc.types import UpdatePortRuleRequest

request = UpdatePortRuleRequest(
    id=1,
    class_id=1,
    protocol="tcp/udp",
    port_type="single",
    port="8002",
    apply=False,
)
response = sdk.dbc.update_port_rule(request)
print(response.payload)

const rule = {
  id: 1,
  classId: 1,
  protocol: "tcp/udp",
  portType: "single",
  port: "8002",
  apply: false,
};
const response = sdk.dbc.updatePortRule(rule);
console.log(response.payload);

Exemplo de resposta

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

{
  "id": 1,
  "class_id": 1,
  "protocol": "tcp/udp",
  "port_type": "single",
  "port": "8002",
  "created_at": "2017-10-05T12:20:02.932000+00:00",
  "updated_at": "2017-11-05T12:20:02.932000+00:00",
}

PortRule(
    id=1,
    class_id=1,
    protocol="tcp/udp",
    port_type="single",
    port="8002",
    created_at=DateTime(2017, 10, 5, 12, 20, 2, tzinfo=Timezone('+00:00')),
    updated_at=DateTime(2017, 10, 5, 12, 20, 2, tzinfo=Timezone('+00:00')),
)

{
  id: 1,
  classId: 1,
  protocol: "tcp/udp",
  portType: "single",
  port: "8002",
  createdAt: "2017-10-05T15:20:02.000Z",
  updatedAt: "2017-11-05T15:20:02.000Z"
}

Excluir regra

API de exclusão de uma regra existente.

DELETE /api/dbc/classes/class_id/rules/port/id

Exemplo de requisição

DELETE /api/dbc/classes/1/rules/port/1 HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

response = sdk.dbc.delete_port_rule(class_id=1, id=1)

const response = sdk.dbc.deletePortRule({ classId: 1, id: 1 });

Exemplo de resposta

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

Formato dos dados

Parâmetros da url

Campo Descrição
id int

Idendificador da regra
class_id int

Identificador da classe ao qual a regra pertence

Requisição

Campo Descrição
class_id intrequerido

Identificador da classe ao qual a regra pertence
protocol stringrequerido

Protocolo de rede da regra

Valores possíveis: tcp/udp, tcp, udp
port_type stringrequired

Tipo do valor de porta de rede

Valores possíveis: single, range
port stringrequired único

Porta ou faixa de portas da regra

Porta deve ser única dentro da classe.

Dependendo do valor do campo port_type, este campo deve ser uma única porta ou uma faixa de portas

As portas devem ter um valor entre 1 e 65535

Para faixa de portas, usar o seguinte formato: start:end
exemplo: 3000:3500
apply bool

Flag que indica se as informações serão provisionadas imediatamente após a criação ou edição

Valor padrão: False

Resposta

Campo Descrição
id int

Idendificador da regra
class_id int

Identificador da classe ao qual a regra pertence
protocol string

Protocolo de rede da regra
port_type string

Tipo do valor de porta de rede
port string

Porta ou faixa de portas da regra
created_at string

Data de criação

Formato: ISO-8601
updated_at string

Data da última edição

Formato: ISO-8601