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

The OpenStorageRole API from Portworx — 3 operation(s) for openstoragerole.

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

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

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

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

Paths & Operations 5

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

OpenStorageRole 5
GET
/v1/roles
List all roles
OpenStorageRole_Enumerate → 200default
POST
/v1/roles
Create a role for users in the system
OpenStorageRole_Create body → 200default
PUT
/v1/roles
Update an existing role
OpenStorageRole_Update body → 200default
GET
/v1/roles/inspect/{name}
Get information about a role
OpenStorageRole_Inspect 1 param → 200default
DELETE
/v1/roles/{name}
Delete an existing role
OpenStorageRole_Delete 1 param → 200default

Schemas 11

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

protobufAny
object
2 properties
apiSdkRoleEnumerateResponse
object
1 property
apiSdkRole
object
2 properties
apiSdkRule
object
SdkRule is the message used to construct custom roles in the OpenStorage SDK. Format The following shows the supported format for SdkRule: Services: Is the gRP…
2 properties
apiSdkRoleCreateResponse
object
1 property
apiSdkRoleDeleteResponse
object
apiSdkRoleCreateRequest
object
1 property
apiSdkRoleUpdateRequest
object
1 property
runtimeError
object
4 properties
apiSdkRoleInspectResponse
object
1 property
apiSdkRoleUpdateResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portworx-openstoragerole-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 OpenStorageRole 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.