Notificações do sistema

Esta é uma API de notificações do usuário.

Listar notificações do usuário

API de listagem de notificações do usuário

GET /api/notifications

Exemplo de requisição

GET /api/notifications
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

pages = sdk.alerts.get_notifications()
response = pages.next()
print(response.payload)

const response = await sdk.alerts.getNotifications();
console.log(response.payload);

Exemplo de resposta

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

{
  "notifications": [
    {
      "id": 1,
      "datetime": "2017-10-05T12:20:02.932000+00:00",
      "msg_id": "error_restarting_instance",
      "type": "error",
      "module": "openvpn",
      "target_type": "instance",
      "target_desc": "instance-01",
      "target_id": 4
    },
    {
      "id": 2,
      "datetime": "2017-10-05T12:20:02.932000+00:00",
      "msg_id": "service_restarted",
      "type": "success",
      "module": "openvpn",
      "target_type": null,
      "target_desc": "Openvpn service",
      "target_id": null
    },
  ],
}

[
  Notification(
    id=1,
    datetime="2017-10-05T12:20:02.932000+00:00",
    msg_id="error_restarting_instance",
    type="error",
    module="openvpn",
    target_type="instance",
    target_desc="instance-01",
    target_id=4
  ),
  Notification(
    id=2,
    datetime="2017-10-05T12:20:02.932000+00:00",
    msg_id="service_restarted",
    type="success",
    module="openvpn",
    target_type=None,
    target_desc="Openvpn service",
    target_id=None
  )
]

[
  {
    id: 1,
    datetime: "2017-10-05T12:20:02.932000+00:00",
    msgId: "error_restarting_instance",
    type: "error",
    module: "openvpn",
    targetType: "instance",
    targetDesc: "instance-01",
    targetId: 4
  },
  {
    id: 2,
    datetime: "2017-10-05T12:20:02.932000+00:00",
    msgId: "service_restarted",
    type: "success",
    module: "openvpn",
    targetType: null,
    targetDesc: "Openvpn service",
    targetId: null
  }
];

Excluir uma notificação

API de exclusão de uma notificação em específico do usuário.

DELETE /api/notifications/id

Exemplo de requisição

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

response = sdk.alerts.delete_notification(id=1)

const response = sdk.alerts.deleteNotification({ id: 1 });

Exemplo de resposta

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

Excluir todas as notificações

API de exclusão de todas as notificações do usuário

DELETE /api/notifications

Exemplo de requisição

DELETE /api/notifications HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

response = sdk.alerts.delete_notifications()

const response = sdk.alerts.deleteNotification();

Exemplo de resposta

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

Formato dos dados

Resposta

Campo Descrição
id string

Identificador da notificação.
datetime string

Data/Hora da notificação.

Formato: ISO-8601
msg_id string

Identificador do tipo de mensagem da notificação.

Utilizado para tradução da mensagem da notificação.
type string

Tipo da notificação que será gerada.

Enum: info, success, warning, error
module string

Módulo/Produto onde o evento ocorreu.

Exemplos: auth, firewall
target_type string

Tipo do item relacionado ao evento.

Pode ser nulo se o evento for do módulo/produto como um todo.

Exemplos: user, rules.forward
target_desc string

Descrição/Nome do alvo do evento.

Pode ser nulo se o evento for do módulo/produto como um todo.

Dependendo do elemento relacionado ao evento, pode ser o nome do mesmo (ex.: nome de um usuário) ou a descrição (ex.: descrição de uma regra de firewall).
target_id string

Identificador do item relacionado ao evento.

Pode ser nulo se o evento for do módulo/produto como um todo.

Exemplos: "1", "iface:1"