Security Services Platform API Operations Index

Security Services Platform API Operations Index

All available Security Services Platform API Operations

Alarms
POST
Filter Alarm Definitions

Retrieves a list of alarm definitions based on specified filter criteria. This endpoint supports filtering by feature names, severities, event types, and enabled status. The response includes detailed information about each matching alarm definition.

GET
Get Alarm Definitions By Id

Retrieves a single alarm definition using its unique identifier. Returns detailed configuration information about the alarm definition including its feature name, event type, severity, and other associated metadata.

POST
Update Alarm Definition

Update Alarm Definition

POST
Filter Alarm Instances

Get alarm instances based on filter criteria

POST
Update Alarm Instances States

Update the states of a list of alarm instances by IDs

GET
Get Alarm Instance By Id

Retrieves a single alarm instance using its unique identifier

POST
Get Alarm Counts By Category And Severity

When invoking this API, the Alarm instances are accounted for in a map where the key is a category, by default feature name, and the value contains counts by severity. When the optional FeatureName request parameter is specified, the resulting list will only include the feature names passed along with the instance counts by severity for those features.

Telemetry
GET
Get Telemetry Config

Get telemetry config information.

PUT
Update Telemetry Config

Updated telemetry config information.

GET
Get Telemetry Data

This API exports all the aggregated telemetries in the specified format.