Update Metadata Entry

Update Metadata Entry

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

Request
URI
PUT
https://{api_host}/cloudapi/1.0.0/entities/{id}/metadata/{metadataId}
COPY
Path Parameters
string
id
Required

the URN of the entity the entry is attached to.

string
metadataId
Required

a metadata vcloud id urn

string
id
Required

the URN of the entity the entry is attached to.

string
metadataId
Required

a metadata vcloud id urn


Request Body
MetadataEntry of type(s) application/json
Optional
{
    "id": "string",
    "persistent": false,
    "readOnly": false,
    "keyValue": {
        "domain": "string",
        "namespace": "string",
        "key": "string",
        "value": {
            "value": {},
            "type": "string"
        }
    }
}
string
id
Optional

id

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

keyValue
Required

keyValue

Authentication
This operation uses the following authentication methods.
Responses
200

OK

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

id

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

keyValue
Required

keyValue


202

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

Operation doesn't return any data structure