Meta Data

Returns the metadata fields available for the specified module.

End Points

Log Fields

The API returns the list of parsed log field from processed logs available in EventLog Analyzer.
OAuth Scope : logfields.READ

Request Example

headers_data = Map();
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "http://localhost:8400/api/v2/meta/log-fields"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://localhost:8400/api/v2/meta/log-fields")
  .get()
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {method: 'GET', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}};

fetch('http://localhost:8400/api/v2/meta/log-fields', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("localhost:8400")

headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" }

conn.request("GET", "/api/v2/meta/log-fields", headers=headers)

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

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

const http = require("http");

const options = {
  "method": "GET",
  "hostname": "localhost",
  "port": "8400",
  "path": "/api/v2/meta/log-fields",
  "headers": {
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url http://localhost:8400/api/v2/meta/log-fields \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
    "data": {
        "fields": [
            {
                "data_type": "Select",
                "display_name": "Severity",
                "is_metric_field": false,
                "field_name": "SEVERITY"
            }
        ]
    }
}

{
    "code": "070011101",
    "title": "Unauthorized",
    "detail": "Invalid or missing AuthToken. Check whether the AuthToken is not revoked or expired."
}

Users

To get a list of available users.
OAuth Scope : users.READ

Query Parameters

from

integer

The starting index of the response range.

limit

integer

The number of users data to return in the search response.
Default value: 10
Maximum: 100

Request Example

headers_data = Map();
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "http://localhost:8400/api/v2/meta/users"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://localhost:8400/api/v2/meta/users")
  .get()
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {method: 'GET', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}};

fetch('http://localhost:8400/api/v2/meta/users', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("localhost:8400")

headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" }

conn.request("GET", "/api/v2/meta/users", headers=headers)

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

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

const http = require("http");

const options = {
  "method": "GET",
  "hostname": "localhost",
  "port": "8400",
  "path": "/api/v2/meta/users",
  "headers": {
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url http://localhost:8400/api/v2/meta/users \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
    "data": [
        {
            "user_role": "Guest",
            "user_id": 1000000943489,
            "user_name": "user1"
        }
    ]
}

{
    "code": "070011101",
    "title": "Unauthorized",
    "detail": "Invalid or missing AuthToken. Check whether the AuthToken is not revoked or expired."
}

{
    "error": {
        "code": "10001007",
        "title": "Bad Request",
        "detail": "Something went wrong."
    }
}