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

The OpenStorageClusterPair API from Portworx — 4 operation(s) for openstorageclusterpair.

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

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

This API exposes 6 operations across 4 paths, and defines 17 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/.

6 operations 4 paths 17 schemas 1 DELETE3 GET2 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 OpenStorageClusterPair API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 6

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

OpenStorageClusterPair 6
GET
/v1/clusterpairs
Enumerate returns list of cluster pairs
OpenStorageClusterPair_Enumerate → 200default
POST
/v1/clusterpairs
Creates Pair with a remote cluster and returns details about the remote cluster
OpenStorageClusterPair_Create body → 200default
GET
/v1/clusterpairs/inspect/{id}
Inspect information about a cluster pair
OpenStorageClusterPair_Inspect 1 param → 200default
GET
/v1/clusterpairs/token
GetToken returns a auth token
OpenStorageClusterPair_GetToken → 200default
POST
/v1/clusterpairs/token
ResetToken returns a auth token
OpenStorageClusterPair_ResetToken body → 200default
DELETE
/v1/clusterpairs/{cluster_id}
Delete a cluster pair
OpenStorageClusterPair_Delete 1 param → 200default

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are apiClusterPairInfo (8 properties), apiClusterPairCreateRequest (6 properties), runtimeError (4 properties), apiClusterPairsEnumerateResponse (2 properties). Each schema is shown below with its type and property counts.

apiClusterPairTokenGetResponse
object
1 property
protobufAny
object
2 properties
apiSdkClusterPairGetTokenResponse
object
1 property
apiClusterPairsEnumerateResponse
object
2 properties
apiClusterPairGetResponse
object
1 property
apiSdkClusterPairCreateResponse
object
1 property
apiClusterPairCreateResponse
object
2 properties
apiSdkClusterPairResetTokenRequest
object
apiSdkClusterPairDeleteResponse
object
apiSdkClusterPairResetTokenResponse
object
1 property
runtimeError
object
4 properties
apiSdkClusterPairInspectResponse
object
1 property
apiClusterPairModeMode
string
apiSdkClusterPairCreateRequest
object
1 property
apiClusterPairInfo
object
8 properties
apiSdkClusterPairEnumerateResponse
object
1 property
apiClusterPairCreateRequest
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portworx-openstorageclusterpair-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 OpenStorageCredentials API
Portworx OpenStorageDiags 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 OpenStorageClusterPair 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.