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

The OpenStorageFilesystemTrim API from Portworx — 7 operation(s) for openstoragefilesystemtrim.

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

Tagged areas include OpenStorageFilesystemTrim. 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 7 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/.

7 operations 7 paths 15 schemas 3 GET4 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 OpenStorageFilesystemTrim 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 7 paths, the API surfaces 7 operations — 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

OpenStorageFilesystemTrim 7
POST
/v1/filesystem-trim/auto-fstrim-pop
Pop a auto filesystem Trim job from the queue
OpenStorageFilesystemTrim_AutoFSTrimPop body → 200default
POST
/v1/filesystem-trim/auto-fstrim-push
Push a auto filesystem Trim job into the queue
OpenStorageFilesystemTrim_AutoFSTrimPush body → 200default
GET
/v1/filesystem-trim/auto-fstrim-status
OpenStorageFilesystemTrim_AutoFSTrimStatus → 200default
GET
/v1/filesystem-trim/auto-fstrim-usage
Usage of a filesystem Trim background operation on all locally mounted volume
OpenStorageFilesystemTrim_AutoFSTrimUsage → 200default
POST
/v1/filesystem-trim/start
Start a filesystem Trim background operation on a mounted volume
OpenStorageFilesystemTrim_Start body → 200default
GET
/v1/filesystem-trim/status
Status of a filesystem Trim background operation on a mounted volume, if any
OpenStorageFilesystemTrim_Status 2 params → 200default
POST
/v1/filesystem-trim/stop
Stop a filesystem Trim background operation on a mounted volume, if any
OpenStorageFilesystemTrim_Stop body → 200default

Schemas 15

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

apiSdkAutoFSTrimPushRequest
object
1 property
apiSdkFilesystemTrimStartResponse
object
SdkFilesystemTrimStartResponse defines the response for a SdkFilesystemTrimStartRequest.
2 properties
protobufAny
object
2 properties
FilesystemTrimFilesystemTrimStatus
string
- FSTRIMUNKNOWN: Filesystem Trim operation is an unknown state - FSTRIMNOTRUNNING: Filesystem Trim operation is not running for the specified volume - FSTRIMST…
apiSdkAutoFSTrimPopResponse
object
1 property
apiFstrimVolumeUsageInfo
object
5 properties
apiSdkFilesystemTrimStopRequest
object
2 properties
apiSdkAutoFSTrimPushResponse
object
1 property
apiSdkAutoFSTrimUsageResponse
object
SdkAutoFSTrimUsageResponse defines the response for a SdkAutoFSTrimUsageRequest.
2 properties
apiSdkAutoFSTrimStatusResponse
object
SdkAutoFSTrimStatusResponse defines the response for a SdkAutoFSTrimStatusRequest.
2 properties
apiSdkFilesystemTrimStopResponse
object
apiSdkAutoFSTrimPopRequest
object
1 property
apiSdkFilesystemTrimStatusResponse
object
SdkFilesystemTrimStatusResponse defines the response for a SdkFilesystemTrimStatusRequest.
2 properties
runtimeError
object
4 properties
apiSdkFilesystemTrimStartRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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