GET Events +path

GET Events +path

Queries Operations for Logs for events.

Request
URI
GET
https://{api_host}/api/v2/events/{+path}
COPY
Path Parameters
string
+path
Required

Specifies constraints on the events to retrieve. See the specifying constraints section of /events for details.

Query Parameters
integer
limit
Optional
Constraints: default: 100

The maximum number of events to retrieve.

integer
timeout
Optional
Constraints: default: 30000

The time to wait for a response. If the complete result is not available within that time, partial result is returned and the complete flag is set to true.

string
view
Optional
Constraints: default: DEFAULT

The format of query results in the reponse.

Possible values are : DEFAULT, SIMPLE,
string
content-pack-fields
Optional

If provided, fields defined in the given content-pack are returned in the response, in addition to static fields. Specify this parameter more than once to extract fields from several content packs. If this parameter is not specified, then only static fields are returned in the response payload

string
order-by-direction
Optional
Constraints: default: DESC

The event timestamp sort direction.

Possible values are : ASC, DESC,
Authentication
This operation uses the following authentication methods.
Responses
200
Returns events.get.response of type(s) application/json 
{
    "complete": true,
    "duration": 12,
    "events": [
        {
            "text": "[2017-06-09 12:21:02.076-0700] [vpxa] ...",
            "timestamp": 1496996462076,
            "timestampString": "2017-06-09 12:21:02.076 GMT+04:00",
            "fields": [
                {
                    "name": "source",
                    "content": "10.0.0.123"
                },
                {
                    "name": "event_type",
                    "content": "v4_4eca2033"
                },
                {
                    "name": "appname",
                    "startPosition": 32,
                    "length": 4
                }
            ]
        },
        {
            "text": "[2017-06-09 12:20:56.176-0700] [hostd] ...",
            "timestamp": 1496996456176,
            "timestampString": "2017-06-09 12:20:56.176 GMT+04:00",
            "fields": [
                {
                    "name": "source",
                    "content": "10.0.0.234"
                },
                {
                    "name": "event_type",
                    "content": "v4_a7ce5b6a"
                },
                {
                    "name": "appname",
                    "startPosition": 32,
                    "length": 5
                }
            ]
        }
    ]
}

401
Operation doesn't return any data structure

440
Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v2/events/{+path}
On This Page
Events Operations
POST
POST Events
POST
POST Events Ingest Agent Id
GET
GET Events +path