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

The DetectionService API from StackRox — 3 operation(s) for detectionservice.

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

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

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

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

3 operations 3 paths 63 schemas 3 POST

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 DetectionService 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 3

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

DetectionService 3
POST
/v1/detect/build
DetectBuildTime checks if any images violate build time policies.
DetectBuildTime body → 200
POST
/v1/detect/deploy
DetectDeployTime checks if any deployments violate deploy time policies.
DetectDeployTime body → 200
POST
/v1/detect/deploy/yaml
DetectDeployTimeFromYAML checks if the given deployment yaml violates any deploy time policies.
DetectDeployTimeFromYAML body → 200

Schemas 63

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

storageVolume
object
5 properties
storagePortConfig
object
6 properties
storageContainerInstanceID
object
3 properties
storageSecurityContext
object
5 properties
storageComparator
string
storageProcessPolicy
object
4 properties
storageLabelSelectorOperator
string
storageComponent
object
2 properties
storageLabelSelector
object
2 properties
storagePortPolicy
object
2 properties
storageToleration
object
4 properties
storageContainerConfig
object
6 properties
storageImageNamePolicy
object
3 properties
EnvironmentConfigEnvVarSource
string
storageTolerationOperator
string
PortConfigExposureInfo
object
8 properties
storageProcessSignal
object
10 properties
storageKeyValuePolicy
object
3 properties
storageWhitelistDeployment
object
2 properties
storageVolumePolicy
object
5 properties
v1BuildDetectionRequest
object
3 properties
DeployDetectionResponseRun
object
3 properties
AlertDeploymentContainer
object
2 properties
storageResources
object
4 properties
storageTaintEffect
string
storagePermissionPolicy
object
K8S RBAC Permission level configuration.
1 property
AlertViolation
object
2 properties
v1DeployYAMLDetectionRequest
object
3 properties
storageSeverity
string
storagePermissionLevel
string
storageAlertDeployment
object
10 properties
ContainerConfigEnvironmentConfig
object
3 properties
storageWhitelist
object
4 properties
storageImageName
object
4 properties
v1BuildDetectionResponse
object
1 property
storageScope
object
3 properties
storageResourcePolicy
object
4 properties
AlertProcessViolation
object
2 properties
v1DeployDetectionResponse
object
1 property
storageEnforcementAction
string
PortConfigExposureLevel
string
storageDockerfileLineRuleField
object
2 properties
storageDeployment
object
24 properties
storagePolicy
object
15 properties
storagePortExposurePolicy
object
1 property
storageAlert
object
11 properties
storageViolationState
string
storageProcessIndicator
object
9 properties
storageContainer
object
10 properties
storageWhitelistImage
object
1 property
v1DeployDetectionRequest
object
4 properties
storageNumericalPolicy
object
2 properties
storageHostMountPolicy
object
1 property
storageContainerRuntime
string
storageEmbeddedSecret
object
2 properties
LabelSelectorRequirement
object
3 properties
storageContainerImage
object
3 properties
storageLifecycleStage
string
storageScopeLabel
object
2 properties
storageContainerInstance
object
ContainerInstanceID allows to uniquely identify a container within a cluster.
4 properties
AlertEnforcement
object
2 properties
SecurityContextSELinux
object
4 properties
storagePolicyFields
object
29 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stackrox-detectionservice-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 ComplianceService API
StackRox ConfigService API
StackRox DBService API
StackRox DebugService API
StackRox DeploymentService API
StackRox ExternalBackupService API
Where this information came from

This is an independent, third-party profile of StackRox DetectionService 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.