Skip to content

Update an iSCSI target

PUT
/iscsi/targets/{targetId}
curl --request PUT \
--url https://sylve.lan:8181/api/iscsi/targets/1 \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "alias": "example", "authMethod": "example", "chapName": "example", "chapSecret": "example", "mutualChapName": "example", "mutualChapSecret": "example", "targetName": "example" }'

Update an existing iSCSI target and regenerate the target configuration

targetId
required
integer
>= 1

Target ID

ISCSI target settings

Media typeapplication/json
object
alias
string
authMethod
string
chapName
string
chapSecret
string
mutualChapName
string
mutualChapSecret
string
targetName
string
Examplegenerated
{
"alias": "example",
"authMethod": "example",
"chapName": "example",
"chapSecret": "example",
"mutualChapName": "example",
"mutualChapSecret": "example",
"targetName": "example"
}

Success

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

Bad Request

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

Not Found

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

Conflict

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

Payload Too Large

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

Internal Server Error

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