Examples in

Geplante Backups

On-Demand-Backups decken den Fall „Ich will jetzt sofort einen Snapshot dieses Volumes“ ab. Geplante Backups decken alles andere ab: nächtliche Backups jedes Produktions-Volumes, wöchentliche Voll-Backups kombiniert mit täglichen inkrementellen Backups, monatliche Snapshots, die aus Compliance-Gründen ein Jahr lang aufbewahrt werden.

Ein Zeitplan ist ein kleines JSON-Dokument — wählen Sie ein Ziel (ein Volume, eine VM, eine Datenbank), eine Häufigkeit (im Cron-Stil), eine Aufbewahrungsrichtlinie (die N neuesten behalten oder nach X Tagen ablaufen lassen) und eine Speicherrichtlinie (welche Region/Klasse für den Backup-Speicher). Der Scheduler läuft im Hintergrund; fehlgeschlagene Läufe werden mit Backoff wiederholt und erscheinen im Ausführungsprotokoll des Zeitplans.

Die meisten Produktionskonten nutzen 2–4 Zeitpläne: daily-keep-14, weekly-keep-8, monthly-keep-12 und gelegentlich einen Snapshot zum Jahresende, der für Finanzen/Recht 7 Jahre lang aufbewahrt wird.

Nächste Schritte

Backups — das On-Demand-Gegenstück und der Ressourcentyp, den Zeitpläne erzeugen.
Blockspeicher und Snapshots — die Quellen der Backups.
Verwaltete Datenbanken — mit eigenem Aufbewahrungsmodell; nutzt keine Zeitpläne dieses Endpoints.

Reference

POST/api/v1/backup_restore/backup_scheduler/

Create Backup Schedule

Creates a recurring backup schedule for block storage volumes after validating the project's backup quota.

Request body

Field	Type	Description
frequency	object	—
backup_quantity	integer \| null	—
outside_backup_quantity	integer \| null	—
enabled	boolean \| null	—
domain_id	string \| null	—

Responses

201Successful Response
400Bad Request
401Unauthorized
409Conflict
422Validation error
500Internal Server Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/backup_restore/backup_scheduler/" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

GET/api/v1/backup_restore/backup_scheduler/list

Get Backup Schedule List

Lists block storage backup schedules in the current domain with pagination, sorting and frequency filtering.

Parameters

Name	In	Type	Description
offset	query	integer \| null	—
limit	query	integer \| null	—
sort_by	query	string \| null	—
sort_desc	query	boolean	—
frequency	query	string \| null	—

Responses

200Successful Response
400Bad Request
401Unauthorized
422Validation error
500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/backup_restore/backup_scheduler/list" \
  -H "Authorization: Bearer $NIMBUS_KEY"

PATCH/api/v1/backup_restore/backup_scheduler/{backup_schedule_id}

Update Backup Schedule

Updates an existing block storage backup schedule and revalidates quota when the retention is increased.

Parameters

Name	In	Type	Description
backup_schedule_id*	path	string	—

Request body

Field	Type	Description
frequency	BackupFrequencyEnum \| null	—
backup_quantity	integer \| null	—
outside_backup_quantity	integer \| null	—
enabled	boolean \| null	—
domain_id	string \| null	—

Responses

200Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation error
500Internal Server Error

Example

curl -X PATCH "https://api.nimbusnexus.net/api/v1/backup_restore/backup_scheduler/<backup_schedule_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

DELETE/api/v1/backup_restore/backup_scheduler/{backup_schedule_id}

Delete Backup Schedule

Deletes a block storage backup schedule by its ID.

Parameters

Name	In	Type	Description
backup_schedule_id*	path	string	—

Responses

204Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation error
500Internal Server Error

Example

curl -X DELETE "https://api.nimbusnexus.net/api/v1/backup_restore/backup_scheduler/<backup_schedule_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY"

POST/api/v1/backup_restore/volume_scheduler/

Create Volume Scheduler Conf

