---
id: catalog-specification-create
title: "Create a catalog specification"
description: "Creates a catalog specification for an entity."
sidebar_label: "Create a catalog specification"
hide_title: true
hide_table_of_contents: true
api: eJztWW1v2zYQ/ivEYR+SVXlrk6IVUBRp2mIpWjfIy1Yg8YKzeLbZSKRKUmk9x/99OFK2ZUdJt2LtgM2fIpO8493D517IjMGUZNErow8lpJChx9wMLl1JmeqrLMykmSX0BAl4HDhIz+EgLhMLy6CbgCSXWVWGnykcBDknUGRtAqJvrEAtSHvlR5uQgKVPFTn/wsgRpGPIjPakPX9iWea12NZHx9rH4LIhFchfXvmcIIV35FGix5MFuxLwo5KnTe8jZR4SKC277RU5ltZYUNASVzlvlR5AAoXSb0kP/BDSnVuutTrEmpLgFn3BoswpFS8qlUtxYK7J4oASsT93RLy2WNBnY69cUq/7tco1WeypXLF1mzBJQFvd9LFz3Jl7NLO1RO+JF8Lvxg5Qqz/CFs/WLi7kg5uLi5/XH6w9T1PMMlNp3xhef87jbLgrMaNbMw3gb82t9djoG5eZkm4s5YSObtA58jeSytyMCtJ+fUHsJ1hGslPleZmj7xtbiGNyprIZiQ4WJNY6x511Yam05JgkeiBQDBVZtNlQZZgLJXm8r8gG1HVTl611RRQjydqOedGcI7Skfc1J4YfoxdDk0omi5pZQmtUHRJizpKuCY6IJOyRQIw0JzLDl0TmakECAj0cZMkggABnCIEAZbJvCCAlUjix0JwlMTWnzhiHAHjPF24ruJ/Gr6OTMsysaLbE3m/G23+DqdQtLFzT/E7HUWBM2aET7UjRL6mOVc5pYtuMO1VHVpnhXOS96JFBcY66keHPyviNO4iRMbil7HzZc5uM9qW2RjzUDE6jRnace6EwpIkKGXd54X8owIdDxGW1cY16RiP4Lb8SMYXEPTmt12lhg5bMdmMfBAi3nhILagLvRXsydxegynvFlPd4aYh4HkY9M3tGlrooe2TaJONM80+1amuWyynlTXHocXAbgorZoWZu2u23W5DzJe2yeTPj8uR4pS5Lju8XTbgIopWJsMT9q7NHH3NGygmByPJfZMTSgn2HeXdo6xvH3oCJHFWWVDYQ4H0OP0JLdrzhKz7uTLlvhSqNdxO3hhw/85/sExQ+q9Uo2dRzKllIaszukUFVK3orFM60+VSQOXwZv/LCOuVEilBZnZ3G8QB9L96qzWHUWq85i1Vn8+M6CEx3sPNrd293Fxxu4/eTpxu6jHm48lXsPN/Z6j+kx7fbxidyBZNWF/Ke7kKhkt614vw7pJlBqgXtkrbFOyIp3EvtHh0JpTxYzlnPfUq1fscavVmfn0VfuwEhqP42m7b+cnh6JKCAyI0koLYMdehDLcthxwrbK1iLcWteDVNQXUemTJZ2RQC05IGlg7DQVc+4Pm3xV+cnQWJ+IYVWg3rCEkvNovRdLCt4zKg9dWUHO4eAvWP2SPKqcZK2rlhOlNddKhiwyY4YIZ/bFt6Sfb6ZBk5mNs5viMnekG0m4tyLhioT/LgljkzM0XB5L43zscIeQwta0/sw+Fp9BuR6RvSbrwmWpsjmkMPS+dOnWFpZqs1mTNzNTAN+gphesUPwjwZrXrBm2rGha8fh3XMStXPh4Pb2UvPntNIDHLD+eP5e+Wr0p/D+qeQJ8S2hmtboThQSYm/F0tzd3NrfZF6Z4gbrBi/gof1d7ucyTxiP833/Or93ngN8qc1QhW4W4GddBd958/7gj7LoJDDlQ03MYj3vo6MzmkwkPf6rI8stFN4FrtCpeTs75HjMklGRDnF4RM/MgerFxOgr3oMB2SG/XjUkyldjPMir9vWu7jVxy9P7klKO1/tdFEfI9WPzMGQo/QwqQgClj0krHcWwMOepBFbIsRJ18wriYGpZSQfCqnkI9alg4HscVp+aK9GQCSe2K598w4fz3JzAOKj4=
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 a catalog specification"}
>
</Heading>

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



