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

The OpenStorageFilesystemCheck API from Portworx — 6 operation(s) for openstoragefilesystemcheck.

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

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

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

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

Paths & Operations 6

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

OpenStorageFilesystemCheck 6
POST
/v1/filesystem-check/delete-snapshots
Delete all fsck created snapshots on volume
OpenStorageFilesystemCheck_DeleteSnapshots body → 200default
GET
/v1/filesystem-check/list-snapshots
List all fsck created snapshots on volume
OpenStorageFilesystemCheck_ListSnapshots 2 params → 200default
GET
/v1/filesystem-check/list-volumes
List of all volumes which require fsck check/fix to be run
OpenStorageFilesystemCheck_ListVolumes 1 param → 200default
POST
/v1/filesystem-check/start
Start a filesystem-check background operation on a unmounted volume.
OpenStorageFilesystemCheck_Start body → 200default
GET
/v1/filesystem-check/status
Get Status of a filesystem-check background operation on an unmounted volume, if any
OpenStorageFilesystemCheck_Status 1 param → 200default
POST
/v1/filesystem-check/stop
Stop a filesystem check background operation on an unmounted volume, if any
OpenStorageFilesystemCheck_Stop body → 200default

Schemas 15

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

apiSdkFilesystemCheckDeleteSnapshotsResponse
object
apiSdkFilesystemCheckDeleteSnapshotsRequest
object
2 properties
protobufAny
object
2 properties
apiFilesystemCheckVolInfo
object
3 properties
apiSdkFilesystemCheckStopResponse
object
apiFilesystemHealthStatus
string
apiSdkFilesystemCheckStartRequest
object
2 properties
apiSdkFilesystemCheckStopRequest
object
1 property
FilesystemCheckFilesystemCheckStatus
string
- FSCHECKUNKNOWN: Filesystem Check operation is an unknown state - FSCHECKNOTRUNNING: FilesystemCheck operation not running for the specified volume - FSCHECKS…
apiSdkFilesystemCheckListSnapshotsResponse
object
1 property
apiFilesystemCheckSnapInfo
object
1 property
runtimeError
object
4 properties
apiSdkFilesystemCheckListVolumesResponse
object
1 property
apiSdkFilesystemCheckStatusResponse
object
SdkFilesystemCheckStatusResponse defines the response for a SdkFilesystemCheckStatusRequest.
4 properties
apiSdkFilesystemCheckStartResponse
object
SdkFilesystemCheckStartResponse defines the response for a SdkFilesystemCheckStartRequest.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portworx-openstoragefilesystemcheck-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 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 OpenStorageFilesystemCheck 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.