metadata.update

Update the details of a Metadata entity

POST http://api.kompliant.com/metadata.update (OpenAPI specification)

Usage Info

Use this endpoint when updating the details of a metadata entity.

Note: Is not possible to update metadata_type, you will need to create a new one.

Authentication: KSig1-HMAC-SHA256

Parameter	Type	Required	Description
metadata_id	string	Yes	The Metadata to update.
metadata	object	Yes	The metadata parameter defined in the tables below.

Parameter	Type	Required	Description
details	object	Yes	The details parameter consists of additional properties of key-value pair defined as per metadata type fields schema.

{
  "metadata_id": "{{metadata_id}}",
  "metadata": {
    "details": {
      "ipv4": "192.168.1.1",
      "allocation_method": "DHCP"
    }
  }
}

An empty data object is returned when the completion is successful.

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {}
}

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Allowed parameters provided not valid.
ENTITY_NOT_FOUND	400	Any of the provided Ids does not exist.

Updated 4 months ago