Pular para o conteúdo principal

kobana dashboards events

Comandos de kobana dashboards events. Toda opção global (Opções globais) vale aqui.

ComandoHTTPDescrição
events listGET /v1/eventsListar eventos
events getGET /v1/events/{id}Consultar evento

events list​

Listar eventos

kobana dashboards events list [OPÇÕES]

GET /v1/events

Log de eventos do workspace e da organização, do mais recente ao mais antigo. Eventos são evidência: não podem ser alterados nem excluídos.

Parâmetros de consulta

NomeTipoObrigatórioDescrição
pageintegernãoPágina (começa em 1). Padrão: 1.
per_pageintegernãoItens por página. Padrão: 20. Máximo: 100.
sort_bystringnãoCampo de ordenação. Padrão depende do recurso.
sort_orderstringnãoDireção da ordenação. Padrão: desc. Valores: asc, desc.
typestringnãoTipo exato do evento (ex.: api_key.rotated).
resource_typestringnãoTipo exato do recurso (ex.: api_key).
resource_idstringnãoSomente eventos deste registro.
date_fromstringnãoLimite inferior de created_at (data ou data-hora ISO 8601).
date_tostringnãoLimite superior de created_at (data ou data-hora ISO 8601). Uma data sem hora cobre o dia inteiro (UTC).

Cabeçalhos

NomeTipoObrigatórioDescrição
X-Workspace-IdstringnãoWorkspace em que a chamada atua: o id ou o public_id mostrados em Workspaces no dashboard. Dentro da organização do token, os dados ficam em workspaces. Pode ser omitido enquanto a organização tem um único workspace; com dois ou mais, a falta dele retorna 400 workspace_required. Um workspace que não é da organização retorna 403 unknown_workspace. Com um token de pessoa, só os workspaces a que ela tem acesso (proprietários da organização alcançam todos); os demais retornam 403 workspace_access_denied.

Respostas

HTTPDescrição
200Página de eventos.
400Requisição inválida: corpo malformado, campo obrigatório ausente ou filtro com valor inválido.
404Recurso não encontrado na organização atual.

events get​

Consultar evento

kobana dashboards events get [ID] [OPÇÕES]

GET /v1/events/{id}

Retorna um evento com o payload completo.

Argumentos do caminho: id

Cabeçalhos

NomeTipoObrigatórioDescrição
X-Workspace-IdstringnãoWorkspace em que a chamada atua: o id ou o public_id mostrados em Workspaces no dashboard. Dentro da organização do token, os dados ficam em workspaces. Pode ser omitido enquanto a organização tem um único workspace; com dois ou mais, a falta dele retorna 400 workspace_required. Um workspace que não é da organização retorna 403 unknown_workspace. Com um token de pessoa, só os workspaces a que ela tem acesso (proprietários da organização alcançam todos); os demais retornam 403 workspace_access_denied.

Respostas

HTTPDescrição
200O evento.
404Recurso não encontrado na organização atual.