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

The OpenStorageAlerts API from Portworx — 2 operation(s) for openstoragealerts.

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

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

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

2 operations 2 paths 17 schemas 2 POST

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

Paths & Operations 2

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

OpenStorageAlerts 2
POST
/v1/alerts
Delete alerts
OpenStorageAlerts_Delete body → 200default
POST
/v1/alerts/filters
Allows querying alerts.
OpenStorageAlerts_EnumerateWithFilters body → 200default

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are apiAlert (12 properties), runtimeStreamError (5 properties), apiSdkAlertsOption (4 properties), apiSdkAlertsQuery (4 properties). Each schema is shown below with its type and property counts.

apiSdkAlertsCountSpan
object
SdkAlertsCountSpan to store count range information.
2 properties
apiSdkAlertsEnumerateWithFiltersResponse
object
SdkAlertsEnumerateResponse is a list of alerts.
1 property
protobufAny
object
2 properties
apiAlert
object
12 properties
runtimeStreamError
object
5 properties
apiSdkAlertsOption
object
SdkAlertsOption contains options for filtering alerts.
4 properties
apiSdkAlertsDeleteRequest
object
SdkAlertsDeleteRequest is a request message to delete alerts.
1 property
apiSdkAlertsResourceIdQuery
object
SdkAlertsResourceIdQuery queries for alerts using resource id and it requires that both alert type and resource type be provided as well.
3 properties
apiSeverityType
string
apiSdkAlertsDeleteResponse
object
SdkAlertsDeleteResponse is empty.
apiSdkAlertsResourceTypeQuery
object
SdkAlertsResourceTypeQuery queries for alerts using only resource id.
1 property
apiSdkAlertsQuery
object
SdkAlertsQuery is one of the query types and a list of options. Each query object is one of the three query types and a list of options.
4 properties
runtimeError
object
4 properties
apiResourceType
string
apiSdkAlertsAlertTypeQuery
object
SdkAlertsAlertTypeQuery queries for alerts using alert type and it requires that resource type be provided as well.
2 properties
apiSdkAlertsTimeSpan
object
SdkAlertsTimeSpan to store time window information.
2 properties
apiSdkAlertsEnumerateWithFiltersRequest
object
SdkAlertsEnumerateRequest is a request message to enumerate alerts.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portworx-openstoragealerts-api-openapi.yml Raw ↑

Other APIs Portworx publishes across the network.

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
Portworx OpenStorageJob API
Where this information came from

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