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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Portworx

Portworx OpenStorageVolume API

The OpenStorageVolume API from Portworx — 13 operation(s) for openstoragevolume.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 16 operations across 13 paths, and defines 86 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/.

16 operations 13 paths 86 schemas 1 DELETE5 GET9 POST1 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 OpenStorageVolume API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 16

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

OpenStorageVolume 16
POST
/v1/volume/catalog
Gets the volume catalog of an attached and mounted volume. Returns the entire tree up to "n" depth (default is all of it) Takes a path that can be used as the new root for the catalog request.
OpenStorageVolume_VolumeCatalog body → 200default
GET
/v1/volumes
Enumerate returns a list of volume ids
OpenStorageVolume_Enumerate → 200default
POST
/v1/volumes
Create creates a volume according to the specification provided
OpenStorageVolume_Create body → 200default
POST
/v1/volumes/clone
Clone creates a new writable volume cloned from an existing volume
OpenStorageVolume_Clone body → 200default
POST
/v1/volumes/filters
Enumerate returns a list of volume ids that match the labels if any are provided.
OpenStorageVolume_EnumerateWithFilters body → 200default
GET
/v1/volumes/inspect/{volume_id}
Inspect returns information about a volume
OpenStorageVolume_Inspect 2 params → 200default
POST
/v1/volumes/inspectwithfilters
Returns information for a list of volumes that match a filter. This call is a helper function like calling OpenStorageVolume.EnumerateWithFilters then having it return the contents of each of those v…
OpenStorageVolume_InspectWithFilters body → 200default
POST
/v1/volumes/snapshot/schedules/{volume_id}
Sets the snapshot schedules. This information is saved in the VolumeSpec.snapshotschedule as policy= ,.... This function will overwrite any policy values in the volume. To delete the policies in the…
OpenStorageVolume_SnapshotScheduleUpdate 1 param body → 200default
GET
/v1/volumes/snapshots
SnapshotEnumerate returns a list of snapshots for a specific volume
OpenStorageVolume_SnapshotEnumerate 1 param → 200default
POST
/v1/volumes/snapshots
SnapshotCreate creates a snapshot of a volume. This creates an immutable (read-only), point-in-time snapshot of a volume. To create a new writable volume from a snapshot, please use OpenStorageVolume…
OpenStorageVolume_SnapshotCreate body → 200default
POST
/v1/volumes/snapshots/filters/{volume_id}
SnapshotEnumerate returns a list of snapshots. To filter all the snapshots for a specific volume which may no longer exist, specify a volume id. Labels can also be used to filter the snapshot list. I…
OpenStorageVolume_SnapshotEnumerateWithFilters 1 param body → 200default
POST
/v1/volumes/snapshots/restore
SnapshotRestore restores a volume to a specified snapshot
OpenStorageVolume_SnapshotRestore body → 200default
GET
/v1/volumes/stats/{volume_id}
Stats returns the statistics for the requested volume
OpenStorageVolume_Stats 2 params → 200default
GET
/v1/volumes/usage/{volume_id}
CapacityUsage returns volume/snapshot's capacity usage details
OpenStorageVolume_CapacityUsage 1 param → 200default
DELETE
/v1/volumes/{volume_id}
Delete deletes the provided volume
OpenStorageVolume_Delete 1 param → 200default
PUT
/v1/volumes/{volume_id}
Update provides a method for manipulating the specification and attributes of a volume. Set can be used to resize a volume, update labels, change replica count, and much more.
OpenStorageVolume_Update 1 param body → 200default

Schemas 86

The contract defines 86 schemas that model the data the API accepts and returns. The most detailed are apiVolumeSpec (52 properties), apiVolumeSpecUpdate (36 properties), apiVolume (32 properties), apiStats (14 properties). Each schema is shown below with its type and property counts.

