How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

StackRox AlertService API

The AlertService API from StackRox — 9 operation(s) for alertservice.

StackRox AlertService API is one of 39 APIs that StackRox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 10 operations across 9 paths, and defines 57 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against a single base URL, https://{central-host}.

10 operations 9 paths 57 schemas 1 DELETE6 GET3 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Server
https://{central-host}
Authentication
API Key
Resource Areas
1

Authentication & Security 1

StackRox AlertService API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiToken). By default, every request must be authenticated.

  • ApiToken — StackRox API token. Format: Bearer {token}

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 1 DELETE, 6 GET, 3 PATCH. Each is listed below with its method, path, parameters, and response codes.

AlertService 10
GET
/v1/alerts
List returns the slim list version of the alerts.
ListAlerts 5 params → 200
DELETE
/v1/alerts
DeleteAlerts 6 params → 200
PATCH
/v1/alerts/resolve
ResolveAlertsByQuery marks alerts matching search query as resolved.
ResolveAlerts body → 200
GET
/v1/alerts/summary/counts
GetAlertsCounts returns the number of alerts in the requested cluster or category.
GetAlertsCounts 6 params → 200
GET
/v1/alerts/summary/groups
GetAlertsGroup returns alerts grouped by policy.
GetAlertsGroup 5 params → 200
GET
/v1/alerts/summary/timeseries
GetAlertTimeseries returns the alerts sorted by time.
GetAlertTimeseries 5 params → 200
GET
/v1/alerts/{id}
GetAlert returns the alert given its id.
GetAlert 1 param → 200
PATCH
/v1/alerts/{id}/resolve
ResolveAlert marks the given alert (by ID) as resolved.
ResolveAlert 1 param body → 200
PATCH
/v1/alerts/{id}/snooze
SnoozeAlert is deprecated.
SnoozeAlert 1 param body → 200
GET
/v1/alertscount
CountAlerts counts how many alerts match the get request.
CountAlerts 5 params → 200

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are storagePolicyFields (29 properties), storagePolicy (15 properties), storageAlert (11 properties), storageProcessSignal (10 properties). Each schema is shown below with its type and property counts.

storageComparator
string
storageProcessPolicy
object
4 properties
GetAlertsGroupResponsePolicyGroup
object
2 properties
v1GetAlertsGroupResponse
object
1 property
GetAlertsCountsResponseAlertGroup
object
2 properties
v1ResolveAlertRequest
object
2 properties
ClusterAlertsAlertEvents
object
2 properties
storageListAlertDeployment
object
6 properties
storageComponent
object
2 properties
storageListAlertPolicy
object
5 properties
storagePortPolicy
object
2 properties
v1AlertEvent
object
3 properties
storageImageNamePolicy
object
3 properties
EnvironmentConfigEnvVarSource
string
v1GetAlertTimeseriesResponse
object
1 property
storageProcessSignal
object
10 properties
storageListAlert
object
7 properties
v1CountAlertsResponse
object
1 property
storageKeyValuePolicy
object
3 properties
v1DeleteAlertsResponse
object
2 properties
storageWhitelistDeployment
object
2 properties
storageVolumePolicy
object
5 properties
v1ResolveAlertsRequest
object
1 property
AlertDeploymentContainer
object
2 properties
storagePermissionPolicy
object
K8S RBAC Permission level configuration.
1 property
AlertViolation
object
2 properties
storageSeverity
string
v1ListAlertsResponse
object
1 property
storagePermissionLevel
string
storageAlertDeployment
object
10 properties
storageWhitelist
object
4 properties
storageImageName
object
4 properties
storageScope
object
3 properties
storageResourcePolicy
object
4 properties
AlertProcessViolation
object
2 properties
storageEnforcementAction
string
PortConfigExposureLevel
string
storageDockerfileLineRuleField
object
2 properties
AlertGroupAlertCounts
object
2 properties
storagePolicy
object
15 properties
GetAlertTimeseriesResponseClusterAlerts
object
2 properties
v1GetAlertsCountsResponse
object
1 property
storagePortExposurePolicy
object
1 property
storageViolationState
string
storageAlert
object
11 properties
storageProcessIndicator
object
9 properties
storageWhitelistImage
object
1 property
storageNumericalPolicy
object
2 properties
storageHostMountPolicy
object
1 property
v1Empty
object
v1Type
string
storageContainerImage
object
3 properties
storageLifecycleStage
string
storageScopeLabel
object
2 properties
AlertEnforcement
object
2 properties
v1SnoozeAlertRequest
object
2 properties
storagePolicyFields
object
29 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stackrox-alertservice-api-openapi.yml Raw ↑

Other APIs StackRox publishes across the network.

StackRox APITokenService API
StackRox AuthProviderService API
StackRox AuthService API
StackRox ClustersService API
StackRox ComplianceManagementService API
StackRox ComplianceService API
StackRox ConfigService API
StackRox DBService API
StackRox DebugService API
StackRox DeploymentService API
StackRox DetectionService API
StackRox ExternalBackupService API
Where this information came from

This is an independent, third-party profile of StackRox AlertService API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.