Delete Server Metadata Item

Overview

This API deletes metadata item (key and value) by specifying key for a specified server.

Classification

  • Delete

API Operation Object

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • DELETE

HTTP Request Path

{api_endpoint}/v2/{tenant_id}/servers/{server_id}/metadata/{key}

HTTP Request Header

Accept: application/json
Content-Type: application/json
X-Auth-Token: <token>

HTTP Request Body

  • none

Request Parameter

Input Parameters
name style format description required/optional default value action for invalid parameter response code for invalid parameter
tenant_id URL UUID ID for the tenant. required - Terminate 403, 404
server_id URL UUID ID for the server. required - Terminate 404
key URL String A string. Maximum length is 255 characters. required - Terminate 404
token Header Authentication token string Keystone authentication token. required - Terminate 401

Response

  • none

Sample Request and Response

Sample API Request

Request URI

https://baremetal-server-jp1-ecl.api.ntt.com/v2/b322a85578de48beba0f92acce57869b/servers/8b59526b-daf5-46db-9c44-e77c0a34bf2c/metadata/meta

HTTP Request Header

DELETE /v2/b322a85578de48beba0f92acce57869b/servers/8b59526b-daf5-46db-9c44-e77c0a34bf2c/metadata/meta HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.150.51:8774
Accept: application/json
Content-Type: application/json
X-Auth-Token: 62d528dc0cca4827b0ed465efe1c2588