---
id: catalog-instance-single-update
title: "Update catalog instance (single key)"
description: "Updates catalog data for a single metadata key on the specified entity. Changes must comply with the associated catalog specification."
sidebar_label: "Update catalog instance (single key)"
hide_title: true
hide_table_of_contents: true
api: eJztWFFv3DYM/isC0Yd0de6aoXuY37I0QztsaNGmWIHsFvAsnq1GlhxJTuoa/u8DJd+dL0m3LEGwPfTpZImiyI+fSOp6sA05DMqa1xJyKDCgtuWZMj6gKejMK1NqyttGYiDIIGDpIT+FoyQo1oJiL0mKc+qewiIDSb5wqmHNkMOHuN+LUb+QGFCsrBMoxn01BYyz59QJa0SoSPiGCrVSJAWZoEI3E0cVmpK8qFsfRGHrRnfiSoUqiqP3tlAYSG7OGTUU0cPZHwYycHTRkg8/WdlB3kNhTSATeIhNo0fR+SfPdvfgi4pq5FFQQRPk8NtoKGRgDb1ZQX7aQ+gaXkPnsIMMVKDaQ94PQ7ZZW1qrCQ1MppQJVJKbTplW693verkrYZefqAjTGR+cMiUMN1B/E0WFo8aRZwhNKXCLNJnguhQFMyIsVEJ+xG8GGdBnrBv2vIe6O0tnnTWOeRM6yKEirS1kvJiMnSy+OBiGYXgEs4YMGnRYUyDnYwQmgdpBhQVDIMcH/3mK+18Wz/bO0u/T756wf6atmdHWlWjUlxh+yACLwrYmQAYGa/INFkz/CUUgg2WrtORZ74klfWEbihTThJ5Hkhptu5qiotaTg8WQgWJjGgzVqB1ySH6O9FSOJOTBtXQduuMEB28SocIgKqul32KnzMq6OrE9UuTrsNTK/EqmDBXkB7sgPd//cfHsCdxuqJJ3NfL1y8cz8UYcbze23t7VO5k8TUJZpODI/lwU9pIclpSJFfPuyrpzn4nLVhtyuFRaBUV+Fi+hp6J1HE3m5ZLQkTts2YnTBS878o01njhBwPcfP/LPI9zbb4nt0RPbkMGL2+L3cyR4NGDHRHLOOi9ky0eJw7evBQPlsOB9/j4xO2aNXJZ3IMxgtFQlkvmAofVHVtLklo0BuA7tq5OTtyJtEIWVJJSR0Q5TRgCjD3zdil11m0t7rfAbddGOu5K+hMqKHHHbgCYWayqtW+feIYN0yD8qf19ZFzJRtTWafUcocanXZ/FOwWcm5R2rrcl7LO9g9UsKqDT3HVHXuE80zl4qGckmpWJZ1CLG7HOAm3Xu3jTY5qrTaezWuGwdWSQS/vCNhN9I+N+SMDoWKitTDS6q1HhVkMN8nZfnfcrFw7xXcpj36/mBWydyl+tWrnWa028Ijc/nc2zUjItHozFw5zArbL1TZt8zIRPHpsV2Ay8ris0Zi3G9ikLcvsVBAghy+OX3k4gfE/3d9pFw/LAywX3Jyk6vy/h0ggzY4xSl57OD2fPY1VofaowXbexh0tNp86K5/cF1LeqTZ83/6ek1BoSZOm80qnjNYrT7kSyn05Yt3zTFeew6883aIoPK+sDyfb9ETx+cHgaevmjJceO1yOASneK7GDklleexhHyF2l/v/6Z47b0bif9U/Ktu+yvurRsow35com75CzI4p27b9nPP8xAL79Jq38s+JR9s28N76ntZvuHKwC+uilCSi0xIy0fJ4v2TLr7Y1ttvFDz2Pu04LApqwt/KLiZJ8O3hydErTjLj/wx1rFTg8IpzK14lW22T0m3ep7keNJqyjfUBklJOSbib0a5lsJ1GfQeNvk8SJ/aczDBswAn8zcgMw1+K9FFc
sidebar_class_name: "patch api-method"
info_path: docs/api/catalog
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update catalog instance (single key)"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/metadata/{entity}/{id}/{metadata}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Updates catalog data for a single metadata key on the specified entity. Changes must comply with the associated catalog specification.


<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"schema":{"type":"string","pattern":"^[a-z]+(_[a-z]+)*$","enum":["organization","account","namespace","application","build","asset","scope","release","deployment","user"]},"in":"path","name":"entity","required":true,"description":"Entity name that holds metadata information."},{"schema":{"type":"string","minLength":1,"pattern":"^[0-9]+$"},"in":"path","name":"id","required":true,"description":"Entity ID that holds metadata information."},{"schema":{"type":"string","minLength":1,"pattern":"^[a-z]+(_[a-z]+)*$"},"in":"path","name":"metadata","required":true,"description":"Entity metadata key, for example: coverage, frameworks, vulnerabilities."}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"title":"Metadata","oneOf":[{"type":"array","items":{}},{"type":"boolean"},{"type":"integer"},{"type":"null"},{"type":"number"},{"type":"object"},{"type":"string"}],"description":"Object representing a metadata entry for an entity in the catalog.","example":{"my_string_property":"hello","my_number_property":41}}}},"description":"Object representing a metadata entry for an entity in the catalog."}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Object representing a metadata entry for an entity in the catalog.","content":{"application/json":{"schema":{"title":"Metadata","oneOf":[{"type":"array","items":{}},{"type":"boolean"},{"type":"integer"},{"type":"null"},{"type":"number"},{"type":"object"},{"type":"string"}],"description":"Object representing a metadata entry for an entity in the catalog.","example":{"my_string_property":"hello","my_number_property":41}}}}},"4XX":{"description":"Format for representing errors during API interactions","content":{"application/json":{"schema":{"title":"Error","type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code indicating the error"},"code":{"type":"string","description":"Unique error code for reference and categorization"},"error":{"type":"string","description":"Short, human-readable error type or category"},"message":{"type":"string","description":"Detailed error message providing additional context"}},"description":"Format for representing errors during API interactions","required":["statusCode","error","message"]}}}},"5XX":{"description":"Format for representing errors during API interactions","content":{"application/json":{"schema":{"title":"Error","type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code indicating the error"},"code":{"type":"string","description":"Unique error code for reference and categorization"},"error":{"type":"string","description":"Short, human-readable error type or category"},"message":{"type":"string","description":"Detailed error message providing additional context"}},"description":"Format for representing errors during API interactions","required":["statusCode","error","message"]}}}}}}
>
  
</StatusCodes>