Update Metadata Entry | VMware Cloud Director OpenAPI

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

Required

the URN of the entity the entry is attached to.

string

metadataId

Required

a metadata vcloud id urn

string

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

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

KeyValue

keyValue

Required

keyValue

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns MetadataEntry of type(s) application/json;version=36.3

{
    "id": "string",
    "persistent": false,
    "readOnly": false,
    "keyValue": {
        "domain": "string",
        "namespace": "string",
        "key": "string",
        "value": {
            "value": {},
            "type": "string"
        }
    }
}

string

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

KeyValue

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

Availability