apiVolume
object
Volume represents an abstract storage volume.
32 properties
apiIoProfile
string
Sharedv4ServiceSpecServiceType
string
Type of sharedv4 service. Values are governed by the different types of services supported by container orchestrators such as Kubernetes. - UNSPECIFIED: Unspec…
apiSdkVolumeInspectWithFiltersRequest
object
5 properties
apiSource
object
Source is a structure that can be given to a volume to seed the volume with data.
2 properties
apiSdkVolumeCreateResponse
object
1 property
ScanPolicyScanTrigger
string
apiCapacityUsageInfo
object
Provides details on exclusive and shared storage used by snapshot/volume specifically for copy-on-write(COW) snapshots. Deletion of snapshots and overwrite of…
3 properties
apiCosType
string
OwnershipAccessControl
object
3 properties
apiFastpathProtocol
string
apiScanPolicy
object
ScanPolicy defines when a filesystem check is triggered and what action to take User can specify one of the following valid policies 1. trigger=SCANTRIGGERONMO…
2 properties
apiSdkVolumeDeleteResponse
object
apiVolumeStatus
string
VolumeStatus represents a health status for a volume. - VOLUMESTATUSNOTPRESENT: Volume is not present - VOLUMESTATUSUP: Volume is healthy - VOLUMESTATUSDOWN: V…
apiSdkVolumeSnapshotScheduleUpdateResponse
object
apiIoStrategy
object
IoStrategy defines how I/O should be performed to backing storage media.
3 properties
apiSdkVolumeCatalogResponse
object
1 property
apiSdkVolumeUpdateRequest
object
3 properties
apiGroup
object
Group represents VolumeGroup / namespace All volumes in the same group share this object.
1 property
apiFSType
string
apiOwnership
object
Ownership information for resource. Administrators are users who belong to the group , meaning, every group.
2 properties
apiSdkVolumeEnumerateResponse
object
1 property
apiReplicaPlacementSpec
object
5 properties
runtimeError
object
4 properties
apiSdkVolumeStatsResponse
object
1 property
apiVolumePlacementStrategy
object
VolumePlacementStrategy defines a strategy for placing volumes in the cluster which will be a series of rules All the rules specified will be applied for volum…
4 properties
apiPureBlockSpec
object
3 properties
apiAttachState
string
apiPureFileSpec
object
3 properties
protobufAny
object
2 properties
apiSdkVolumeCreateRequest
object
Defines a request to create a volume. Use OpenStorageVolume.Update() to update any labels on the volume.
3 properties
apiIoThrottle
object
4 properties
apiReplicaSet
object
3 properties
apiSdkVolumeSnapshotScheduleUpdateRequest
object
2 properties
apiSdkVolumeCapacityUsageResponse
object
1 property
apiNFSProxySpec
object
NFSProxySpec is the spec for proxying an NFS share.
2 properties
apiSharedv4Spec
object
1 property
apiNearSyncReplicationStrategy
string
apiLabelSelectorRequirement
object
LabelSelectorRequirement is a selector that contains values, a key, and an operator that relates the key and values.
3 properties
apiExportSpec
object
ExportSpec defines how the volume is exported..
2 properties
apiFastpathReplState
object
11 properties
apiExportProtocol
string
ExportProtocol defines how the device is exported.. - INVALID: Invalid uninitialized value - PXD: PXD the volume is exported over Portworx block interface. - I…
apiSdkVolumeEnumerateWithFiltersRequest
object
4 properties
apiFastpathStatus
string
- FASTPATHUNKNOWN: backward compatible state - FASTPATHACTIVE: fastpath activated and enabled - FASTPATHINACTIVE: fastpath inactive - FASTPATHUNSUPPORTED: fast…
ScanPolicyScanAction
string
apiEnforcementType
string
- required: This specifies that the rule is required and must be strictly enforced - preferred: This specifies that the rule is preferred and can be best effort
apiTopologyRequirement
object
1 property
apiCatalog
object
6 properties
apiVolumeInspectOptions
object
1 property
apiVolumeConsumer
object
6 properties
apiProxyProtocol
string
ProxyProtocol defines the protocol used for proxy. - PROXYPROTOCOLINVALID: Invalid uninitialized value - PROXYPROTOCOLNFS: NFS indicates that the external data…
apiXattrValue
string
apiSdkVolumeSnapshotEnumerateWithFiltersResponse
object
1 property
apiCatalogResponse
object
2 properties
apiSdkVolumeCloneRequest
object
3 properties
apiSharedv4FailoverStrategyValue
string
- UNSPECIFIED: Unspecified - AGGRESSIVE: Fail over to the new NFS server quickly. This is appropriate for the apps with sharedv4 service volumes. It can also b…
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) -…
apiProxySpec
object
ProxySpec defines how this volume will reflect an external data source.
7 properties
apiSharedv4ServiceSpec
object
Sharedv4ServiceSpec when set, creates a service endpoint for accessing a sharedv4 volume.
3 properties
apiVolumeSpecUpdate
object
36 properties
apiVolumePlacementSpec
object
4 properties
apiPXDProxySpec
object
1 property
apiSdkVolumeCatalogRequest
object
3 properties
apiSdkVolumeUpdateResponse
object
apiSdkVolumeSnapshotEnumerateWithFiltersRequest
object
2 properties
apiRuntimeStateMap
object
RuntimeStateMap is a list of name value mapping of driver specific runtime information.
1 property
apiSdkVolumeInspectResponse
object
3 properties
apiVolumeState
string
VolumeState represents the state of a volume. - VOLUMESTATEPENDING: Volume is transitioning to new state - VOLUMESTATEAVAILABLE: Volume is ready to be assigned…
apiVolumeLocator
object
VolumeLocator is a structure that is attached to a volume and is used to carry opaque metadata.
5 properties
apiSdkVolumeSnapshotCreateResponse
object
1 property
OwnershipAccessType
string
Access types can be set by owner to have different levels of access to a resource. It is up to the resource to interpret what the types mean and are used for.…
apiS3ProxySpec
object
S3ProxySpec is the spec for proxying an external object store.
1 property
apiSdkVolumeSnapshotRestoreResponse
object
apiFastpathConfig
object
8 properties
OwnershipPublicAccessControl
object
1 property
apiStats
object
14 properties
apiSdkVolumeEnumerateWithFiltersResponse
object
1 property
apiSdkVolumeSnapshotEnumerateResponse
object
1 property
apiSdkVolumeSnapshotRestoreRequest
object
2 properties
apiVolumeSpec
object
VolumeSpec has the properties needed to create a volume.
52 properties
apiMountOptions
object
MountOptions defines the mount options with which a volume is mounted.
1 property
apiSdkVolumeSnapshotCreateRequest
object
Defines the request when creating a snapshot from a volume.
3 properties
apiFilesystemHealthStatus
string
apiSdkVolumeCloneResponse
object
1 property
apiSdkVolumeInspectWithFiltersResponse
object
1 property
apiReport
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portworx-openstoragevolume-api-openapi.yml Raw ↑

Other APIs Portworx publishes across the network.

Portworx OpenStorageAlerts API
AE Profile APIs.io
Portworx OpenStorageBucket API
AE Profile APIs.io
Portworx OpenStorageCloudBackup API
AE Profile APIs.io
Portworx OpenStorageCluster API
AE Profile APIs.io
Portworx OpenStorageClusterDomains API
AE Profile APIs.io
Portworx OpenStorageClusterPair API
AE Profile APIs.io
Portworx OpenStorageCredentials API
AE Profile APIs.io
Portworx OpenStorageDiags API
AE Profile APIs.io
Portworx OpenStorageFilesystemCheck API
AE Profile APIs.io
Portworx OpenStorageFilesystemDefrag API
AE Profile APIs.io
Portworx OpenStorageFilesystemTrim API
AE Profile APIs.io
Portworx OpenStorageIdentity API
AE Profile APIs.io
#OpenStorageVolume
← Back to P APIs
API Details
ID
portworx:portworx-openstoragevolume-api
Base URL
https://libopenstorage.github.io/
Docs
https://portworx.com/
Provider
Portworx
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=portworx-openstoragevolume-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/portworx-openstoragevolume-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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