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

The DBService API from StackRox — 4 operation(s) for dbservice.

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

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

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

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

4 operations 4 paths 15 schemas 1 DELETE2 GET1 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 DBService 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 4

Across 4 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

DBService 4
GET
/v1/db/exportcaps
GetExportCapabilities → 200
POST
/v1/db/interruptrestore/{processId}/{attemptId}
InterruptRestoreProcess 2 params → 200
GET
/v1/db/restore
GetActiveRestoreProcess → 200
DELETE
/v1/db/restore/{id}
CancelRestoreProcess 1 param → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are v1DBRestoreProcessStatus (7 properties), v1DBExportManifestFile (5 properties), v1DBRestoreProcessMetadata (4 properties), v1DBRestoreRequestHeader (3 properties). Each schema is shown below with its type and property counts.

v1GetActiveDBRestoreProcessResponse
object
1 property
v1DBRestoreProcessMetadata
object
The metadata of an ongoing or completed restore process. This is the static metadata, which will not change (i.e., it is not a status).
4 properties
v1DBExportManifestFile
object
A single file in the restore body.
5 properties
v1DBRestoreRequestHeader
object
3 properties
DBRestoreProcessStatusResumeInfo
object
1 property
v1DBExportManifest
object
A DB export manifest describes the file contents of a restore request. To prevent data loss, a manifest is always interpreted as binding, i.e., the server must…
1 property
v1Empty
object
v1DBExportFormatFile
object
2 properties
v1InterruptDBRestoreProcessResponse
object
1 property
DBExportManifestEncodingType
string
The encoding of the file data in the restore body, usually for compression purposes.
v1DBExportFormat
object
DBExportFormat describes a format (= a collection of files) for the database export.
2 properties
DBRestoreRequestHeaderLocalFileInfo
object
LocalFileInfo provides information about the file on the local machine of the user initiating the restore process, in order to provide information to other use…
2 properties
v1DBRestoreProcessStatusState
string
v1DBRestoreProcessStatus
object
7 properties
v1GetDBExportCapabilitiesResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stackrox-dbservice-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 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 DBService 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.