Updated on 2026-01-08 GMT+08:00

Deleting a Host from an Environment

Function

This API is used to delete a host from an environment.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/applications/{application_id}/environments/{environment_id}/{host_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

application_id

Yes

String

Definition:

Deployment application ID.

Constraints:

N/A.

Value range:

32 characters, including letters and digits.

Default value:

N/A.

environment_id

Yes

String

Definition:

Environment ID.

Constraints:

N/A.

Value range:

32 characters, including letters and digits.

Default value:

N/A.

host_id

Yes

String

Definition:

Host ID.

Constraints:

N/A.

Value range:

32 characters, including letters and digits.

Default value:

N/A.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition:

Type (or format) of the message body.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used for.

Constraints:

N/A.

Value range:

String. Max. 20,000 characters.

Default value:

N/A.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition:

Request status (successful or failed).

Value range:

  • success: Successful.

  • error: Failed.

result

String

Definition:

Host ID.

Value range:

32 characters, including letters and digits.

Example Requests

https://{endpoint}/v1/applications/7de12f87232e46a79235f52d033b8688/environments/25e30c17f81042ba9a1a3383da39a7fc/c5fa45c92c0849229d003d98f52617eb

Example Responses

Status code: 200

OK: The request is successful.

{
  "status" : "success",
  "result" : "c5fa45c92c0849229d003d98f52617eb"
}

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.