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

The OpenStorageJob API from Portworx — 2 operation(s) for openstoragejob.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 3 operations across 2 paths, and defines 24 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/.

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

Paths & Operations 3

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

OpenStorageJob 3
GET
/v1/jobs
Enumerate returns all the jobs currently known to the system
OpenStorageJob_Enumerate 1 param → 200default
GET
/v1/jobs/{id}
GetStatus gets the status of a job
OpenStorageJob_GetStatus 2 params → 200default
PUT
/v1/jobs/{id}
Update updates an existing job's state Only acceptable state values are JobStatePAUSED - acceptable only from running state JobStateCANCELLED - acceptable only from running/pause state JobStateRUNNIN…
OpenStorageJob_Update 1 param body → 200default

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are apiJob (9 properties), apiDefragJob (8 properties), apiSdkDiagsCollectRequest (7 properties), apiNodeDrainAttachmentsJob (6 properties). Each schema is shown below with its type and property counts.

protobufAny
object
2 properties
apiSdkDiagsCollectRequest
object
7 properties
apiJobType
string
- UNSPECIFIEDTYPE: Unspecified - NONE: None - DRAINATTACHMENTS: Job for draining volume attachments - CLOUDDRIVETRANSFER: Job for transferring cloud drives bet…
apiDiagsNodeSelector
object
3 properties
apiSdkGetJobStatusResponse
object
2 properties
apiCollectDiagsJob
object
2 properties
apiNodeDrainAttachmentsJob
object
6 properties
apiDiagsCollectionStatusState
string
- UNSPECIFIED: Unspecified means uninitialized or unknown state - PENDING: Pending indicates the diags collection is pending and hasn't started - RUNNING: Runn…
apiJobWorkSummary
object
1 property
apiSdkUpdateJobRequest
object
3 properties
apiSdkUpdateJobResponse
object
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
apiDefragJob
object
8 properties
apiDrainAttachmentsSummary
object
3 properties
apiSdkEnumerateJobsResponse
object
1 property
apiDiagsVolumeSelector
object
2 properties
apiJobSummary
object
3 properties
apiSdkNodeDrainAttachmentsRequest
object
4 properties
runtimeError
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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