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

The OpenStoragePolicy API from Portworx — 6 operation(s) for openstoragepolicy.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include OpenStoragePolicy. 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 6 paths, and defines 44 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 6 paths 44 schemas 1 DELETE3 GET3 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 OpenStoragePolicy 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 6 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

OpenStoragePolicy 8
GET
/v1/storagepolicies
Enumerate returns a list of storage policies
OpenStoragePolicy_Enumerate → 200default
POST
/v1/storagepolicies
Creates a storage policy
OpenStoragePolicy_Create body → 200default
PUT
/v1/storagepolicies
Updates specified storage policy
OpenStoragePolicy_Update body → 200default
GET
/v1/storagepolicies/default
DefaultInspect return default storage policy if any, otherwise empty response
OpenStoragePolicy_DefaultInspect → 200default
POST
/v1/storagepolicies/default/{name}
Set specified storage policy as default policy
OpenStoragePolicy_SetDefault 1 param body → 200default
GET
/v1/storagepolicies/inspect/{name}
Inspect returns information about a specified storage policy
OpenStoragePolicy_Inspect 1 param → 200default
POST
/v1/storagepolicies/release
Release specified storage policy constraint for volume creation
OpenStoragePolicy_Release body → 200default
DELETE
/v1/storagepolicies/{name}
Deletes specified storage policy
OpenStoragePolicy_Delete 1 param → 200default

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are apiVolumeSpecPolicy (38 properties), apiProxySpec (7 properties), apiSdkStoragePolicy (5 properties), apiIoThrottle (4 properties). Each schema is shown below with its type and property counts.

apiPureFileSpec
object
3 properties
protobufAny
object
2 properties
apiSdkOpenStoragePolicySetDefaultResponse
object
apiSdkOpenStoragePolicyInspectResponse
object
1 property
apiSdkOpenStoragePolicyDeleteResponse
object
apiIoThrottle
object
4 properties
apiSdkOpenStoragePolicyReleaseRequest
object
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…
apiSdkOpenStoragePolicyCreateRequest
object
1 property
apiReplicaSet
object
3 properties
apiNFSProxySpec
object
NFSProxySpec is the spec for proxying an NFS share.
2 properties
apiSdkOpenStoragePolicyReleaseResponse
object
apiProxyProtocol
string
ProxyProtocol defines the protocol used for proxy. - PROXYPROTOCOLINVALID: Invalid uninitialized value - PROXYPROTOCOLNFS: NFS indicates that the external data…
apiSdkOpenStoragePolicyCreateResponse
object
ScanPolicyScanTrigger
string
apiSharedv4Spec
object
1 property
apiCosType
string
OwnershipAccessControl
object
3 properties
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.…
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
apiS3ProxySpec
object
S3ProxySpec is the spec for proxying an external object store.
1 property
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…
OwnershipPublicAccessControl
object
1 property
apiExportSpec
object
ExportSpec defines how the volume is exported..
2 properties
apiIoStrategy
object
IoStrategy defines how I/O should be performed to backing storage media.
3 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…
apiProxySpec
object
ProxySpec defines how this volume will reflect an external data source.
7 properties
VolumeSpecPolicyPolicyOp
string
- Equal: Policy will make sure the value must be equal - Minimum: Policy will make sure the requested value must be greater than or equal - Maximum: Policy wil…
apiSharedv4ServiceSpec
object
Sharedv4ServiceSpec when set, creates a service endpoint for accessing a sharedv4 volume.
3 properties
apiMountOptions
object
MountOptions defines the mount options with which a volume is mounted.
1 property
apiSdkOpenStoragePolicyUpdateRequest
object
1 property
apiGroup
object
Group represents VolumeGroup / namespace All volumes in the same group share this object.
1 property
apiVolumeSpecPolicy
object
38 properties
apiSdkOpenStoragePolicyEnumerateResponse
object
1 property
apiOwnership
object
Ownership information for resource. Administrators are users who belong to the group , meaning, every group.
2 properties
apiSdkOpenStoragePolicySetDefaultRequest
object
1 property
ScanPolicyScanAction
string
apiPXDProxySpec
object
1 property
apiSdkOpenStoragePolicyDefaultInspectResponse
object
1 property
runtimeError
object
4 properties
apiSdkOpenStoragePolicyUpdateResponse
object
apiSdkStoragePolicy
object
5 properties
apiPureBlockSpec
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portworx-openstoragepolicy-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
#OpenStoragePolicy
← Back to P APIs
API Details
ID
portworx:portworx-openstoragepolicy-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-openstoragepolicy-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/portworx-openstoragepolicy-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 OpenStoragePolicy 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.