Backups API

Base URL: https://api.theonebackups.app

Authentication

Most endpoints require a valid session cookie or integration key. Endpoints marked Public require no authentication.

Endpoints Summary

76 endpoints discovered across 2 function app(s).

Method	Route	Auth
POST	/api/agents/{action}	Public
GET	/api/auth/portal-sso	Public
POST	/api/auth/portal-sso	Public
GET	/api/backup/catalog	Session
POST	/api/backup/catalog	Session
GET	/api/backup/dashboard-widget	Integration Key
GET	/api/backup/jobs	Session
POST	/api/backup/jobs	Session
GET	/api/backup/jobs?action=company_summary&company_id=X	Session
GET	/api/backup/jobs?action=dashboard	Session
GET	/api/backup/jobs?action=device_status&device_id=X	Session
GET	/api/backup/jobs/{id}	Session
PUT	/api/backup/metering	Session
GET	/api/backup/metering?action=estimate&company_id=X	Session
GET	/api/backup/metering?action=pricing	Session
GET	/api/backup/metering?action=summary&year=Y&month=M	Session
GET	/api/backup/metering?action=usage&year=Y&month=M	Session
POST	/api/backup/permissions/register	Integration Key
GET	/api/backup/policies	Session
POST	/api/backup/policies	Session
GET	/api/backup/policies?action=resolve&device_id=X	Session
GET	/api/backup/policies?action=templates	Session
GET	/api/backup/policies/{id}	Session
GET	/api/brand/theme	Integration Key
GET	/api/bridge/jobs	Integration Key
POST	/api/bridge/jobs	Integration Key
GET	/api/bridge/jobs/{id}	Integration Key
GET	/api/bridge/restores	Integration Key
POST	/api/bridge/restores	Integration Key
GET	/api/bridge/schedules	Integration Key
POST	/api/integration/alert	Session
GET	/api/integration/client/activity?client_id=X&since=ISO_DATE	Integration Key
GET	/api/integration/client/health?client_id=X	Integration Key
GET	/api/integration/client/status?client_id=X	Integration Key
GET	/api/integration/health	Session
GET	/api/internal/devices/{deviceId}/backup-status	Session
POST	/api/internal/restore/rewind	Session
GET	/api/internal/restore/rewind/{jobId}	Session
GET	/api/notification-settings	Session
PATCH	/api/notification-settings	Session
GET	/api/portal/status	Session
GET	/api/restore-permissions/{tenantId}	Session
POST	/api/restore-permissions/{tenantId}	Session
DELETE	/api/restore-permissions/{tenantId}/{userEmail}	Session
GET	/api/retention-defaults	Session
PATCH	/api/retention-defaults	Session
POST	/api/saas/browse	Session
GET	/api/saas/browse?action=items	Session
GET	/api/saas/browse?action=restore-history	Session
GET	/api/saas/browse?action=restore-status&id=X	Session
GET	/api/saas/browse?action=search	Session
GET	/api/saas/browse?action=users	Session
GET	/api/saas/browse?action=versions&id=X	Session
POST	/api/saas/connections	Session
GET	/api/saas/connections?action=get&id=X	Session
GET	/api/saas/connections?action=list	Session
GET	/api/saas/connections?action=oauth-url&provider=X	Session
POST	/api/saas/jobs	Session
GET	/api/saas/jobs?action=dashboard	Session
GET	/api/saas/jobs?action=get&id=X	Session
GET	/api/saas/jobs?action=list	Session
POST	/api/saas/policies	Session
GET	/api/saas/policies?action=get&id=X	Session
GET	/api/saas/policies?action=list	Session
GET	/api/search?q=...&tenant_id=...	Integration Key
POST	/api/vendor/config	Session
GET	/api/vendor/config?action=get&id=X	Session
GET	/api/vendor/config?action=list	Session
GET	/api/vendor/config?action=mapping&id=X	Session
POST	/api/vendor/monitoring	Session
GET	/api/vendor/monitoring?action=alerts	Session
GET	/api/vendor/monitoring?action=companies	Session
GET	/api/vendor/monitoring?action=dashboard	Session
GET	/api/vendor/monitoring?action=device&id=X	Session
GET	/api/vendor/monitoring?action=devices	Session
GET	/api/vendor/monitoring?action=jobs	Session

