Skip to content
SYLVE

Get Backup Event Progress

GET
/cluster/backups/events/{id}/progress
curl --request GET \
  --url https://sylve.lan:8181/api/cluster/backups/events/1/progress \
  --header 'Authorization: <Authorization>'

Get live progress for a backup event from the local or selected cluster node

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
integer

Backup Event ID

Query Parameters

Section titled “Query Parameters”
nodeId
string

Cluster node ID

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
object
event
object
completedAt
string
createdAt
string
error
string
id
integer
jobId
integer
mode
string
output

Zelta output

string
sourceDataset
string
startedAt
string
status

“queued”, “running”, “success”, “failed”, “interrupted”

string
targetEndpoint
string
updatedAt
string
movedBytes
integer
phase
string
progressDataset
string
progressPercent
number
totalBytes
integer
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "event": {
      "completedAt": "example",
      "createdAt": "example",
      "error": "example",
      "id": 1,
      "jobId": 1,
      "mode": "example",
      "output": "example",
      "sourceDataset": "example",
      "startedAt": "example",
      "status": "example",
      "targetEndpoint": "example",
      "updatedAt": "example"
    },
    "movedBytes": 1,
    "phase": "example",
    "progressDataset": "example",
    "progressPercent": 1,
    "totalBytes": 1
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Section titled “404”

Backup Event or Cluster Node Not Found

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

502

Section titled “502”

Remote Node Failure

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Section titled “503”

Forwarding Service Unavailable

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

504

Section titled “504”

Remote Node Timeout

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}