Changed4
[{"label":"Latest (v36.3)","version":"latest"},{"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

Create Metadata Entry

Description

Creates a new entry.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
id Required

the URN of the entity the entry is attached to.


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

202 Accepted 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
}
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

Errors

Errors

400

Invalid configuration.

Code Samples

Code Samples

cURL Command

curl -X POST -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
Vendor Extensions

Vendor Extensions

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


[{"label":"Latest (v36.3)","version":"latest"},{"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 (4)
Extension Added
x-vcloud-event
Extension Changed
x-vcloud-added-in
Response Body Changes
NewResponseCode Changed from
to 202
NewResponseCode Changed from
to 400

Feedback

Was this page helpful?