Endpoint Details

Agents

POST/api/agents/{action}

Create agents

Auth: Public

Auth

GET/api/auth/portal-sso

List or retrieve portal sso

Auth: Public

POST/api/auth/portal-sso

Create portal sso

Auth: Public

Backup

GET/api/backup/catalog

List or retrieve catalog

Auth: Session

POST/api/backup/catalog

Create catalog

Auth: Session

GET/api/backup/dashboard-widget

List or retrieve dashboard widget

Auth: Integration Key

GET/api/backup/jobs

List or retrieve jobs

Auth: Session

POST/api/backup/jobs

Create jobs

Auth: Session

GET/api/backup/jobs?action=company_summary&company_id=X

List or retrieve jobs?action=company_summary&company_id=X

Auth: Session

GET/api/backup/jobs?action=dashboard

List or retrieve jobs?action=dashboard

Auth: Session

GET/api/backup/jobs?action=device_status&device_id=X

List or retrieve jobs?action=device_status&device_id=X

Auth: Session

GET/api/backup/jobs/{id}

List or retrieve jobs

Auth: Session

PUT/api/backup/metering

Update metering

Auth: Session

GET/api/backup/metering?action=estimate&company_id=X

List or retrieve metering?action=estimate&company_id=X

Auth: Session

GET/api/backup/metering?action=pricing

List or retrieve metering?action=pricing

Auth: Session

GET/api/backup/metering?action=summary&year=Y&month=M

List or retrieve metering?action=summary&year=Y&month=M

Auth: Session

GET/api/backup/metering?action=usage&year=Y&month=M

List or retrieve metering?action=usage&year=Y&month=M

Auth: Session

POST/api/backup/permissions/register

Create register

Auth: Integration Key

GET/api/backup/policies

List or retrieve policies

Auth: Session

POST/api/backup/policies

Create policies

Auth: Session

GET/api/backup/policies?action=resolve&device_id=X

List or retrieve policies?action=resolve&device_id=X

Auth: Session

GET/api/backup/policies?action=templates

List or retrieve policies?action=templates

Auth: Session

GET/api/backup/policies/{id}

List or retrieve policies

Auth: Session

Brand

GET/api/brand/theme

List or retrieve theme

Auth: Integration Key

Bridge

GET/api/bridge/jobs

List or retrieve jobs

Auth: Integration Key

POST/api/bridge/jobs

Create jobs

Auth: Integration Key

GET/api/bridge/jobs/{id}

List or retrieve jobs

Auth: Integration Key

GET/api/bridge/restores

List or retrieve restores

Auth: Integration Key

POST/api/bridge/restores

Create restores

Auth: Integration Key

GET/api/bridge/schedules

List or retrieve schedules

Auth: Integration Key

Integration

POST/api/integration/alert

Create alert

Auth: Session

GET/api/integration/client/activity?client_id=X&since=ISO_DATE

List or retrieve activity?client_id=X&since=ISO_DATE

Auth: Integration Key

GET/api/integration/client/health?client_id=X

List or retrieve health?client_id=X

Auth: Integration Key

GET/api/integration/client/status?client_id=X

List or retrieve status?client_id=X

Auth: Integration Key

GET/api/integration/health

List or retrieve health

Auth: Session

Internal

GET/api/internal/devices/{deviceId}/backup-status

List or retrieve backup status

Auth: Session

POST/api/internal/restore/rewind

Create rewind

Auth: Session

GET/api/internal/restore/rewind/{jobId}

