v6

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2021-08-19329.6 KB
logs

Retrieve all logs

This will only return Logs that pertain to the current user's tenant. OIH admins can see all logs. The 'filter' query parameter can be used with arbitrary keys beyond those listed here, which will be matched within the events' payload object.

get/logs

Query parameters

page[size]integer

Amount of logs per page returned. Default is 10.

page[number]integer

Number of the page to be returned. Default is 1.

filter[tenant]string

Filter by tenant. Only available to admins.

filter[service]string

Filter by service.

Response

A list of logs.

Example response

{
  "data": [
    {
      "headers": {
        "serviceName": "flow-repository",
        "createdAt": "1564408888",
        "name": "flowrepo.flow.created"
      },
      "payload": {
        "user": "TestUser",
        "tenant": "TestTenant",
        "flowId": "TestFlow"
      }
    }
  ],
  "meta": {
    "page": 1,
    "perPage": 10,
    "total": 1,
    "totalPages": 1
  }
}
All 3 operations