Portworx OpenStorageWatch API is one of 25 APIs that Portworx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include OpenStorageWatch. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and an API reference.
This API exposes
1 operation
across 1 path,
and defines 58 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/.
1 operations1 paths58 schemas1 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 OpenStorageWatch API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
OpenStorageWatch 1
POST
/v1/watch
Watch on resources managed by the driver and receive them as a stream of events.
OpenStorageWatch_Watchbody→ 200default
Schemas 58
The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are apiVolumeSpec (52 properties), apiVolume (32 properties), apiFastpathReplState (11 properties), apiFastpathConfig (8 properties). Each schema is shown below with its type and property counts.
apiVolume
object
Volume represents an abstract storage volume.
32 properties
apiPureFileSpec
object
3 properties
protobufAny
object
2 properties
apiSdkWatchResponse
object
1 property
apiTopologyRequirement
object
1 property
runtimeStreamError
object
5 properties
apiIoThrottle
object
4 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…
apiReplicaSet
object
3 properties
apiRuntimeStateMap
object
RuntimeStateMap is a list of name value mapping of driver specific runtime information.
1 property
apiNFSProxySpec
object
NFSProxySpec is the spec for proxying an NFS share.
2 properties
apiSource
object
Source is a structure that can be given to a volume to seed the volume with data.
2 properties
apiVolumeState
string
VolumeState represents the state of a volume. - VOLUMESTATEPENDING: Volume is transitioning to new state - VOLUMESTATEAVAILABLE: Volume is ready to be assigned…
apiProxyProtocol
string
ProxyProtocol defines the protocol used for proxy. - PROXYPROTOCOLINVALID: Invalid uninitialized value - PROXYPROTOCOLNFS: NFS indicates that the external data…
apiVolumeConsumer
object
6 properties
apiVolumeLocator
object
VolumeLocator is a structure that is attached to a volume and is used to carry opaque metadata.
5 properties
ScanPolicyScanTrigger
string
apiSharedv4Spec
object
1 property
apiSdkWatchRequest
object
1 property
apiXattrValue
string
apiAttachState
string
apiNearSyncReplicationStrategy
string
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
apiFastpathProtocol
string
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…
apiFastpathConfig
object
8 properties
OwnershipPublicAccessControl
object
1 property
apiVolumeStatus
string
VolumeStatus represents a health status for a volume. - VOLUMESTATUSNOTPRESENT: Volume is not present - VOLUMESTATUSUP: Volume is healthy - VOLUMESTATUSDOWN: V…
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
apiIoStrategy
object
IoStrategy defines how I/O should be performed to backing storage media.
3 properties
apiFastpathReplState
object
11 properties
apiSdkVolumeWatchRequest
object
1 property
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) -…
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
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
apiSharedv4ServiceSpec
object
Sharedv4ServiceSpec when set, creates a service endpoint for accessing a sharedv4 volume.
3 properties
apiSdkVolumeWatchResponse
object
2 properties
apiGroup
object
Group represents VolumeGroup / namespace All volumes in the same group share this object.
1 property
apiFSType
string
apiFastpathStatus
string
- FASTPATHUNKNOWN: backward compatible state - FASTPATHACTIVE: fastpath activated and enabled - FASTPATHINACTIVE: fastpath inactive - FASTPATHUNSUPPORTED: fast…
apiOwnership
object
Ownership information for resource. Administrators are users who belong to the group , meaning, every group.
2 properties
apiVolumePlacementSpec
object
4 properties
apiFilesystemHealthStatus
string
ScanPolicyScanAction
string
apiPXDProxySpec
object
1 property
apiReplicaPlacementSpec
object
5 properties
runtimeError
object
4 properties
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
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
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 OpenStorageWatch 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.
