Changed3
[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Update Metadata Entry

Description

Update the value of a single key-value metadata entry.

Request

Request

URL

URL


put
https://{api_host}/cloudapi/1.0.0/entities/{id}/metadata/{metadataId}
Copy

Path Parameters

Path Parameters

string
id Required

the URN of the entity the entry is attached to.


string
metadataId Required

a metadata vcloud id urn


Request Body

Request Body

MetadataEntry of type(s) application/json Required
{
	"keyValue": {
		"domain": "string",
		"key": "string",
		"value": {
			"type": "string",
			"value": {}
		}
	}
}
keyValue Required

Containins core metadata entry data.


string
id Optional

boolean
persistent Optional

Persistent entries can be copied over on some entity operation, for example: | Creating a copy of an Org VDC | Capturing a vApp to a template | Instantiating a catalog item as a VM


boolean
readOnly Optional

The kind of level of access organizations of the entry’s domain have

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns MetadataEntry of type(s) application/json;version=37.0
{
	"id": "string",
	"keyValue": {
		"domain": "string",
		"key": "string",
		"namespace": "string",
		"value": {
			"type": "string",
			"value": {}
		}
	},
	"persistent": false,
	"readOnly": false
}
keyValue Required

Containins core metadata entry data.


string
id Optional

boolean
persistent Optional

Persistent entries can be copied over on some entity operation, for example: | Creating a copy of an Org VDC | Capturing a vApp to a template | Instantiating a catalog item as a VM


boolean
readOnly Optional

The kind of level of access organizations of the entry’s domain have


202 Accepted

The request have been accepted and the task to monitor the request is in the Location header.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"id":"string","keyValue":{"domain":"string","key":"string","namespace":"string","value":{"type":"string","value":{}}},"persistent":false,"readOnly":false}' https://{api_host}/cloudapi/1.0.0/entities/{id}/metadata/{metadataId}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vcloud-event: com/vmware/vcloud/event/metadata/modify


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
What's changed in v37.0?
CHANGED (3)
Extension Added
x-vcloud-event
Extension Changed
x-vcloud-added-in
Response Body Changes
NewResponseCode Changed from
to 202

Feedback

Was this page helpful?