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

The ClustersService API from StackRox — 2 operation(s) for clustersservice.

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

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

This API exposes 5 operations across 2 paths, and defines 20 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 2 paths 20 schemas 1 DELETE2 GET1 POST1 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 ClustersService 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 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

ClustersService 5
GET
/v1/clusters
GetClusters 1 param → 200
POST
/v1/clusters
PostCluster body → 200
GET
/v1/clusters/{id}
GetCluster 1 param → 200
DELETE
/v1/clusters/{id}
DeleteCluster 1 param → 200
PUT
/v1/clusters/{id}
PutCluster 1 param body → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are storageCluster (16 properties), storageProviderMetadata (6 properties), ClusterUpgradeStatusUpgradeProcessStatus (6 properties), storageClusterStatus (5 properties). Each schema is shown below with its type and property counts.

storageProviderMetadata
object
6 properties
storageAzureProviderMetadata
object
1 property
storageClusterUpgradeStatus
object
3 properties
storageTolerationsConfig
object
1 property
v1ClustersList
object
1 property
storageGoogleProviderMetadata
object
2 properties
storageDynamicClusterConfig
object
2 properties
storageAdmissionControllerConfig
object
4 properties
storageAWSProviderMetadata
object
1 property
UpgradeProgressUpgradeState
string
- UPGRADERLAUNCHING: In-progress states. - UPGRADECOMPLETE: The success state. PLEASE NUMBER ALL IN-PROGRESS STATES ABOVE THIS AND ALL ERROR STATES BELOW THIS.…
storageClusterStatus
object
5 properties
v1ClusterResponse
object
1 property
storageOrchestratorMetadata
object
3 properties
storageCluster
object
16 properties
storageCollectionMethod
string
v1Empty
object
ClusterUpgradeStatusUpgradeProcessStatus
object
6 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…
storageUpgradeProgress
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stackrox-clustersservice-api-openapi.yml Raw ↑

Other APIs StackRox publishes across the network.

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