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

Longhorn Backups API

Backup operations for storing volume snapshots to external storage targets such as S3-compatible storage or NFS. Backups can be restored to new volumes for disaster recovery.

Longhorn Backups API is one of 9 APIs that Longhorn publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Backups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and 1 JSON Schema.

This API exposes 4 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 1.11.

Requests are made against a single base URL, http://{longhornManagerHost}:{longhornManagerPort}.

4 operations 4 paths 8 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.11
Server
http://{longhornManagerHost}:{longhornManagerPort}
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Longhorn Backups API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Kubernetes service account token for authenticating with the Longhorn Manager API. Typically passed via the Kubernetes API proxy.

Paths & Operations 4

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

Backups 4

Backup operations for storing volume snapshots to external storage targets such as S3-compatible storage or NFS. Backups can be restored to new volumes for disaster recovery.

POST
/v1/volumes/{volumeName}?action=snapshotBackup
Longhorn Back up a snapshot
backupSnapshot 1 param body → 200400401
GET
/v1/backupvolumes
Longhorn List backup volumes
listBackupVolumes → 200401
GET
/v1/backupvolumes/{backupVolumeName}
Longhorn Get a backup volume
getBackupVolume 1 param → 200401404
GET
/v1/backupvolumes/{backupVolumeName}/backups
Longhorn List backups for a backup volume
listBackups 1 param → 200401

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Volume (19 properties), Replica (8 properties), Backup (8 properties), BackupVolume (7 properties). Each schema is shown below with its type and property counts.

Replica
object
A Longhorn replica instance storing a copy of volume data on a node.
8 properties
Volume
object
A Longhorn volume representing a block storage device that can be attached to Kubernetes nodes. Longhorn creates a dedicated storage controller and the configu…
19 properties
BackupVolumeCollection
object
A collection of backup volumes.
1 property
APIError
object
API error response.
4 properties
BackupCollection
object
A collection of backup resources.
1 property
Backup
object
A backup stored in the external backup target for a Longhorn volume snapshot.
8 properties
BackupInput
object
Input for backing up a snapshot to external storage.
2 properties 1 required
BackupVolume
object
A backup volume in the external backup store corresponding to a Longhorn volume.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

longhorn-backups-api-openapi.yml Raw ↑

Other APIs Longhorn publishes across the network.

Longhorn BackingImages API
Longhorn EngineImages API
Longhorn Nodes API
Longhorn RecurringJobs API
Longhorn Settings API
Longhorn Snapshots API
Longhorn SystemBackups API
Longhorn Volumes API
Where this information came from

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