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

Portworx OpenStorageDiags API

The OpenStorageDiags API from Portworx — 1 operation(s) for openstoragediags.

Portworx OpenStorageDiags API is one of 25 APIs that Portworx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include OpenStorageDiags. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and an API reference.

This API exposes 1 operation across 1 path, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 0.186.0.

Requests are made against a single base URL, https://libopenstorage.github.io/.

1 operations 1 paths 18 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.186.0
Base URL
https://libopenstorage.github.io/
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Portworx OpenStorageDiags API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 1

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

OpenStorageDiags 1
POST
/v1/diags
Collect starts a job to collect diagnostics from set of nodes that are selected based on the selectors provided in the SdkDiagsCollectRequest. See SdkDiagsCollectRequest for more details on how to se…
OpenStorageDiags_Collect body → 200default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are apiJob (9 properties), apiDefragJob (8 properties), apiSdkDiagsCollectRequest (7 properties), apiNodeDrainAttachmentsJob (6 properties). Each schema is shown below with its type and property counts.

protobufAny
object
2 properties
apiSdkDiagsCollectRequest
object
7 properties
apiDiagsCollectionStatusState
string
- UNSPECIFIED: Unspecified means uninitialized or unknown state - PENDING: Pending indicates the diags collection is pending and hasn't started - RUNNING: Runn…
apiCloudDriveTransferJob
object
3 properties
apiJob
object
9 properties
apiLabelSelectorRequirement
object
LabelSelectorRequirement is a selector that contains values, a key, and an operator that relates the key and values.
3 properties
apiDiagsNodeSelector
object
3 properties
apiJobState
string
- UNSPECIFIEDSTATE: Unspecified - PENDING: Pending indicates job is still pending and has not started work - RUNNING: Running indicates job is actively running…
apiDiagsVolumeSelector
object
2 properties
apiJobType
string
- UNSPECIFIEDTYPE: Unspecified - NONE: None - DRAINATTACHMENTS: Job for draining volume attachments - CLOUDDRIVETRANSFER: Job for transferring cloud drives bet…
LabelSelectorRequirementOperator
string
- In: In means the value for 'key' should be in one of the given value(s) - NotIn: NotIn means the value for 'key' should NOT be in one of the given value(s) -…
apiSdkDiagsCollectResponse
object
1 property
apiDiagsCollectionStatus
object
3 properties
apiCollectDiagsJob
object
2 properties
apiSdkNodeDrainAttachmentsRequest
object
4 properties
runtimeError
object
4 properties
apiDefragJob
object
8 properties
apiNodeDrainAttachmentsJob
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portworx-openstoragediags-api-openapi.yml Raw ↑

Other APIs Portworx publishes across the network.

Portworx OpenStorageAlerts API
Portworx OpenStorageBucket API
Portworx OpenStorageCloudBackup API
Portworx OpenStorageCluster API
Portworx OpenStorageClusterDomains API
Portworx OpenStorageClusterPair API
Portworx OpenStorageCredentials API
Portworx OpenStorageFilesystemCheck API
Portworx OpenStorageFilesystemDefrag API
Portworx OpenStorageFilesystemTrim API
Portworx OpenStorageIdentity API
Portworx OpenStorageJob API
Where this information came from

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