API Reference | 4.8.38 | ZStack Cloud · ZCF

API Request

URLs

DELETE zstack/v1/hosts/{uuid}?deleteMode={deleteMode}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 999c480f7f344c3b803c3d74b82b7145" \
-X DELETE http://localhost:8080/zstack/v1/hosts/bb2e5125ac2c4b3680463d7aeaf57773?deleteMode=Permissive

Request Parameters

Name	Type	Location	Description	Starting Version
uuid	String	url	The resource UUID.	0.6
deleteMode	String	body	Optional. The delete mode. Options: Permissive \| Enforcing. Default mode: Permissive.	0.6
systemTags	List	body	Optional. The system tags.	0.6
userTags	List	body	Optional. The user tags.	0.6

API Response

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,

{
    "error": {
        "code": "SYS.1001",
        "description": "A message or a operation timeout",
        "details": "Create VM on KVM timeout after 300s"
    }
}

SDK Sample

Java SDK

DeleteHostAction action = new DeleteHostAction();
action.uuid = "2d4b91d9831d4630bf113ea75f78cb7a";
action.deleteMode = "Permissive";
action.sessionId = "923c9089a5fd4ea5b9fbfc1dec5802e2";
DeleteHostAction.Result res = action.call();

Python SDK

DeleteHostAction action = DeleteHostAction()
action.uuid = "f62a37111c154ec9afeaeb2700ebcfe6"
action.deleteMode = "Permissive"
action.sessionId = "2aa7f575d8654712ba985f4a36594f0a"
DeleteHostAction.Result res = action.call()