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

Request Body

MetadataEntry of type(s) application/json

Optional

Show optional properties

{
    "keyValue": {
        "domain": "string",
        "key": "string",
        "value": {
            "value": {},
            "type": "string"
        }
    }
}

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

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

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

"MetadataEntry Object"

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

Required

Containins core metadata entry data.

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

Vendor Extension

This operation contains the following vendor extensions defined in the spec:

                    [object Object]

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"keyValue":"{}"}' https://{api_host}/cloudapi/1.0.0/entities/{id}/metadata/{metadataId}

Availability

Added in 37.0

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

202 Response Body

Vendor Extension