Changed1
[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"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
DescriptionUpdate the value of a single key-value metadata entry.
Request
URLURL
https://{api_host}/cloudapi/1.0.0/entities/{id}/metadata/{metadataId}
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": {}
}
}
}
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
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
MetadataEntry
of type(s) application/json;version=36.3
{
"id": "string",
"keyValue": {
"domain": "string",
"key": "string",
"namespace": "string",
"value": {
"type": "string",
"value": {}
}
},
"persistent": false,
"readOnly": false
}
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.
Operation doesn't return any data structure.
No error details were provided in the OpenAPI specification.
Code SamplesCode 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
This operation contains the following vendor extensions defined in the spec:
x-vcloud-event: com/vmware/vcloud/event/metadata/modify
[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"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 v36.3?
CHANGED (1)
x-vcloud-added-in
Response Body Changes
Changed from
to 202
to 202
New in this version
Availability
Added in 37.0.0-alpha
On This Page
Defined Entity Operations
post
Create Metadata Entry
Changed
delete
delete
Delete Metadata Entry
Changed
get
get
Get Metadata File Content
Introduced
put
Update Metadata Entry
Changed
