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 ComplianceService API

The ComplianceService API from StackRox — 5 operation(s) for complianceservice.

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

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

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

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

5 operations 5 paths 69 schemas 5 GET

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 ComplianceService 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 5

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

ComplianceService 5
GET
/v1/compliance/aggregatedresults
GetAggregatedResults 7 params → 200
GET
/v1/compliance/results
GetComplianceControlResults 5 params → 200
GET
/v1/compliance/runresults
GetRunResults 3 params → 200
GET
/v1/compliance/standards
GetStandards → 200
GET
/v1/compliance/standards/{id}
GetStandard 1 param → 200

Schemas 69

The contract defines 69 schemas that model the data the API accepts and returns. The most detailed are storageDeployment (24 properties), storageCluster (16 properties), storageNode (15 properties), storageContainer (10 properties). Each schema is shown below with its type and property counts.

storageVolume
object
5 properties
storagePortConfig
object
6 properties
v1ComplianceAggregationResult
object
4 properties
storageProviderMetadata
object
6 properties
storageContainerInstanceID
object
3 properties
v1GetComplianceStandardResponse
object
1 property
storageComplianceDomain
object
3 properties
v1GetComplianceStandardsResponse
object
1 property
storageSecurityContext
object
5 properties
ComplianceResourceClusterName
object
2 properties
storageAzureProviderMetadata
object
1 property
storageClusterUpgradeStatus
object
3 properties
storageLabelSelectorOperator
string
storageComplianceResultValue
object
2 properties
storageLabelSelector
object
2 properties
storageToleration
object
4 properties
storageContainerConfig
object
6 properties
ComplianceAggregationSource
object
4 properties
EnvironmentConfigEnvVarSource
string
ComplianceResourceDeploymentName
object
4 properties
ComplianceAggregationResponse
object
2 properties
PortConfigExposureInfo
object
8 properties
storageTolerationOperator
string
ComplianceResultValueEvidence
object
3 properties
ComplianceAggregationAggregationKey
object
2 properties
v1ComplianceControlResultsResponse
object
1 property
storageContainerRuntimeInfo
object
2 properties
v1ComplianceAggregationScope
string
storageGoogleProviderMetadata
object
2 properties
storageTolerationsConfig
object
1 property
v1ComplianceControl
object
7 properties
storageTaintEffect
string
storageResources
object
4 properties
v1ComplianceStandard
object
3 properties
storageDynamicClusterConfig
object
2 properties
storageComplianceRunResults
object
5 properties
ComplianceResourceNodeName
object
3 properties
ContainerConfigEnvironmentConfig
object
3 properties
storageAdmissionControllerConfig
object
4 properties
storageAWSProviderMetadata
object
1 property
storageImageName
object
4 properties
storageComplianceRunMetadata
object
7 properties
storageComplianceControlResult
object
3 properties
storageDeployment
object
24 properties
PortConfigExposureLevel
string
storageComplianceState
string
storageClusterStatus
object
5 properties
storageNode
object
15 properties
UpgradeProgressUpgradeState
string
- UPGRADERLAUNCHING: In-progress states. - UPGRADECOMPLETE: The success state. PLEASE NUMBER ALL IN-PROGRESS STATES ABOVE THIS AND ALL ERROR STATES BELOW THIS.…
storageComplianceResource
object
4 properties
storageTaint
object
3 properties
storageCluster
object
16 properties
storageOrchestratorMetadata
object
3 properties
storageCollectionMethod
string
v1GetComplianceRunResultsResponse
object
2 properties
storageContainer
object
10 properties
ComplianceRunResultsEntityResults
object
1 property
storageContainerRuntime
string
storageEmbeddedSecret
object
2 properties
ClusterUpgradeStatusUpgradeProcessStatus
object
6 properties
storageContainerImage
object
3 properties
storageContainerInstance
object
ContainerInstanceID allows to uniquely identify a container within a cluster.
4 properties
LabelSelectorRequirement
object
3 properties
storageClusterType
string
ClusterUpgradeStatusUpgradability
string
- SENSORVERSIONHIGHER: SENSORVERSIONHIGHER occurs when we detect that the sensor is running a newer version than this Central. This is unexpected, but can occu…
SecurityContextSELinux
object
4 properties
storageUpgradeProgress
object
3 properties
v1ComplianceControlGroup
object
5 properties
v1ComplianceStandardMetadata
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stackrox-complianceservice-api-openapi.yml Raw ↑

Other APIs StackRox publishes across the network.

StackRox AlertService API
StackRox APITokenService API
StackRox AuthProviderService API
StackRox AuthService API
StackRox ClustersService API
StackRox ComplianceManagementService 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 ComplianceService 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.