Logs requests

Cluster event logs requests

Method Path Description
GET /v1/logs Get cluster events log

Get cluster events log

GET /v1/logs

Get cluster events log.

Required permissions

Permission name
view_logged_events

Request

Example HTTP request

GET /logs?order=desc

Request headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Query parameters

Field Type Description
stime ISO_8601 Start time before which we don't want events. (optional)
etime ISO_8601 End time after which we don't want events. (optional)
order string desc/asc - get events in descending or ascending order. Defaults to asc.
limit integer Maximum number of events to return. (optional)
offset integer Skip offset events before returning first one (useful for pagination). (optional)

Response

Returns a JSON array of events.

Example JSON body

[
  {
    "time": "2014-08-29T11:19:49Z",
    "type": "bdb_name_updated",
    "severity": "INFO",
    "bdb_uid": "1",
    "old_val": "test",
    "new_val": "test123"
  },
  {
    "time": "2014-08-29T11:18:48Z",
    "type": "cluster_bdb_created",
    "severity": "INFO",
    "bdb_uid": "1",
    "bdb_name": "test"
  },
  {
    "time": "2014-08-29T11:17:49Z",
    "type": "cluster_node_joined",
    "severity": "INFO",
    "node_uid": 2
  }
]

Event object

Field Description
time Timestamp when event happened.
type Event type. Additional fields may be available for certain event types.
additional fields Additional fields may be present based on event type.

Status codes

Code Description
200 OK No error
RATE THIS PAGE
Back to top ↑