Forcefully disables one or more Controller functions.

Prev Next
Post
/appliances/force-disable-controllers

This API is supposed to be used when one or more Controller functions cannot be removed either because the Appliances are unresponsive or database status is not fixable. Use of the API by itself is not recommended. Use sdpctl instead.

Security
HTTP
Type bearer
Body parameters

Active Appliances to disable the Controller function for.

object
applianceIds
Array of string Required

IDs of the Controller Appliance's to disable the function for.

string (uuid)
Responses
200

Controller functions were disabled for the given Appliance list successfully.

object

The result of the disabling action.

offlineControllers
Array of string

IDs of the Controllers that were offline during the process and as a result, did not receive the update.

string (uuid)
400

JSON error. Check the JSON format.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

401

Token error. Login again.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

404

The requested resource can not be found.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

412

Appliance is not in the right state for this operation.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

422

Request validation error. Check "errors" array for details.

Expand All
object

Http 422 error for object validation.

id
string

Machine readable error code.

message
string

Human readable error details.

errors
Array of object

List of fields with validation errors.

object
field
string

Name of the field that failed validation.

Examplename
message
string

Failure reason.

Examplemay not be null
500

Unexpected server side error.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.