Creates a catalog specification for an entity.

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

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"title":"MetadataSpecification","type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Catalog specification name, for example: Build Coverage, Application Frameworks, Build Vulnerabilities."},"nrn":{"title":"NRN","type":"string","pattern":"^organization=(\\d+|\\*)+(?::account=(\\d+|\\*))?(?::namespace=(\\d+|\\*))?(?::application=(\\d+|\\*))?(?::(build|scope|release|asset|deployment)=(\\d+|\\*))?$","description":"Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources."},"entity":{"type":"string","description":"Parent entity that holds metadata information.","enum":["organization","account","namespace","application","build","asset","scope","release","deployment","user"]},"metadata":{"type":"string","nullable":true,"minLength":1,"description":"Entity metadata key, for example: coverage, frameworks, vulnerabilities."},"description":{"type":"string","minLength":1,"description":"Catalog specification description."},"schema":{"type":"object","default":{},"description":"Catalog specification schema. Must be a valid JSON Schema."}},"description":"Object representing a catalog specification for a nullplatform entity","example":{"name":"Namespace tags","description":"Add tags as key-value object to namespace entities","nrn":"organization=1","entity":"namespace","metadata":"tags","schema":{"type":"object","properties":{"my_string_property":{"type":"string","tag":true},"my_number_property":{"type":"number","default":0,"tag":"my_custom_tag_name"},"my_object_property":{"type":"object","properties":{"my_nested_property":{"type":"string"}}}},"required":["my_string_property"],"additionalProperties":false}},"required":["name","nrn","entity","metadata","schema"]}}},"required":true,"description":"Object representing a catalog specification for a nullplatform entity"}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Object representing a catalog specification for a nullplatform entity","content":{"application/json":{"schema":{"title":"MetadataSpecification","type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid","description":"Unique ID for the entity, in UUID format."},"name":{"type":"string","minLength":1,"description":"Catalog specification name, for example: Build Coverage, Application Frameworks, Build Vulnerabilities."},"nrn":{"title":"NRN","type":"string","pattern":"^organization=(\\d+|\\*)+(?::account=(\\d+|\\*))?(?::namespace=(\\d+|\\*))?(?::application=(\\d+|\\*))?(?::(build|scope|release|asset|deployment)=(\\d+|\\*))?$","description":"Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources."},"entity":{"type":"string","description":"Parent entity that holds metadata information.","enum":["organization","account","namespace","application","build","asset","scope","release","deployment","user"]},"metadata":{"type":"string","nullable":true,"minLength":1,"description":"Entity metadata key, for example: coverage, frameworks, vulnerabilities."},"description":{"type":"string","minLength":1,"description":"Catalog specification description."},"schema":{"type":"object","default":{},"description":"Catalog specification schema. Must be a valid JSON Schema."}},"description":"Object representing a catalog specification for a nullplatform entity","example":{"id":"134544a6-a089-43ba-9d52-5b6e6e4fa8d1","name":"Namespace tags","description":"Add tags as key-value object to namespace entities","nrn":"organization=1","entity":"namespace","metadata":"tags","schema":{"type":"object","properties":{"my_string_property":{"type":"string","tag":true},"my_number_property":{"type":"number","default":0,"tag":"my_custom_tag_name"},"my_object_property":{"type":"object","properties":{"my_nested_property":{"type":"string"}}}},"required":["my_string_property"],"additionalProperties":false}}}}}},"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>