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

The OpenStorageCredentials API from Portworx — 5 operation(s) for openstoragecredentials.

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

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

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

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

Paths & Operations 7

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

OpenStorageCredentials 7
GET
/v1/credentials
Enumerate returns a list of credential ids
OpenStorageCredentials_Enumerate → 200default
POST
/v1/credentials
Create is used to submit cloud credentials. It will return an id of the credentials once they are verified to work.
OpenStorageCredentials_Create body → 200default
GET
/v1/credentials/inspect/{credential_id}
Inspect returns the information about a credential, but does not return the secret key.
OpenStorageCredentials_Inspect 1 param → 200default
DELETE
/v1/credentials/references/{credential_id}
DeleteReferences is used to remove references to credentials
OpenStorageCredentials_DeleteReferences 1 param → 200default
GET
/v1/credentials/validate/{credential_id}
Validate is used to validate credentials
OpenStorageCredentials_Validate 1 param → 200default
DELETE
/v1/credentials/{credential_id}
Delete a specified credential
OpenStorageCredentials_Delete 1 param → 200default
PUT
/v1/credentials/{credential_id}
input is very same as credential create
OpenStorageCredentials_Update 1 param body → 200default

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are apiSdkCredentialCreateRequest (11 properties), apiSdkCredentialInspectResponse (10 properties), apiSdkAwsCredentialRequest (7 properties), apiSdkAwsCredentialResponse (7 properties). Each schema is shown below with its type and property counts.

protobufAny
object
2 properties
apiSdkCredentialCreateRequest
object
11 properties
apiSdkCredentialInspectResponse
object
Defines the response to an inspection of a credential. This response uses OneOf proto style. Depending on your programming language you will need to check if t…
10 properties
apiSdkNfsCredentialRequest
object
4 properties
apiSdkCredentialUpdateRequest
object
2 properties
apiSdkCredentialUpdateResponse
object
apiSdkCredentialDeleteResponse
object
apiSdkAwsCredentialResponse
object
7 properties
apiSdkCredentialEnumerateResponse
object
1 property
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.…
apiSdkCredentialCreateResponse
object
1 property
OwnershipPublicAccessControl
object
1 property
apiSdkCredentialDeleteReferencesResponse
object
apiSdkAzureCredentialResponse
object
1 property
apiSdkNfsCredentialResponse
object
4 properties
apiSdkGoogleCredentialResponse
object
1 property
apiSdkAzureCredentialRequest
object
2 properties
apiSdkGoogleCredentialRequest
object
2 properties
apiOwnership
object
Ownership information for resource. Administrators are users who belong to the group , meaning, every group.
2 properties
apiSdkAwsCredentialRequest
object
7 properties
runtimeError
object
4 properties
apiSdkCredentialValidateResponse
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portworx-openstoragecredentials-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 OpenStorageDiags API
Portworx OpenStorageFilesystemCheck API
Portworx OpenStorageFilesystemDefrag API
Portworx OpenStorageFilesystemTrim API
Portworx OpenStorageIdentity API
Portworx OpenStorageJob API
Where this information came from

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