Creates a per-volume backup scheduler configuration that links a volume to a backup schedule.

Request body

Field	Type	Description
prefix_location_url	string \| null	—
use_outside_storage	OutsideStorageEnum \| null	—
enabled	boolean \| null	—
volume_id*	string	—
schedule_id*	string	—
type*	website__model__website__volume_backup__volume_backup__BackupTypeEnum	—

Responses

201Successful Response
400Bad Request
401Unauthorized
404Not Found
409Conflict
422Validation Error
500Internal Server Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "volume_id": "<volume_id>",
    "schedule_id": "<schedule_id>",
    "type": "snapshot"
  }'

POST/api/v1/backup_restore/volume_scheduler/config-storage

Create Config Storage

Attaches an external backup storage destination to a per-volume scheduler configuration.

Request body

Field	Type	Description
config_id*	string	—
storage_id*	string	—
priority*	integer	—

Responses

201Successful Response
400Bad Request
401Unauthorized
404Not Found
409Conflict
422Validation Error
500Internal Server Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/config-storage" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "config_id": "<config_id>",
    "storage_id": "<storage_id>",
    "priority": 1
  }'

PATCH/api/v1/backup_restore/volume_scheduler/config-storage/{config_storage_id}

Update Config Storage

Updates the external backup storage attachment of a per-volume scheduler configuration.

Parameters

Name	In	Type	Description
config_storage_id*	path	string	—

Request body

Field	Type	Description
priority	integer \| null	—

Responses

200Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation Error
500Internal Server Error

Example

curl -X PATCH "https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/config-storage/<config_storage_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

DELETE/api/v1/backup_restore/volume_scheduler/config-storage/{config_storage_id}

Delete Config Storage

Removes an external backup storage attachment from a per-volume scheduler configuration.

Parameters

Name	In	Type	Description
config_storage_id*	path	string	—

Responses

204Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation error
500Internal Server Error

Example

curl -X DELETE "https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/config-storage/<config_storage_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY"

GET/api/v1/backup_restore/volume_scheduler/detail/{config_id}

Get Volume Scheduler Conf Detail

Returns the detailed view of a per-volume backup scheduler configuration including its related entities.

Parameters

Name	In	Type	Description
config_id*	path	string	—

Responses

200Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation Error
500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/detail/<config_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY"

GET/api/v1/backup_restore/volume_scheduler/list

Get Volume Scheduler Conf List

Lists per-volume backup scheduler configurations for the volumes in the current project with pagination.

Parameters

Name	In	Type	Description
limit	query	integer \| null	—
offset	query	integer \| null	—

Responses

200Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation Error
500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/list" \
  -H "Authorization: Bearer $NIMBUS_KEY"

PATCH/api/v1/backup_restore/volume_scheduler/{volume_scheduler_conf_id}

Update Volume Scheduler Conf

Updates an existing per-volume backup scheduler configuration by its ID.

Parameters

Name	In	Type	Description
volume_scheduler_conf_id*	path	string	—

Request body

Field	Type	Description
prefix_location_url	string \| null	—
use_outside_storage	OutsideStorageEnum \| null	—
enabled	boolean \| null	—
volume_id	string \| null	—
schedule_id	string \| null	—
type	website__model__website__volume_backup__volume_backup__BackupTypeEnum \| null	—

Responses

200Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation Error
500Internal Server Error

Example

curl -X PATCH "https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/<volume_scheduler_conf_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

DELETE/api/v1/backup_restore/volume_scheduler/{volume_scheduler_conf_id}

Delete Volume Scheduler Conf

Requests asynchronous deletion of a per-volume backup scheduler configuration.

Parameters

Name	In	Type	Description
volume_scheduler_conf_id*	path	string	—

Responses

200Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation Error
500Internal Server Error

Example

curl -X DELETE "https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/<volume_scheduler_conf_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY"

Need to make a real call? Try these endpoints in the live Swagger UI →

Edit this page on GitHub