Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Unleash Events API

Read events from this Unleash instance.

Unleash Events API is one of 36 APIs that Unleash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Events. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 7.4.1.

Requests are made against a single base URL, https://app.unleash-instance.example.com.

4 operations 4 paths 6 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
7.4.1
Base URL
https://app.unleash-instance.example.com
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Unleash Events API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKey). It accepts HTTP bearer tokens (bearerToken). By default, every request must be authenticated.

  • apiKey — API key needed to access this API
  • bearerToken — API key needed to access this API, in Bearer token format

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Events 4

Read events from this Unleash instance.

GET
/api/admin/eventsdeprecated
Get the Most Recent Events From the Unleash Instance or All Events Related to a Project.
getEvents 1 param → 200401
GET
/api/admin/events/{featureName}deprecated
Get All Events Related to a Specific Feature Flag.
getEventsForToggle 1 param → 200401
GET
/api/admin/event-creators
Get a List of All Users That Have Created Events
getEventCreators → 200401403404
GET
/api/admin/search/events
Search for Events
searchEvents 12 params → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are eventSchema (16 properties), featureEventsSchema (4 properties), eventsSchema (3 properties), tagSchema (3 properties). Each schema is shown below with its type and property counts.

eventSearchResponseSchema
object
A list of events that have been registered by the system
2 properties 2 required
tagSchema
object
Representation of a [tag](https://docs.getunleash.io/concepts/feature-flagstags)
3 properties 2 required
featureEventsSchema
object
One or more events happening to a specific feature flag
4 properties 1 required
eventSchema
object
An event describing something happening in the system
16 properties 4 required
eventCreatorsSchema
array
A list of event creators
eventsSchema
object
A list of events that has happened in the system
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

unleash-events-api-openapi.yml Raw ↑

Other APIs Unleash publishes across the network.

Unleash Client API
Unleash Addons API
Unleash Admin UI API
Unleash API tokens API
Unleash Archive API
Unleash Auth API
Unleash Banners API
Unleash Change Requests API
Unleash Context API
Unleash Dependencies API
Unleash Environments API
Unleash Feature Types API