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

The PolicyService API from StackRox — 8 operation(s) for policyservice.

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

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

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

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

12 operations 8 paths 36 schemas 2 DELETE3 GET2 PATCH3 POST2 PUT

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 PolicyService 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 12

Across 8 paths, the API surfaces 12 operations — 2 DELETE, 3 GET, 2 PATCH, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

PolicyService 12
GET
/v1/policies
ListPolicies returns the list of policies.
ListPolicies 5 params → 200
POST
/v1/policies
PostPolicy creates a new policy.
PostPolicy body → 200
POST
/v1/policies/dryrun
DryRunPolicy evaluates the given policy and returns any alerts without creating the policy.
DryRunPolicy body → 200
POST
/v1/policies/reassess
ReassessPolicies reevaluates all the policies.
ReassessPolicies → 200
GET
/v1/policies/{id}
GetPolicy returns the requested policy by ID.
GetPolicy 1 param → 200
DELETE
/v1/policies/{id}
DeletePolicy removes a policy by ID.
DeletePolicy 1 param → 200
PUT
/v1/policies/{id}
PutPolicy modifies an existing policy.
PutPolicy 1 param body → 200
PATCH
/v1/policies/{id}
PatchPolicy edits an existing policy.
PatchPolicy 1 param body → 200
PATCH
/v1/policies/{policyId}/notifiers
EnableDisablePolicyNotification enables or disables notifications for a policy by ID.
EnableDisablePolicyNotification 1 param body → 200
GET
/v1/policyCategories
GetPolicyCategories returns the policy categories.
GetPolicyCategories → 200
DELETE
/v1/policyCategories/{category}
DeletePolicyCategory removes the given policy category.
DeletePolicyCategory 1 param → 200
PUT
/v1/policyCategories/{oldCategory}
RenamePolicyCategory renames the given policy category.
RenamePolicyCategory 1 param body → 200

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are storagePolicyFields (29 properties), storagePolicy (15 properties), storageListPolicy (8 properties), storageVolumePolicy (5 properties). Each schema is shown below with its type and property counts.

storageComparator
string
storageProcessPolicy
object
4 properties
storageComponent
object
2 properties
storagePortPolicy
object
2 properties
v1ListPoliciesResponse
object
1 property
storageImageNamePolicy
object
3 properties
EnvironmentConfigEnvVarSource
string
storageKeyValuePolicy
object
3 properties
storageWhitelistDeployment
object
2 properties
storageVolumePolicy
object
5 properties
storageListPolicy
object
8 properties
v1DryRunResponseAlert
object
2 properties
storagePermissionPolicy
object
K8S RBAC Permission level configuration.
1 property
v1RenamePolicyCategoryRequest
object
2 properties
storageSeverity
string
storagePermissionLevel
string
storageWhitelist
object
4 properties
storageScope
object
3 properties
v1PatchPolicyRequest
object
2 properties
storageResourcePolicy
object
4 properties
PortConfigExposureLevel
string
storageDockerfileLineRuleField
object
2 properties
storageEnforcementAction
string
v1DryRunResponse
object
2 properties
storagePolicy
object
15 properties
storagePortExposurePolicy
object
1 property
storageWhitelistImage
object
1 property
storageNumericalPolicy
object
2 properties
storageHostMountPolicy
object
1 property
v1Empty
object
v1PolicyCategoriesResponse
object
1 property
storageLifecycleStage
string
storageScopeLabel
object
2 properties
v1EnableDisablePolicyNotificationRequest
object
3 properties
DryRunResponseExcluded
object
2 properties
storagePolicyFields
object
29 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stackrox-policyservice-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 DetectionService API
Where this information came from

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