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

The OpenStorageNode API from Portworx — 9 operation(s) for openstoragenode.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 9 operations across 9 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/.

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

Paths & Operations 9

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

OpenStorageNode 9
GET
/v1/nodes
Enumerate returns the ids of all the nodes in the current cluster
OpenStorageNode_Enumerate → 200default
PUT
/v1/nodes/attachments/disable/{node_id}
CordonAttachments disables any new volume attachments from the provided node in the cluster. Existing volume attachments will stay on the node.
OpenStorageNode_CordonAttachments 1 param body → 200default
PUT
/v1/nodes/attachments/drain/{node_id}
DrainAttachments creates a task to drain volume attachments from the provided node in the cluster.
OpenStorageNode_DrainAttachments 1 param body → 200default
PUT
/v1/nodes/attachments/enable/{node_id}
UncordonAttachments re-enables volume attachments on the provided node in the cluster.
OpenStorageNode_UncordonAttachments 1 param body → 200default
POST
/v1/nodes/bytesused
Returns bytes used of multiple volumes for a give node
OpenStorageNode_VolumeBytesUsedByNode body → 200default
GET
/v1/nodes/filters
EnumerateWithFilters returns all the nodes in the current cluster
OpenStorageNode_EnumerateWithFilters → 200default
GET
/v1/nodes/inspect/{node_id}
Inspect returns information about the specified node
OpenStorageNode_Inspect 1 param → 200default
GET
/v1/nodes/inspectcurrent
InspectCurrent returns information about the storage node where the client is currently connected to.
OpenStorageNode_InspectCurrent → 200default
GET
/v1/nodes/usage/{node_id}
Triggers RelaxedReclaim purge for a give node
OpenStorageNode_RelaxedReclaimPurge 1 param → 200default

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are apiStorageNode (20 properties), apiStorageResource (17 properties), apiJob (9 properties), apiStoragePool (9 properties). Each schema is shown below with its type and property counts.

protobufAny
object
2 properties
apiStorageNode
object
20 properties
apiSdkDiagsCollectRequest
object
7 properties
apiDiagsNodeSelector
object
3 properties
apiJobType
string
- UNSPECIFIEDTYPE: Unspecified - NONE: None - DRAINATTACHMENTS: Job for draining volume attachments - CLOUDDRIVETRANSFER: Job for transferring cloud drives bet…
apiStoragePool
object
9 properties
apiSdkStoragePoolOperationType
string
- OPERATIONRESIZE: Resize operation
apiHardwareType
string
apiCollectDiagsJob
object
2 properties
apiStorageResource
object
StorageResource groups properties of a storage device.
17 properties
apiSchedulerTopology
object
1 property
apiNodeDrainAttachmentsJob
object
6 properties
StorageNodeSecurityStatus
string
- UNSPECIFIED: Security status type is unknown - UNSECURED: Node is unsecure - SECURED: Node is secured with authentication and authorization - SECUREDALLOWSEC…
apiSdkJobResponse
object
1 property
apiDiagsCollectionStatusState
string
- UNSPECIFIED: Unspecified means uninitialized or unknown state - PENDING: Pending indicates the diags collection is pending and hasn't started - RUNNING: Runn…
apiSdkNodeInspectResponse
object
1 property
apiStorageMedium
string
apiSdkNodeEnumerateWithFiltersResponse
object
1 property
apiSdkNodeCordonAttachmentsRequest
object
1 property
apiSdkNodeUncordonAttachmentsResponse
object
apiCosType
string
apiStoragePoolOperation
object
4 properties
apiRelaxedReclaimPurge
object
1 property
apiSdkNodeDrainAttachmentsRequest
object
4 properties
apiSdkVolumeBytesUsedResponse
object
1 property
apiSdkNodeInspectCurrentResponse
object
1 property
apiCloudDriveTransferJob
object
3 properties
apiJob
object
9 properties
apiLabelSelectorRequirement
object
LabelSelectorRequirement is a selector that contains values, a key, and an operator that relates the key and values.
3 properties
apiJobState
string
- UNSPECIFIEDSTATE: Unspecified - PENDING: Pending indicates job is still pending and has not started work - RUNNING: Running indicates job is actively running…
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) -…
apiDiagsCollectionStatus
object
3 properties
apiSdkNodeEnumerateResponse
object
1 property
apiDefragJob
object
8 properties
openstorageapiStatus
string
apiVolumeBytesUsed
object
2 properties
apiVolumeBytesUsedByNode
object
2 properties
apiSdkNodeUncordonAttachmentsRequest
object
1 property
apiSdkVolumeBytesUsedRequest
object
2 properties
apiDiagsVolumeSelector
object
2 properties
apiSdkNodeRelaxedReclaimPurgeResponse
object
1 property
apiSdkNodeCordonAttachmentsResponse
object
runtimeError
object
4 properties
SdkStoragePoolOperationStatus
string
- OPERATIONPENDING: Operation pending - OPERATIONINPROGRESS: Operation is in progress - OPERATIONSUCCESSFUL: Operation is successful - OPERATIONFAILED: Operati…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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