Skip to main content

Events API

EventResourceApi provides querying and management of IDMP events.

Method Summary​

MethodHTTPDescription
apiV1EventsGetGET /api/v1/eventsList events (paginated)
apiV1EventsIdGetGET /api/v1/events/{id}Get a single event
apiV1EventsIdAcknowledgePutPUT /api/v1/events/{id}/acknowledgeAcknowledge an event
apiV1EventsIdResolvePutPUT /api/v1/events/{id}/resolveResolve an event

List Events​

Parameters​

NameTypeRequiredDescription
fromlongNoStart time, Unix milliseconds
tolongNoEnd time, Unix milliseconds
statusstringNoactive, acknowledged, resolved
severitystringNocritical, warning, info
elementIdstringNoFilter by element ID
pageNumintegerNoPage number
pageSizeintegerNoItems per page

Example​

import time

event_api = idmp_sdk.EventResourceApi(api_client)

# TODO: fill in actual method name
# events = event_api.apiV1EventsGet(
# from_ts=int(time.time() * 1000) - 86400 * 1000, # last 24h
# status="active",
# severity="critical"
# )
# print(f"Found {events.total} critical active events")
note

Method names marked {METHOD_NAME} need to be filled in from the OpenAPI spec file.