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

Portworx OpenStorageObjectstore API

The OpenStorageObjectstore API from Portworx — 3 operation(s) for openstorageobjectstore.

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

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

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

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

Paths & Operations 4

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

OpenStorageObjectstore 4
POST
/v1/objectstores
Creates creates an object store endpoint on specified volume
OpenStorageObjectstore_Create body → 200default
GET
/v1/objectstores/inspect/{objectstore_id}
Inspect returns information about the object store endpoint
OpenStorageObjectstore_Inspect 1 param → 200default
DELETE
/v1/objectstores/{objectstore_id}
Delete destroys the object store endpoint on the volume
OpenStorageObjectstore_Delete 1 param → 200default
PUT
/v1/objectstores/{objectstore_id}
Updates provided objectstore status. This call can be used to stop and start the server while maintaining the same object storage id.
OpenStorageObjectstore_Update 1 param body → 200default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are apiObjectstoreInfo (11 properties), runtimeError (4 properties), protobufAny (2 properties), apiSdkObjectstoreUpdateRequest (2 properties). Each schema is shown below with its type and property counts.

apiSdkObjectstoreDeleteResponse
object
protobufAny
object
2 properties
apiObjectstoreInfo
object
11 properties
apiSdkObjectstoreUpdateRequest
object
2 properties
apiSdkObjectstoreUpdateResponse
object
runtimeError
object
4 properties
apiSdkObjectstoreInspectResponse
object
1 property
apiSdkObjectstoreCreateRequest
object
1 property
apiSdkObjectstoreCreateResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portworx-openstorageobjectstore-api-openapi.yml Raw ↑

Other APIs Portworx publishes across the network.

Portworx OpenStorageAlerts API
Portworx OpenStorageBucket API
Portworx OpenStorageCloudBackup API
Portworx OpenStorageCluster API
Portworx OpenStorageClusterDomains API
Portworx OpenStorageClusterPair API
Portworx OpenStorageCredentials API
Portworx OpenStorageDiags API
Portworx OpenStorageFilesystemCheck API
Portworx OpenStorageFilesystemDefrag API
Portworx OpenStorageFilesystemTrim API
Portworx OpenStorageIdentity API
Where this information came from

This is an independent, third-party profile of Portworx OpenStorageObjectstore 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.