# Portworx OpenStorageVolume API

**Canonical:** https://apis.io/apis/portworx/portworx-openstoragevolume-api/  
**Provider:** Portworx — https://apis.io/providers/portworx/  
**Base URL:** https://libopenstorage.github.io/  
**Documentation:** https://portworx.com/

Portworx OpenStorageVolume API is one of 25 APIs that [Portworx](https://apis.io/providers/portworx/) publishes on the [APIs.io](https://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.

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

## Operations (16)

| Method | Path | Summary |
|---|---|---|
| POST | `/v1/volume/catalog` | Gets the volume catalog of an attached and mounted volume. |
| GET | `/v1/volumes` | Enumerate returns a list of volume ids |
| POST | `/v1/volumes` | Create creates a volume according to the specification provided |
| POST | `/v1/volumes/clone` | Clone creates a new writable volume cloned from an existing volume |
| POST | `/v1/volumes/filters` | Enumerate returns a list of volume ids that match the labels if any are provided |
| GET | `/v1/volumes/inspect/{volume_id}` | Inspect returns information about a volume |
| POST | `/v1/volumes/inspectwithfilters` | Returns information for a list of volumes that match a filter. |
| POST | `/v1/volumes/snapshot/schedules/{volume_id}` | Sets the snapshot schedules. |
| GET | `/v1/volumes/snapshots` | SnapshotEnumerate returns a list of snapshots for a specific volume |
| POST | `/v1/volumes/snapshots` | SnapshotCreate creates a snapshot of a volume. |
| POST | `/v1/volumes/snapshots/filters/{volume_id}` | SnapshotEnumerate returns a list of snapshots. |
| POST | `/v1/volumes/snapshots/restore` | SnapshotRestore restores a volume to a specified snapshot |
| GET | `/v1/volumes/stats/{volume_id}` | Stats returns the statistics for the requested volume |
| GET | `/v1/volumes/usage/{volume_id}` | CapacityUsage returns volume/snapshot's capacity usage details |
| DELETE | `/v1/volumes/{volume_id}` | Delete deletes the provided volume |
| PUT | `/v1/volumes/{volume_id}` | Update provides a method for manipulating the specification and attributes of a… |

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/portworx/refs/heads/main/openapi/portworx-openstoragevolume-api-openapi.yml
- **Documentation** — https://docs.portworx.com/
- **GettingStarted** — https://docs.portworx.com/portworx-enterprise/get-started
- **APIReference** — https://libopenstorage.github.io/

## Other Portworx APIs (12)

- [Portworx OpenStorageAlerts API](https://apis.io/apis/portworx/portworx-openstoragealerts-api/)
- [Portworx OpenStorageBucket API](https://apis.io/apis/portworx/portworx-openstoragebucket-api/)
- [Portworx OpenStorageCloudBackup API](https://apis.io/apis/portworx/portworx-openstoragecloudbackup-api/)
- [Portworx OpenStorageCluster API](https://apis.io/apis/portworx/portworx-openstoragecluster-api/)
- [Portworx OpenStorageClusterDomains API](https://apis.io/apis/portworx/portworx-openstorageclusterdomains-api/)
- [Portworx OpenStorageClusterPair API](https://apis.io/apis/portworx/portworx-openstorageclusterpair-api/)
- [Portworx OpenStorageCredentials API](https://apis.io/apis/portworx/portworx-openstoragecredentials-api/)
- [Portworx OpenStorageDiags API](https://apis.io/apis/portworx/portworx-openstoragediags-api/)
- [Portworx OpenStorageFilesystemCheck API](https://apis.io/apis/portworx/portworx-openstoragefilesystemcheck-api/)
- [Portworx OpenStorageFilesystemDefrag API](https://apis.io/apis/portworx/portworx-openstoragefilesystemdefrag-api/)
- [Portworx OpenStorageFilesystemTrim API](https://apis.io/apis/portworx/portworx-openstoragefilesystemtrim-api/)
- [Portworx OpenStorageIdentity API](https://apis.io/apis/portworx/portworx-openstorageidentity-api/)

## Tags

OpenStorageVolume

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/portworx/portworx-openstoragevolume-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/portworx/.