[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-appliance-config-api

Delete Configuration

Description

Remove current configuration.

Request

Request

URL

URL


post
https://{api_host}//appliance/configuration-manager/configuration/actions/remove
Copy

Request Body

Request Body

Credentials of mimetype application/json Optional

A spec for cleaning the current configuration.

{
	"admin_password": "string",
	"admin_user": "string"
}
string
admin_password Required

Password for the administrator user.


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.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns Task of type application/json

Unconfigure the appliance task.

{
	"complete_time": 0,
	"description": "string",
	"error": {
		"details": "string",
		"message": "string"
	},
	"id": "string",
	"progress": 0,
	"result": {},
	"start_time": 0,
	"status": "QUEUED",
	"type": "string"
}
string
status Required

Status of the task.

Possible values are: QUEUEDRUNNINGSUCCESSERRORCANCELLED


integer as int64
complete_time Changed Optional

The complete time of the task, in milliseconds.


error Optional

Detailed information about the error if the task status is ERROR.


string
id Optional

ID of the task.


integer as int32
progress Optional

The current progress of the task, in percentage number.


object
result Optional

Information about the task result if the task status is SUCCESS.


integer as int64
start_time Changed Optional

The start time of the task, in milliseconds.


string
description Optional

Description of the task.


string
type Optional

Operation type of the task.

Errors

Errors

ResponseError
400

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


401

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


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"admin_password":"string","admin_user":"string"}' https://{api_host}/appliance/configuration-manager/configuration/actions/remove


[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-appliance-config-api
Feedback

Was this page helpful?