Help Center/ Elastic Cloud Server/ API Reference/ APIs (Recommended)/ Metadata Management/ Deleting Specified ECS Metadata
Updated on 2026-03-18 GMT+08:00
View PDF

Deleting Specified ECS Metadata

Function

This API is used to delete specified ECS metadata.

Constraints

An ECS must be in active, stopped, paused, or suspended state, which is specified by OS-EXT-STS:vm_state.

URI

DELETE /v1/{project_id}/cloudservers/{server_id}/metadata/{key}

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Definition

Specifies the project ID.

For details about how to obtain the ID, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

server_id

Yes

Definition

Specifies the ECS ID.

Constraints

N/A

Range

N/A

Default Value

N/A

key

Yes

Definition

Specifies the ECS metadata key to be deleted.

Constraints

N/A

Range

N/A

Default Value

N/A

Request

None

Response

None

Example Request

Delete a specified metadata from an ECS.

DELETE https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/metadata/{key}

Example Response

None

Returned Values

See Returned Values for General Requests.

Parent topic: Metadata Management