---
id: catalog-instance-single-create
title: "Create catalog instance (single key)"
description: "Creates catalog data for a single metadata key on the specified entity. The key must correspond to an existing catalog specification."
sidebar_label: "Create catalog instance (single key)"
hide_title: true
hide_table_of_contents: true
api: eJztWFFv2zYQ/ivEoQ/tqtjt0D5Mb1maYR02tGhdrIDnBWfxLLGhSJWk0qqC/vtwpGzLSbplCYLtoU+RyePx7ruPx4/pwTbkMChrXkrIocCA2pZnyviApqAzr0ypKS8cYSDIIGDpIV/CSTIUW0PxMFmKc+oewSoDSb5wqmHPkMNJXO/F6F9IDCg21gkU47qaAsbRc+qENSJUJHxDhdookoJMUKGbiUUVdxB164MorHPkG2ukCFagEfRZ+aBMudtmdFDEBGd/GMjA0ceWfPjRyg7yHgprApnAn9g0ejSdf/Acdg++qKhG/goqaIIcfhvjhAysoVcbyJc9hK7hOXQOO8hABao95P0wZLu5tbWa0MBkSJlAJbnpkGm1Pvxdrw8t7PoDFWE64oNTpoThCuivoqlw1DjyjKApBe6BJhNcl4pgRoCFSsCP+M0gA/qMdcOZ91B3Z2mvs8YxbUIHOVSktYWMJ1Owk8lnT4dhGO4hrCGDBh3WFMj5WIFJoQ5QYcMQyPHGfy7x6Mvq8cOz9PfRdw84P9PWTGjrSjTqSyw/ZIBFYVsTIAODNfkGC2b/hCKQwbpVWvKo98SWvrANRYppQs9fkhptu5qio9aTg9WQgeJgGgzV6B1ySHmO9FSOJOTBtXQZutMEBy8SocIgKqul32OnzMa6OrE9UuTrsNTK/EqmDBXkTw9BenL0w+rxA7g+UCVvGuTLF/cX4pU6Xh9svT+rNwp52oOySMGR/bko7AU5LCkTG+bdJ+vOfSYuWm3I4VppFRT5WTyEnorWcTWZl2tCR+645SSWK55OLcsTNwj4/v17/nMP5/ZbY7v3xjZk8Oy6+v0UCR4DOAiRnLPOC9nyVuL49UvBQDkseJ2/Tc1O2SPfygcQZjBGqhLJfMDQ+hMraXLKxgJchvbnxeK1SAtEYSUJZWSMw5QRwJgDH7fi0N3u0B66e2fUx3ZclfwlVDbkiFUDGsk1odK6be8dMkib/KPzt5V1IRNVW6M5coQS13q7F68UvGdy3rHbmrzH8gZRv6CASrPsiL7GdaJx9kLJSDYpFduiFrFmnwNcveduTYN9r1pOa7fFZZ/IKpHw+TcSfiPhf0vCmFioLL8hGutD0l0V5DDftuV5n1rxMO+VHOb9dnxg5UTuYqvkWqe5+4bQ+Hw+x0bN+O5oNAYWDrPC1ge37FvmY6LY9K7docuOojZjM76uohGrt/iR8IEcfvl9EeFjnr/ZvxFO73ZLsCzZ2OlpGR9OkAFnnIr0ZPZ09iSKWutDjfGcjRImPZx2D5rrn1uXij551fyPHl5jPZin80ajiocsFrsfubKcCrZ8J4nzqDnz3dwqg4opli+h79fo6Z3Tw8DDH1tyLLtWGVygU3wSI6Wk8vwtId+g9pfV3xSuh29G2j8S/0prfyW9rXwynMcF6pZ/QQbn1O1FPyueu0R4E6F9q/iUvHNsd1fUt4p8x5WB31sVoSQXmZCmT1LER4suvte2y69cd5x9WnFcFNSEv7VdTVrg61dvF9xixn8y1PGaAoefuLHipxSqbVKvzfs01oNGU7bxcoDkkxsSHvazS/3rQKUfgNH3yWJhz8kMww6bwL8ZmGH4C5xqT6Q=
sidebar_class_name: "post 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={"Create catalog instance (single key)"}
>
</Heading>

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



Creates catalog data for a single metadata key on the specified entity. The key must correspond to an existing 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>


      