Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Weaviate backups API

The backups API from Weaviate — 3 operation(s) for backups.

Weaviate backups API is one of 22 APIs that Weaviate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 7 operations across 3 paths, and defines 10 schemas. It is described by OpenAPI 3.0.3, at version 1.38.0-dev.

Requests are made against a single base URL, http://localhost:8080.

7 operations 3 paths 10 schemas 2 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.38.0-dev
Server
http://localhost:8080
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Weaviate backups API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key authentication
  • BearerAuth — OIDC/JWT bearer authentication

Paths & Operations 7

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

backups 7
POST
/backups/{backend}
Weaviate Create A Backup
backups.create 1 param body → 200401403422500
GET
/backups/{backend}
Weaviate List All Created Backups
backups.list 2 params → 200401403422500
GET
/backups/{backend}/{id}
Weaviate Get Backup Creation Status
backups.create.status 4 params → 200401403404422500
DELETE
/backups/{backend}/{id}
Weaviate Cancel A Backup
backups.cancel 4 params → 204401403422500
POST
/backups/{backend}/{id}/restore
Weaviate Restore From A Backup
backups.restore 2 params body → 200401403404422500
GET
/backups/{backend}/{id}/restore
Weaviate Get Backup Restoration Status
backups.restore.status 4 params → 200401403404500
DELETE
/backups/{backend}/{id}/restore
Weaviate Cancel A Backup Restoration
backups.restore.cancel 4 params → 204401403422500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are BackupCreateStatusResponse (8 properties), BackupCreateResponse (7 properties), BackupConfig (6 properties), BackupRestoreResponse (6 properties). Each schema is shown below with its type and property counts.

BackupRestoreStatusResponse
object
The definition of a backup restore metadata.
5 properties
BackupRestoreRequest
object
Request body for restoring a backup for a set of collections (classes).
5 properties
BackupCreateStatusResponse
object
The definition of a backup create metadata
8 properties
BackupCreateRequest
object
Request body for creating a backup for a set of collections.
5 properties
BackupCreateResponse
object
The definition of a backup create response body
7 properties
BackupListResponse
array
The definition of a backup create response body.
RestoreConfig
object
Backup custom configuration
6 properties
BackupRestoreResponse
object
The definition of a backup restore response body.
6 properties
ErrorResponse
object
An error response returned by Weaviate endpoints.
1 property
BackupConfig
object
Backup custom configuration.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weaviate-backups-api-openapi.yml Raw ↑

Other APIs Weaviate publishes across the network.

Weaviate authz API
Weaviate batch API
Weaviate classifications API
Weaviate cluster API
Weaviate discovery API
Weaviate distributedTasks API
Weaviate export API
Weaviate graphql API
Weaviate mcp API
Weaviate meta API
Weaviate namespaces API
Weaviate nodes API