V2 Web API¶

Capabilities¶

The Capabilities API allows you to directly discover which functions from the V2 API functionality, including the selectable aggregate functions, are supported by the currently configured storage driver. A capabilities query returns a flattened dictionary of properties with associated boolean values - a ‘False’ or absent value means that the corresponding feature is not available in the backend.

class panko.api.controllers.v2.capabilities.Capabilities(**kw)

A representation of the API and storage capabilities.

Usually constrained by restrictions imposed by the storage driver.

api

A flattened dictionary of API capabilities

event_storage

A flattened dictionary of event storage capabilities

Events and Traits¶

class panko.api.controllers.v2.events.Event(**kw)

A System event.

event_type

The type of the event

generated

The time the event occurred

message_id

The message ID for the notification

raw

The raw copy of notification

property traits

Event specific properties

class panko.api.controllers.v2.events.Trait(**kw)

A Trait associated with an event.

name

The name of the trait

type

the type of the trait (string, integer, float or datetime)

value

the value of the trait

class panko.api.controllers.v2.events.TraitDescription(**kw)

A description of a trait, with no associated value.

name

the name of the trait

type

the data type, defaults to string

Filtering Queries¶

class panko.api.controllers.v2.events.EventQuery(**kw)

Query arguments for Event Queries.

field

Name of the field to filter on. Can be either a trait name or field of an event. 1) Use start_timestamp/end_timestamp to filter on generated field. 2) Specify the ‘all_tenants=True’ query parameter to get all events for all projects, this is only allowed by admin users.

type

the type of the trait filter, defaults to string