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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Portworx

Portworx OpenStorageCloudBackup API

The OpenStorageCloudBackup API from Portworx — 13 operation(s) for openstoragecloudbackup.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

Paths & Operations 15

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

OpenStorageCloudBackup 15
POST
/v1/cloudbackups
Creates a backup request for a specified volume. Use OpenStorageCloudBackup.Status() to get the current status of the backup request.
OpenStorageCloudBackup_Create body → 200default
DELETE
/v1/cloudbackups/backup/{backup_id}
Deletes a backup stored in the cloud. If the backup is an incremental backup and other backups are dependent on it, it will not be able to be deleted.
OpenStorageCloudBackup_Delete 4 params → 200default
POST
/v1/cloudbackups/catalog
Catalog returns a list of the contents in the backup
OpenStorageCloudBackup_Catalog body → 200default
POST
/v1/cloudbackups/deleteall
DeleteAll deletes all the backups in the cloud for the specified volume.
OpenStorageCloudBackup_DeleteAll body → 200default
POST
/v1/cloudbackups/enumerate/filters
Return a list of backups for the specified volume
OpenStorageCloudBackup_EnumerateWithFilters body → 200default
POST
/v1/cloudbackups/group
Creates a group backup request for a specified group. Use OpenStorageCloudBackup.Status() to get the current status of the backup request.
OpenStorageCloudBackup_GroupCreate body → 200default
GET
/v1/cloudbackups/history/{src_volume_id}
History returns a list of backups for a specified volume
OpenStorageCloudBackup_History 1 param → 200default
POST
/v1/cloudbackups/restore
Restore creates a new volume from a backup id. The newly created volume has an halevel (number of replicas) of only 1. To increase the number of replicas, use OpenStorageVolume.Set() to change the ha…
OpenStorageCloudBackup_Restore body → 200default
GET
/v1/cloudbackups/schedules
Enumerate cloud backup schedules
OpenStorageCloudBackup_SchedEnumerate → 200default
POST
/v1/cloudbackups/schedules
Create cloud backup schedule
OpenStorageCloudBackup_SchedCreate body → 200default
PUT
/v1/cloudbackups/schedules
Update existing cloud backup schedule
OpenStorageCloudBackup_SchedUpdate body → 200default
DELETE
/v1/cloudbackups/schedules/{backup_schedule_id}
Delete cloud backup schedule
OpenStorageCloudBackup_SchedDelete 1 param → 200default
GET
/v1/cloudbackups/size
Size returns the size of any cloud backups of a volume
OpenStorageCloudBackup_Size 2 params → 200default
POST
/v1/cloudbackups/statechange
StateChange can be used to stop, pause, and restart a backup
OpenStorageCloudBackup_StateChange body → 200default
POST
/v1/cloudbackups/status
Status returns the status of any cloud backups of a volume
OpenStorageCloudBackup_Status body → 200default

Schemas 76

The contract defines 76 schemas that model the data the API accepts and returns. The most detailed are apiRestoreVolumeSpec (31 properties), apiSdkCloudBackupStatus (13 properties), apiSdkCloudBackupEnumerateWithFiltersRequest (10 properties), apiSdkCloudBackupScheduleInfo (8 properties). Each schema is shown below with its type and property counts.

