Delete Configuration

Delete Configuration

Remove current configuration.

Request
URI
POST
https://{api_host}/appliance/configuration-manager/configuration/actions/remove
COPY
Request Body

A spec for cleaning the current configuration.

Credentials of type(s) application/json
Optional
{
    "admin_user": "string",
    "admin_password": "string"
}
string
admin_user
Required

The name of a user with sufficient privileges to perform configuration tasks on the infrastructure, management nodes, and the infrastructure node.

string
admin_password
Required

Password for the administrator user.

Authentication
This operation uses the following authentication methods.
Responses
202

Unconfigure the appliance task.

Returns Task of type(s) application/json
"Task Object"
string
id
Optional

id

string
description
Optional

description

string
type
Optional

Operation type

string
status
Required

Current status of the task

Possible values are : QUEUED, RUNNING, SUCCESS, ERROR, CANCELLED,
object
error
Optional

Detailed information about the error if the task status is ERROR

object
result
Optional

Result of the operation

integer As int32 As int32
progress
Optional

Current progress of the operation

string As date-time As date-time
start_time
Optional

start_time

string As date-time As date-time
complete_time
Optional

complete_time


400

Bad request - the server cannot understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"admin_password:"string","admin_user:"string"}' https://{api_host}/appliance/configuration-manager/configuration/actions/remove