/
AL
alchemillahq
/
Sylve API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 17m ago · Updated 19h ago
Details
View markdown
Authentication
10
Basic
3
Certificates
10
Cluster
15
Cluster Backups
23
get
List Backup Events
get
List Backup Events with Pagination
get
Get a Backup Event
get
Get Backup Event Progress
get
List Backup Jobs
post
Create a Backup Job
put
Update a Backup Job
delete
Delete a Backup Job
post
Restore a Backup Job Snapshot
post
Run a Backup Job
get
List Backup Job Snapshots
get
List Backup Targets
post
Create a Backup Target
put
Update a Backup Target
delete
Delete a Backup Target
get
List Backup Target Datasets
get
Get Backup Jail Metadata
get
List Backup Target Dataset Snapshots
get
Get Backup VM Metadata
get
Get Backup Target Readiness
post
Restore a Backup Target Dataset
get
List Running Jobs for a Backup Target
post
Validate a Backup Target
Cluster Internal
1
Cluster Replication
9
Disk
12
Dynamic DNS
5
Events
1
Groups
4
Health
2
Info
18
iSCSI
15
Jail
45
mDNS
6
Network
61
Notifications
17
Samba
8
System
19
Tasks
5
Users
9
Utilities
16
VM
48
ZFS
29
Cluster Backups
Create a Backup Job
Create a scheduled backup job
post
/cluster/backups/jobs
Request body
GithubComAlchemillahqSylveInternalInterfacesServicesClusterBackupJobReq
required
cronExpr
string
enabled
boolean
encrypted
boolean
jailRootDataset
string
mode
string
required
name
string
required
pruneKeepLast
integer
pruneTarget
boolean
recursive
boolean
runnerNodeId
string
sourceDataset
string
stopBeforeBackup
boolean
targetId
integer
required
Response
Created
GithubComAlchemillahqSylveInternalAPIResponseAny
required
{"stackTrail":"components:schemas:github_com_alchemillahq_sylve_internal.APIResponse-any:properties:data","oasType":"schema","type":"unknown"}
error
string
message
string
status
string