apiPureFileSpec
object
3 properties
protobufAny
object
2 properties
apiSdkCloudBackupScheduleInfo
object
8 properties
apiSdkCloudBackupStatusResponse
object
1 property
apiIoThrottle
object
4 properties
apiSdkCloudBackupStateChangeRequest
object
2 properties
apiSdkCloudBackupHistoryItem
object
3 properties
apiRestoreVolSnashotSchedule
object
1 property
apiSdkCloudBackupStatus
object
13 properties
apiIoProfile
string
apiSdkCloudBackupEnumerateWithFiltersResponse
object
2 properties
apiSdkCloudBackupEnumerateWithFiltersRequest
object
For a specific volume in current cluster: Set srcvolumeid to your desired volume id and do not provide clusterid and all. For a specific volume in a specific c…
10 properties
apiSdkCloudBackupInfo
object
8 properties
apiSdkCloudBackupGroupCreateResponse
object
2 properties
Sharedv4ServiceSpecServiceType
string
Type of sharedv4 service. Values are governed by the different types of services supported by container orchestrators such as Kubernetes. - UNSPECIFIED: Unspec…
apiSdkCloudBackupSchedCreateRequest
object
1 property
apiSdkCloudBackupSchedDeleteResponse
object
apiReplicaSet
object
3 properties
apiSdkCloudBackupRestoreResponse
object
2 properties
apiSdkCloudBackupOpType
string
- SdkCloudBackupOpTypeUnknown: Unknown - SdkCloudBackupOpTypeBackupOp: Backup - SdkCloudBackupOpTypeRestoreOp: Restore - SdkNearSyncOpTypeCloneOp: NearSync clo…
apiSdkCloudBackupCatalogResponse
object
1 property
apiNFSProxySpec
object
NFSProxySpec is the spec for proxying an NFS share.
2 properties
apiSdkCloudBackupRequestedState
string
- SdkCloudBackupRequestedStateUnknown: Unknown state - SdkCloudBackupRequestedStatePause: Pause the backup or restore - SdkCloudBackupRequestedStateResume: Res…
apiSdkCloudBackupClusterType
string
- SdkCloudBackupClusterUnknown: Unknown - SdkCloudBackupClusterCurrent: Beongs to this cluster - SdkCloudBackupClusterOther: not this. other cluster
apiSdkCloudBackupStatusType
string
- SdkCloudBackupStatusTypeUnknown: Unknown - SdkCloudBackupStatusTypeNotStarted: Not started - SdkCloudBackupStatusTypeDone: Done - SdkCloudBackupStatusTypeAbo…
apiProxyProtocol
string
ProxyProtocol defines the protocol used for proxy. - PROXYPROTOCOLINVALID: Invalid uninitialized value - PROXYPROTOCOLNFS: NFS indicates that the external data…
apiSdkCloudBackupCreateResponse
object
1 property
apiVolumeLocator
object
VolumeLocator is a structure that is attached to a volume and is used to carry opaque metadata.
5 properties
apiSharedv4Spec
object
1 property
apiSdkCloudBackupDeleteAllRequest
object
2 properties
apiSdkSchedulePolicyIntervalWeekly
object
3 properties
apiSdkCloudBackupSchedUpdateResponse
object
apiCosType
string
apiSdkCloudBackupRestoreRequest
object
7 properties
apiSdkTimeWeekday
string
- SdkTimeWeekdaySunday: Sunday - SdkTimeWeekdayMonday: Monday - SdkTimeWeekdayTuesday: Tuesday - SdkTimeWeekdayWednesday: Wednesday - SdkTimeWeekdayThursday: T…
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.…
apiRestoreParamBoolType
string
apiS3ProxySpec
object
S3ProxySpec is the spec for proxying an external object store.
1 property
apiSharedv4FailoverStrategyValue
string
- UNSPECIFIED: Unspecified - AGGRESSIVE: Fail over to the new NFS server quickly. This is appropriate for the apps with sharedv4 service volumes. It can also b…
apiRestoreVolStoragePolicy
object
1 property
OwnershipPublicAccessControl
object
1 property
apiSdkSchedulePolicyIntervalDaily
object
2 properties
apiLabelSelectorRequirement
object
LabelSelectorRequirement is a selector that contains values, a key, and an operator that relates the key and values.
3 properties
apiExportSpec
object
ExportSpec defines how the volume is exported..
2 properties
apiIoStrategy
object
IoStrategy defines how I/O should be performed to backing storage media.
3 properties
LabelSelectorRequirementOperator
string
- In: In means the value for 'key' should be in one of the given value(s) - NotIn: NotIn means the value for 'key' should NOT be in one of the given value(s) -…
apiSdkCloudBackupCatalogRequest
object
2 properties
apiSdkCloudBackupDeleteResponse
object
apiExportProtocol
string
ExportProtocol defines how the device is exported.. - INVALID: Invalid uninitialized value - PXD: PXD the volume is exported over Portworx block interface. - I…
apiProxySpec
object
ProxySpec defines how this volume will reflect an external data source.
7 properties
apiSdkSchedulePolicyInterval
object
5 properties
apiSdkCloudBackupStatusRequest
object
4 properties
apiSharedv4ServiceSpec
object
Sharedv4ServiceSpec when set, creates a service endpoint for accessing a sharedv4 volume.
3 properties
apiSdkSchedulePolicyIntervalPeriodic
object
1 property
apiSdkCloudBackupSchedCreateResponse
object
1 property
apiSdkCloudBackupSchedUpdateRequest
object
2 properties
apiRestoreVolumeSpec
object
RestoreSpec allows some of the restore volume properties of to be modified while restoring the cloud baackup. All pointer fields with nil value will inherit co…
31 properties
apiMountOptions
object
MountOptions defines the mount options with which a volume is mounted.
1 property
apiGroup
object
Group represents VolumeGroup / namespace All volumes in the same group share this object.
1 property
apiSdkCloudBackupSizeResponse
object
4 properties
apiSdkCloudBackupCreateRequest
object
8 properties
apiOwnership
object
Ownership information for resource. Administrators are users who belong to the group , meaning, every group.
2 properties
apiSdkSchedulePolicyIntervalMonthly
object
3 properties
apiVolumePlacementSpec
object
4 properties
apiSdkCloudBackupStateChangeResponse
object
apiSdkCloudBackupGroupCreateRequest
object
6 properties
apiSdkCloudBackupHistoryResponse
object
1 property
apiReplicaPlacementSpec
object
5 properties
apiPureBlockSpec
object
3 properties
apiPXDProxySpec
object
1 property
apiSdkCloudBackupDeleteAllResponse
object
runtimeError
object
4 properties
apiVolumePlacementStrategy
object
VolumePlacementStrategy defines a strategy for placing volumes in the cluster which will be a series of rules All the rules specified will be applied for volum…
4 properties
apiSdkCloudBackupSchedEnumerateResponse
object
1 property
apiEnforcementType
string
- required: This specifies that the rule is required and must be strictly enforced - preferred: This specifies that the rule is preferred and can be best effort

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portworx-openstoragecloudbackup-api-openapi.yml Raw ↑

Other APIs Portworx publishes across the network.

Portworx OpenStorageAlerts API
AE Profile APIs.io
Portworx OpenStorageBucket API
AE Profile APIs.io
Portworx OpenStorageCluster API
AE Profile APIs.io
Portworx OpenStorageClusterDomains API
AE Profile APIs.io
Portworx OpenStorageClusterPair API
AE Profile APIs.io
Portworx OpenStorageCredentials API
AE Profile APIs.io
Portworx OpenStorageDiags API
AE Profile APIs.io
Portworx OpenStorageFilesystemCheck API
AE Profile APIs.io
Portworx OpenStorageFilesystemDefrag API
AE Profile APIs.io
Portworx OpenStorageFilesystemTrim API
AE Profile APIs.io
Portworx OpenStorageIdentity API
AE Profile APIs.io
Portworx OpenStorageJob API
AE Profile APIs.io
#OpenStorageCloudBackup
← Back to P APIs
API Details
ID
portworx:portworx-openstoragecloudbackup-api
Base URL
https://libopenstorage.github.io/
Docs
https://portworx.com/
Provider
Portworx
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=portworx-openstoragecloudbackup-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/portworx-openstoragecloudbackup-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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