Update a Backup Target

PUT

/cluster/backups/targets/{id}

curl --request PUT \
  --url https://sylve.lan:8181/api/cluster/backups/targets/1 \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "backupRoot": "example", "createBackupRoot": true, "description": "example", "enabled": true, "id": 1, "name": "example", "sshHost": "example", "sshKey": "example", "sshPort": 1 }'

Update backup target metadata, lifecycle state, or managed SSH key

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

integer

Backup Target ID

Request Body

Backup Target Request

Media typeapplication/json

object

backupRoot

required

string

>= 2 characters

createBackupRoot

boolean

description

string

enabled

boolean

id

integer

name

required

string

>= 2 characters

sshHost

required

string

>= 3 characters

sshKey

string

sshPort

integer

Example^generated

{
  "backupRoot": "example",
  "createBackupRoot": true,
  "description": "example",
  "enabled": true,
  "id": 1,
  "name": "example",
  "sshHost": "example",
  "sshKey": "example",
  "sshPort": 1
}

Responses

200

Success

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Backup Target Not Found

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Conflict

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Request Entity Too Large

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Service Unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}