Skip to content

REST endpoints

Overview

Path Middleware Input Output Notes
GET /api_v2/database/export authenticated
GET /api_v2/database/export_sha256s authenticated
GET /api_v2/serverinfo public ServerInfo
GET /api_v2/serverinfo/subsystem_statuses public SubsystemStatus[]
GET /api_v2/collections/{id} public TODO: type
GET /api_v2/collections/{id}/{rev}/dir/{path} public CollectionOutput
GET /api_v2/collections/{id}/{rev}/dl public Downloads a file from specific revision
POST /api_v2/collections/{id}/changesets public Changeset
POST /api_v2/collections/{id}/fileupload public File
GET /api_v2/directories/{id} public DirectoryOutput
GET /api_v2/blobs/{ref}?collId={collId} public TODO: type
POST /api_v2/blobs/{ref}?collection={collection}&maybe_compressible={maybeCompressible} public
GET /api_v2/blobs/{ref}/meta public BlobMetadata
GET /api_v2/replication_progress public ReplicationStatus[]
GET /api_v2/nodes public Node[]
GET /api_v2/keyencryptionkeys public KeyEncryptionKey[]
GET /api_v2/volumes public Volume[] Only returns non-decommissioned volumes
GET /api_v2/volumes_decommissioned public Volume[]
GET /api_v2/volumes_search?q={q} public Volume[]
GET /api_v2/reconciliation public ReconciliationReport
GET /api_v2/ubackup/storedbackups public UbackupStoredBackup[]
GET /api_v2/ubackup/storedbackups/dl?id={id} public
GET /api_v2/volumemounts public VolumeMount[]
GET /api_v2/api_keys public ApiKey[]
GET /api_v2/scheduler/jobs public SchedulerJob[]
GET /api_v2/integrityverificationjobs public IntegrityVerificationJob[]
GET /api_v2/generate_ids public GeneratedIds Ask server for assistance in generating identifiers
GET /api_v2/health public Health
GET /api_v2/config/{id} public ConfigValue
GET /api_v2/logs public string[]
GET /api_v2/external/tmdb/movies?q={query} public TmdbSearchResult[]
GET /api_v2/external/tmdb/tv?q={query} public TmdbSearchResult[]
GET /api_v2/external/igdb/games?q={query} public MetadataIgdbGame[]
GET /api_v2/external/igdb/game-redir/{id} public
GET /api_v2/replicationpolicies_for_directories public ReplicationPolicyForDirectory[]
GET /api_v2/replicationpolicies_search?q={query} public ReplicationPolicy[]
GET /api_v2/replicationpolicies public ReplicationPolicy[]

GET /api_v2/database/export

Detail
Middleware chain authenticated
Consumes
Produces
Description

GET /api_v2/database/export_sha256s

Detail
Middleware chain authenticated
Consumes
Produces
Description

GET /api_v2/serverinfo

Detail
Middleware chain public
Consumes
Produces ServerInfo
Description

GET /api_v2/serverinfo/subsystem_statuses

Detail
Middleware chain public
Consumes
Produces SubsystemStatus[]
Description

GET /api_v2/collections/{id}

Detail
Middleware chain public
Consumes
Produces
Description TODO: type

GET /api_v2/collections/{id}/{rev}/dir/{path}

Detail
Middleware chain public
Consumes
Produces CollectionOutput
Description

GET /api_v2/collections/{id}/{rev}/dl

Detail
Middleware chain public
Consumes
Produces
Description Downloads a file from specific revision

POST /api_v2/collections/{id}/changesets

Detail
Middleware chain public
Consumes Changeset
Produces
Description

POST /api_v2/collections/{id}/fileupload

Detail
Middleware chain public
Consumes
Produces File
Description

GET /api_v2/directories/{id}

Detail
Middleware chain public
Consumes
Produces DirectoryOutput
Description

GET /api_v2/blobs/{ref}?collId={collId}

Detail
Middleware chain public
Consumes
Produces
Description TODO: type

POST /api_v2/blobs/{ref}?collection={collection}&maybe_compressible={maybeCompressible}

Detail
Middleware chain public
Consumes
Produces
Description

GET /api_v2/blobs/{ref}/meta

Detail
Middleware chain public
Consumes
Produces BlobMetadata
Description

GET /api_v2/replication_progress

Detail
Middleware chain public
Consumes
Produces ReplicationStatus[]
Description

GET /api_v2/nodes

Detail
Middleware chain public
Consumes
Produces Node[]
Description

GET /api_v2/keyencryptionkeys

Detail
Middleware chain public
Consumes
Produces KeyEncryptionKey[]
Description

GET /api_v2/volumes

Detail
Middleware chain public
Consumes
Produces Volume[]
Description Only returns non-decommissioned volumes

GET /api_v2/volumes_decommissioned

Detail
Middleware chain public
Consumes
Produces Volume[]
Description

GET /api_v2/volumes_search?q={q}

Detail
Middleware chain public
Consumes
Produces Volume[]
Description

GET /api_v2/reconciliation

Detail
Middleware chain public
Consumes
Produces ReconciliationReport
Description

GET /api_v2/ubackup/storedbackups

Detail
Middleware chain public
Consumes
Produces UbackupStoredBackup[]
Description

GET /api_v2/ubackup/storedbackups/dl?id={id}

Detail
Middleware chain public
Consumes
Produces
Description

GET /api_v2/volumemounts

Detail
Middleware chain public
Consumes
Produces VolumeMount[]
Description

GET /api_v2/api_keys

Detail
Middleware chain public
Consumes
Produces ApiKey[]
Description

GET /api_v2/scheduler/jobs

Detail
Middleware chain public
Consumes
Produces SchedulerJob[]
Description

GET /api_v2/integrityverificationjobs

Detail
Middleware chain public
Consumes
Produces IntegrityVerificationJob[]
Description

GET /api_v2/generate_ids

Detail
Middleware chain public
Consumes
Produces GeneratedIds
Description Ask server for assistance in generating identifiers

GET /api_v2/health

Detail
Middleware chain public
Consumes
Produces Health
Description

GET /api_v2/config/{id}

Detail
Middleware chain public
Consumes
Produces ConfigValue
Description

GET /api_v2/logs

Detail
Middleware chain public
Consumes
Produces string[]
Description

GET /api_v2/external/tmdb/movies?q={query}

Detail
Middleware chain public
Consumes
Produces TmdbSearchResult[]
Description

GET /api_v2/external/tmdb/tv?q={query}

Detail
Middleware chain public
Consumes
Produces TmdbSearchResult[]
Description

GET /api_v2/external/igdb/games?q={query}

Detail
Middleware chain public
Consumes
Produces MetadataIgdbGame[]
Description

GET /api_v2/external/igdb/game-redir/{id}

Detail
Middleware chain public
Consumes
Produces
Description

GET /api_v2/replicationpolicies_for_directories

Detail
Middleware chain public
Consumes
Produces ReplicationPolicyForDirectory[]
Description

GET /api_v2/replicationpolicies_search?q={query}

Detail
Middleware chain public
Consumes
Produces ReplicationPolicy[]
Description

GET /api_v2/replicationpolicies

Detail
Middleware chain public
Consumes
Produces ReplicationPolicy[]
Description