Retrieving event information (severity)

get /v2/system/events

Returns events based on the parameters provided.

Query parameters

severity String

Event severity (INFO, SEVERE, and WARNING)

Allowed values: INFO WARNING SEVERE

Example: severity_example

user Integer

ID of the user

Example: 56

startTimestamp String

Date and time of the event from when it has to be fetched in the format yyyy-mm-ddThh:mm:ssZ

offset

Example: startTimestamp_example

endTimestamp String

Date and time of the event till when it has to be fetched in the format yyyy-mm-ddThh:mm:ssZ

offset

Example: endTimestamp_example

category String

A category the event falls into, such as user, bucket, KMIP and S3 settings

Example: category_example

eventTypeId Integer

A unique identifier for a specific type of event

Example: 56

pageSize Integer

Number of events to return per page

Example: 56

pageToken String

An encoded token for pagination, to be passed as received to fetch the next page.

Example: pageToken_example

CLIENT REQUEST

          curl -X 'GET'

        -H
        'Accept: application/json'
      
      'http://localhost/v2/system/events?severity=severity_example&user=56&startTimestamp=startTimestamp_example&endTimestamp=endTimestamp_example&category=category_example&eventTypeId=56&pageSize=56&pageToken=pageToken_example'

import http.client

conn = http.client.HTTPConnection("undefinedundefined")

conn.request("GET", "/v2/system/events?severity=SOME_STRING_VALUE&user=SOME_INTEGER_VALUE&startTimestamp=SOME_STRING_VALUE&endTimestamp=SOME_STRING_VALUE&category=SOME_STRING_VALUE&eventTypeId=SOME_INTEGER_VALUE&pageSize=SOME_INTEGER_VALUE&pageToken=SOME_STRING_VALUE")

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'

url = URI("http://undefinedundefined/v2/system/events?severity=SOME_STRING_VALUE&user=SOME_INTEGER_VALUE&startTimestamp=SOME_STRING_VALUE&endTimestamp=SOME_STRING_VALUE&category=SOME_STRING_VALUE&eventTypeId=SOME_INTEGER_VALUE&pageSize=SOME_INTEGER_VALUE&pageToken=SOME_STRING_VALUE")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://undefinedundefined/v2/system/events?severity=SOME_STRING_VALUE&user=SOME_INTEGER_VALUE&startTimestamp=SOME_STRING_VALUE&endTimestamp=SOME_STRING_VALUE&category=SOME_STRING_VALUE&eventTypeId=SOME_INTEGER_VALUE&pageSize=SOME_INTEGER_VALUE&pageToken=SOME_STRING_VALUE");

xhr.send(data);

HttpResponse<String> response = Unirest.get("http://undefinedundefined/v2/system/events?severity=SOME_STRING_VALUE&user=SOME_INTEGER_VALUE&startTimestamp=SOME_STRING_VALUE&endTimestamp=SOME_STRING_VALUE&category=SOME_STRING_VALUE&eventTypeId=SOME_INTEGER_VALUE&pageSize=SOME_INTEGER_VALUE&pageToken=SOME_STRING_VALUE")
  .asString();

import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "http://undefinedundefined/v2/system/events?severity=SOME_STRING_VALUE&user=SOME_INTEGER_VALUE&startTimestamp=SOME_STRING_VALUE&endTimestamp=SOME_STRING_VALUE&category=SOME_STRING_VALUE&eventTypeId=SOME_INTEGER_VALUE&pageSize=SOME_INTEGER_VALUE&pageToken=SOME_STRING_VALUE")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://undefinedundefined/v2/system/events?severity=SOME_STRING_VALUE&user=SOME_INTEGER_VALUE&startTimestamp=SOME_STRING_VALUE&endTimestamp=SOME_STRING_VALUE&category=SOME_STRING_VALUE&eventTypeId=SOME_INTEGER_VALUE&pageSize=SOME_INTEGER_VALUE&pageToken=SOME_STRING_VALUE",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "http://undefinedundefined/v2/system/events?severity=SOME_STRING_VALUE&user=SOME_INTEGER_VALUE&startTimestamp=SOME_STRING_VALUE&endTimestamp=SOME_STRING_VALUE&category=SOME_STRING_VALUE&eventTypeId=SOME_INTEGER_VALUE&pageSize=SOME_INTEGER_VALUE&pageToken=SOME_STRING_VALUE");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("http://undefinedundefined/v2/system/events?severity=SOME_STRING_VALUE&user=SOME_INTEGER_VALUE&startTimestamp=SOME_STRING_VALUE&endTimestamp=SOME_STRING_VALUE&category=SOME_STRING_VALUE&eventTypeId=SOME_INTEGER_VALUE&pageSize=SOME_INTEGER_VALUE&pageToken=SOME_STRING_VALUE");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);

Responses

The event information was successfully retrieved.

Body

application/json

eventsarray

System event log

[

severitystring (Enum)

Event severity (INFO, SEVERE, and WARNING)

Allowed values:"INFO""WARNING""SEVERE"

subjectstring

Event summary

messagestring

Event detail

categorystring (Enum)

A category the event falls into, such as user, bucket, and S3 settings

Allowed values:"BUCKET""CLIENT_CERTS""KMIP""S3_ENCRYPTION_SETTING""SERIAL_NUMBER""STORAGE_COMPONENT""RABBITMQ"

eventTypeIdstring

A unique identifier for a specific type of event

timestampstring

Date and time of the event in the format yyyy-mm-ddThh:mm:ssZ

eventIdstringuuid

UUID of event

]

nextPageTokenstring

Token to fetch the next page of events, null if no more pages

RESPONSE
{
  "events": [
    {
      "severity": "INFO",
      "subject": "example",
      "message": "example",
      "category": "BUCKET",
      "eventTypeId": "example",
      "timestamp": "example",
      "eventId": "uuid string"
    }
  ],
  "nextPageToken": "example"
}

Invalid input parameter in the request.

Body

application/json

codestring

Error code

messagestring

Error message

detailsstring

Error details

RESPONSE
{
  "code": "example",
  "message": "example",
  "details": "example"
}

Access was denied due to invalid credentials.

The specified HTTP method is not allowed. Please resend the request using the GET method.