Skip to main content

REST APIs 25.1 Developer Guide

Events

This Public Experimental API gets a collection of events or an individual event.

Note

Use this Events API instead of Audit Events.

Events include logging a user in or out of the PCE, granting a user a role, pairing or unpairing a workload, and creating a label, ruleset, or IP list.

Event Types

For a complete list of JSON events, descriptions, CEF/LEEF success events, and CEF/LEEF failure events, see List of Event Types

Event API Methods

Functionality

HTTP

URI

Get a collection of events.

GET

[api_version][org_href]/events

Get an individual event.

GET

[api_version][event_href]

Get Events

This API gets a collection of events or a specific event identified by an event ID (in the form of a UUID).

Get Events Collection

When getting a collection of events, be aware of the following caveats:

  • Use the max_results query parameter to increase the maximum number of events returned.

  • The largest value accepted for max_results is 10000. To return more than 10000 events, use Asynchronous GET Collection.

URI to Get a Collection of Events

GET [api_version][org_href]/events

URI to Get an Individual Event

GET [api_version][event_href]