mirror of
https://github.com/Dictionarry-Hub/profilarr.git
synced 2026-04-19 21:39:55 -04:00
109 lines
2.3 KiB
YAML
109 lines
2.3 KiB
YAML
BackupFile:
|
|
type: object
|
|
required:
|
|
- filename
|
|
- created
|
|
- size
|
|
- sizeFormatted
|
|
properties:
|
|
filename:
|
|
type: string
|
|
description: Backup archive filename
|
|
example: backup-2026-03-15-100005.tar.gz
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: File modification time (when the backup was created)
|
|
size:
|
|
type: integer
|
|
description: File size in bytes
|
|
sizeFormatted:
|
|
type: string
|
|
description: Human-readable file size
|
|
example: 12.34 MB
|
|
|
|
BackupCreateResponse:
|
|
type: object
|
|
required:
|
|
- jobId
|
|
properties:
|
|
jobId:
|
|
type: integer
|
|
description: Job queue ID. Poll GET /api/v1/jobs/{jobId} for status.
|
|
|
|
BackupUploadResponse:
|
|
type: object
|
|
required:
|
|
- filename
|
|
- size
|
|
- sizeFormatted
|
|
properties:
|
|
filename:
|
|
type: string
|
|
description: Stored filename (may differ from upload name)
|
|
size:
|
|
type: integer
|
|
description: File size in bytes
|
|
sizeFormatted:
|
|
type: string
|
|
description: Human-readable file size
|
|
|
|
BackupSettings:
|
|
type: object
|
|
required:
|
|
- schedule
|
|
- retentionDays
|
|
- enabled
|
|
- includeDatabase
|
|
- compressionEnabled
|
|
properties:
|
|
schedule:
|
|
type: string
|
|
enum:
|
|
- hourly
|
|
- daily
|
|
- weekly
|
|
- monthly
|
|
description: How often automatic backups run
|
|
retentionDays:
|
|
type: integer
|
|
minimum: 1
|
|
maximum: 365
|
|
description: Days to keep backups before cleanup deletes them
|
|
enabled:
|
|
type: boolean
|
|
description: Whether automatic backups are enabled
|
|
includeDatabase:
|
|
type: boolean
|
|
description: Whether to include the database in backups
|
|
compressionEnabled:
|
|
type: boolean
|
|
description: Whether backup compression is enabled
|
|
|
|
BackupSettingsUpdate:
|
|
type: object
|
|
description: All fields are optional. Only provided fields are updated.
|
|
properties:
|
|
schedule:
|
|
type: string
|
|
enum:
|
|
- hourly
|
|
- daily
|
|
- weekly
|
|
- monthly
|
|
retentionDays:
|
|
type: integer
|
|
minimum: 1
|
|
maximum: 365
|
|
enabled:
|
|
type: boolean
|
|
|
|
SuccessResponse:
|
|
type: object
|
|
required:
|
|
- success
|
|
properties:
|
|
success:
|
|
type: boolean
|
|
example: true
|