List or retrieve rewind

Auth: Session

Notification Settings

GET/api/notification-settings

List or retrieve notification settings

Auth: Session

PATCH/api/notification-settings

Update notification settings

Auth: Session

Portal

GET/api/portal/status

List or retrieve status

Auth: Session

Restore Permissions

GET/api/restore-permissions/{tenantId}

List or retrieve restore permissions

Auth: Session

POST/api/restore-permissions/{tenantId}

Create restore permissions

Auth: Session

DELETE/api/restore-permissions/{tenantId}/{userEmail}

Delete restore permissions

Auth: Session

Retention Defaults

GET/api/retention-defaults

List or retrieve retention defaults

Auth: Session

PATCH/api/retention-defaults

Update retention defaults

Auth: Session

Saas

POST/api/saas/browse

Create browse

Auth: Session

GET/api/saas/browse?action=items

List or retrieve browse?action=items

Auth: Session

GET/api/saas/browse?action=restore-history

List or retrieve browse?action=restore history

Auth: Session

GET/api/saas/browse?action=restore-status&id=X

List or retrieve browse?action=restore status&id=X

Auth: Session

GET/api/saas/browse?action=search

List or retrieve browse?action=search

Auth: Session

GET/api/saas/browse?action=users

List or retrieve browse?action=users

Auth: Session

GET/api/saas/browse?action=versions&id=X

List or retrieve browse?action=versions&id=X

Auth: Session

POST/api/saas/connections

Create connections

Auth: Session

GET/api/saas/connections?action=get&id=X

List or retrieve connections?action=get&id=X

Auth: Session

GET/api/saas/connections?action=list

List or retrieve connections?action=list

Auth: Session

GET/api/saas/connections?action=oauth-url&provider=X

List or retrieve connections?action=oauth url&provider=X

Auth: Session

POST/api/saas/jobs

Create jobs

Auth: Session

GET/api/saas/jobs?action=dashboard

List or retrieve jobs?action=dashboard

Auth: Session

GET/api/saas/jobs?action=get&id=X

List or retrieve jobs?action=get&id=X

Auth: Session

GET/api/saas/jobs?action=list

List or retrieve jobs?action=list

Auth: Session

POST/api/saas/policies

Create policies

Auth: Session

GET/api/saas/policies?action=get&id=X

List or retrieve policies?action=get&id=X

Auth: Session

GET/api/saas/policies?action=list

List or retrieve policies?action=list

Auth: Session

Search?Q=...&Tenant_id=...

GET/api/search?q=...&tenant_id=...

List or retrieve search?q=...&tenant_id=...

Auth: Integration Key

Vendor

POST/api/vendor/config

Create config

Auth: Session

GET/api/vendor/config?action=get&id=X

List or retrieve config?action=get&id=X

Auth: Session

GET/api/vendor/config?action=list

List or retrieve config?action=list

Auth: Session

GET/api/vendor/config?action=mapping&id=X

List or retrieve config?action=mapping&id=X

Auth: Session

POST/api/vendor/monitoring

Create monitoring

Auth: Session

GET/api/vendor/monitoring?action=alerts

List or retrieve monitoring?action=alerts

Auth: Session

GET/api/vendor/monitoring?action=companies

List or retrieve monitoring?action=companies

Auth: Session

GET/api/vendor/monitoring?action=dashboard

List or retrieve monitoring?action=dashboard

Auth: Session

GET/api/vendor/monitoring?action=device&id=X

List or retrieve monitoring?action=device&id=X

Auth: Session

GET/api/vendor/monitoring?action=devices

List or retrieve monitoring?action=devices

Auth: Session

GET/api/vendor/monitoring?action=jobs

List or retrieve monitoring?action=jobs

Auth: Session

---

note

This reference is auto-generated from source code. Run npx tsx scripts/generate-api-docs.ts from the ops-center repo to refresh.