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

The OpenStoragePool API from Portworx — 5 operation(s) for openstoragepool.

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

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

This API exposes 8 operations across 5 paths, and defines 25 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/.

8 operations 5 paths 25 schemas 1 DELETE3 GET1 POST3 PUT

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 OpenStoragePool API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 8

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

OpenStoragePool 8
PUT
/v1/storagepools/rebalance
Rebalance creates a new rebalance task
OpenStoragePool_Rebalance → 200default
GET
/v1/storagepools/rebalance/job
EnumerateRebalanceJobs returns all rebalance jobs currently known to the system
OpenStoragePool_EnumerateRebalanceJobs → 200default
GET
/v1/storagepools/rebalance/job/{id}
GetRebalanceJobStatus returns rebalance status for specified job
OpenStoragePool_GetRebalanceJobStatus 1 param → 200default
PUT
/v1/storagepools/rebalance/job/{id}
UpdateRebalanceJobState updates existing rebalance task state. Only acceptable values are StorageRebalanceJobStatePAUSED - acceptable only from running state StorageRebalanceJobStateCANCELLED - accep…
OpenStoragePool_UpdateRebalanceJobState 1 param → 200default
DELETE
/v1/storagepools/rebalance/schedule
DeleteRebalanceSchedule deletes the rebalance schedule
OpenStoragePool_DeleteRebalanceSchedule → 200default
GET
/v1/storagepools/rebalance/schedule
GetRebalanceSchedule returns the information of rebalance schedule
OpenStoragePool_GetRebalanceSchedule → 200default
POST
/v1/storagepools/rebalance/schedule
CreateRebalanceSchedule creates a scheudle for the input rebalance requests
OpenStoragePool_CreateRebalanceSchedule → 200default
PUT
/v1/storagepools/resize/{uuid}
Resize expands the specified storage pool based on the request parameters
OpenStoragePool_Resize 1 param → 200default

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are apiStorageRebalanceAudit (10 properties), apiSdkStorageRebalanceRequest (7 properties), apiStorageRebalanceJob (6 properties), apiStorageRebalanceTriggerThreshold (4 properties). Each schema is shown below with its type and property counts.

protobufAny
object
2 properties
apiStorageRebalanceJob
object
6 properties
apiSdkCreateRebalanceScheduleResponse
object
1 property
apiStorageRebalanceTriggerThreshold
object
4 properties
StorageRebalanceAuditStorageRebalanceAction
string
- ADDREPLICA: Indicates new replica was added - REMOVEREPLICA: Indicates existing replica was removed
apiSdkStorageRebalanceResponse
object
3 properties
apiSdkEnumerateRebalanceJobsResponse
object
1 property
apiStorageRebalanceSummary
object
2 properties
apiStorageRebalanceWorkSummary
object
3 properties
apiRebalanceScheduleInfo
object
3 properties
apiSdkUpdateRebalanceJobResponse
object
apiSdkGetRebalanceJobStatusResponse
object
3 properties
apiSdkStorageRebalanceRequestMode
string
- STORAGEREBALANCE: StorageRebalance mode: rebalance pools based on provisioned/used space (the default mode) - VOLUMEPLACEMENTFIX: VolumePlacementFix mode: sc…
apiLabelSelectorRequirement
object
LabelSelectorRequirement is a selector that contains values, a key, and an operator that relates the key and values.
3 properties
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) -…
apiStorageRebalanceTriggerThresholdType
string
- ABSOLUTEPERCENT: AbsolutePercent indicates absolute percent comparison. Example, 75 % used of capacity, or 50 % provisioned of capacity. - DELTAMEANPERCENT:…
apiSdkStorageRebalanceRequest
object
7 properties
apiSdkStoragePoolResizeResponse
object
StorageRebalanceTriggerThresholdMetric
string
- PROVISIONSPACE: ProvisionSpace indicates rebalance for provisioned space - USEDSPACE: UsedSpace indicates rebalance for used space
apiStorageRebalanceAudit
object
10 properties
apiStorageRebalanceWorkSummaryType
string
- UnbalancedPools: summary for unbalanced pools - UnbalancedVolumes: summary for unbalanced volumes - UnbalancedProvisionedSpaceBytes: summary for unbalanced p…
apiSdkGetRebalanceScheduleResponse
object
1 property
apiStorageRebalanceJobState
string
- PENDING: Pending indicates job is still pending and has not started work - RUNNING: Running indicates job is actively running - DONE: Done indicates job has…
runtimeError
object
4 properties
apiSdkDeleteRebalanceScheduleResponse
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portworx-openstoragepool-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 OpenStorageDiags API
Portworx OpenStorageFilesystemCheck API
Portworx OpenStorageFilesystemDefrag API
Portworx OpenStorageFilesystemTrim API
Portworx OpenStorageIdentity API
Where this information came from

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