---
id: link-create
title: "Create a link"
description: "Create a link"
sidebar_label: "Create a link"
hide_title: true
hide_table_of_contents: true
api: eJztWm1v2zgS/isEcR+6d7Jjp0naCFgccpsuLnfdNGhS7AJu1juWxhY3FKmSlFOf4f9+GFKSJdtpmkX32gP8yTJNzeszMw8JL7ku0IATWl2kPOZSqLs4MQgOecQdzCyPR/y1UHf8NuIp2sSIgnbzmP/gtzFg9BKPuMEPJVr3D50ueLz0X4XBlMfOlBjxRCuHytFPUBRSJF7rwe+WhC25TTLMgZ7cokAecz35HRPHI14YstEJtPSrghxbu6wzQs14xHOhXqOauYzHw4jn8LH+dnh8HHGlvWJUZc7jkSqlvF1t+nMJOTI9ZS5DhsoJt+izn0rr2IScVFr1MC/cggWVDFTKlHYMP5QgmdOMpPJVxG2BiZhW/o1F6q0VTpK5FymFdcP0qTY5OB7zshT0e9esd0p8KJGJlGyaCjRsqk3LSGawMGhROUwZWAbs3buLcx7cowSMdxkEavFmyuPR1zGtSV+I2Ra0zoPlrHxQAVirEwEkuOMe+Z2jtTALcKm9+ymsrV0EY2DBIy4c5vZx2Emco9yFuwpSPMVJSd+Fmurqg0JHJkX8Hkz9Ub1ljDYUX3AgQ2lNoZQU6UpANyCV+cziHA1F1tvTZ+fhNUv4e+9ffc9bIdhlcFfwDcUycQTh6h1WF+oq4k7kaB3kRUuQKvMJmm1B9da6hGpxQrFcSCksJlqllq9WUas3jBpTbyMOaSpIHMirVvCnIC1uqnvj07QGGFVknXd2L1y2EaqgNxU5Kiu06mDjvF5do6NBwW6TntB+hoPB57Wff+OiNwdZIitAGNt1bW14n72CJGN3uGB5pzmR1Lo3+QAAy4USeZkz6W2hxAz5lt5dkVyrC6LuuraREHDOiEnpQjga+C5X2zHs6jtrXmwXsVdDsKFhEjGb6VKm5NwcpEgZzEAo65od3aJnjTGsGiPUhlFi4rTppPq6WtyR6W69i7zQxmHayvVEa4mgeKtYPTRX/t25SNE8HRnruge1ILMTcDjTZvEFRNlyMv5i4lYP10JrljxBQ2cK+JbSWqljvT0qPlE3egeSCTWgEuqcNRwoMg5cubOO63ZeoEqFmo0bLlQt8Ij7pfBYFmn9CCbJxLx6TpyYY7OIqe/0QvqHhMyR9Lw19q69WXUDJZz32XVTCVo19KRCP6bMe26pyYaxW+YVnQslYOYiwa/JQcLvY2VU24TLt5c7bCjAOaSN/FdtZqDEf7wn348GvdO/3v7tWQxJokvl6oXv/v4sJjpoC0iwvdjil+1lm+iite8vW25ellIWEhwFg71Fq0uTIPO88Nnl28vvutAClgk0PsUJyM3gqLYsU8mqptCj/de3uBq69sExVE3GOqqvAw/Hj5AXEtdkmeeLXsXR24jgp8dHL5+fPk9602E67B1NJknv9AWc9JLnpycvX54cTg/hiO/is/wYXr44TE6hdwrDk94RnKQ9GAwGvXSAL44GRzA8BuDd5PNOSodNLoetFA47mRvyzYGNai6MVrk/RlDTTcukxnp3HuWLMXk8blZ9FMa+WrYYiI/SDj87DnRid7v6Q3n0JZmUxEp8u5wgGDRnJXXE0S3RYIO20MoGJw5/+SXM1ifD5Qudtb5i3/g/OObJcvbnWHgty9mmhWel03ScSEDKBZuhojaPKZsanbP3PlyB+e9Pn/vT5/70+U2ePgOXTMfgdkWmAXtKhHNVkcvP315zzc/aH3nsw4TQGa7nug7+nGFglA1/vgfLJFjHaj199hvJ+I3dZ0Jid7Owvmc29HdPuf+XjXd/yfHnXHJ8G/ca+xPVxolqf9Wzv+p56Kpnf9r+Bk7bK39aPtp1mv3Rz0Bf3p2UeIZqWVr6Tn92dcGEcmjAG/C0E26VrlcV5/10Lwgs5Qed4uOc8583N1csvMASnRL9Sb0dahbmtNdIdd4V9wAXrga+fyvIC1GZokFCNR1EqxKv8uqngVfyqPDrTBsXsazMQfUMQkrUr9JFbzLSWfePpzD4c3SeZVWyatoduqTv6U0tBWr/0e2oyj8MgzaVb+VufcRp+H0A4fEehHsQfl0QesdcpqmzF9q6QNMyHvOD1thAIjOjJS+N5DHPnCtsfHAAhei3aVA/0bm/wKivFa8JcgFF7cvFJoAkiDT4bTR8/SYeVQ8/1keSf/184yNEUH67/l/Hq/2we/xq2V+hxEtOOQzIGvYH/QFfU4cOKz67uiAlBIUcVCu0m/+v6aB1uW4+WxurXBPMDwoJwjvhgbSsoDbyf/Sh03BGCIxHfLmcgMV3Rq5WtPyhRCKSo9uIz8GIcFEwIkaWIXj2O1ryO1yQ9mBH74a00naKQ7zdEInfhTfOkgQL98m9t60iuXpzfUMIrf5XlPtGxg3cU+nBPY85j7guXJ1Kv7bkEtSs9O2DB5me13bLYQP+bWJLTHht4XIZdtzoO1SrFY8qVxx9J6q6Wv0XDBr63Q==
sidebar_class_name: "post api-method"
info_path: docs/api/nullplatform-api
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 link"}
>
</Heading>

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



Create a link

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

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

<RequestSchema
  title={"Body"}
  body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"not":{"enum":[null]},"description":"Name of the entity. Must be a non-empty string and not equal to null"},"specification_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"desired_specification_id":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"type":"null"}],"description":"Desired unique identifier for the associated specification"},"messages":{"title":"Message","type":"array","items":{"type":"object","properties":{"level":{"type":"string","enum":["debug","info","information","warn","warning","error","fatal"],"default":"info","description":"Message severity level. Defaults to \"info\""},"message":{"type":"string","description":"The actual message content"},"timestamp":{"type":"number","description":"Timestamp of the message in milliseconds"}},"required":["message"],"additionalProperties":false,"description":"Object representing messages with severity levels"}},"dimensions":{"title":"Dimension","type":"object","additionalProperties":{"type":"string","minLength":1,"maxLength":100,"not":{"enum":[null]},"description":"Key-value pairs representing dimensions. Each key must be a non-null string with a minimum length of 1"},"description":"Object representing dimensions with key-value pairs"},"attributes":{"default":{},"type":"object","description":"Attributes associated with the link, should be valid against the link specification attribute schema"},"selectors":{"title":"Selector","type":"object","properties":{"imported":{"type":"boolean","default":false},"provider":{"type":"string","minLength":1,"maxLength":100,"default":"any"},"category":{"type":"string","minLength":1,"maxLength":100,"default":"any"},"sub_category":{"type":"string","minLength":1,"maxLength":100,"default":"any"}},"additionalProperties":{"anyOf":[{"type":"string","minLength":1,"maxLength":100},{"type":"number"},{"type":"boolean"},{"type":"null"}]},"description":"Key-value object representing instance selectors"},"status":{"type":"string","enum":["pending_create","pending","creating","updating","archiving","active","archived","failed","cancelled"],"description":"Status of the link. Should be one of the specified values in the enumeration"},"service_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"entity_nrn":{"title":"NRN","type":"string","pattern":"^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$","description":"Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources"}},"description":"Object representing link instances","additionalProperties":false,"title":"Link","example":{"name":"my-link","service_id":"9548393c-f1d1-4bbc-97a6-c3968862f2a4","specification_id":"5a872c9a-9a16-4a6d-a000-d0e7404a15aa","entity_nrn":"organization=1:account=1:namespace=1:application=1","dimensions":{"environment":"production"},"attributes":{"my_link_attribute":"my_value"}},"required":["name","specification_id","entity_nrn","service_id"]}}},"description":"Object representing link instances"}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Object representing link instances","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"name":{"type":"string","minLength":1,"maxLength":255,"not":{"enum":[null]},"description":"Name of the entity. Must be a non-empty string and not equal to null"},"slug":{"type":"string","minLength":1,"maxLength":255,"not":{"enum":[null]},"description":"Slug of the entity. Automatically generated from \"name\""},"specification_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"desired_specification_id":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"type":"null"}],"description":"Desired unique identifier for the associated specification"},"messages":{"title":"Message","type":"array","items":{"type":"object","properties":{"level":{"type":"string","enum":["debug","info","information","warn","warning","error","fatal"],"default":"info","description":"Message severity level. Defaults to \"info\""},"message":{"type":"string","description":"The actual message content"},"timestamp":{"type":"number","description":"Timestamp of the message in milliseconds"}},"required":["message"],"additionalProperties":false,"description":"Object representing messages with severity levels"}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"archived_at":{"type":"string","format":"date","nullable":true,"description":"When the instance was last archived. `null` while the instance is not archived"},"status":{"type":"string","enum":["pending_create","pending","creating","updating","archiving","active","archived","failed","cancelled"],"description":"Status of the link. Should be one of the specified values in the enumeration"},"service_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"dimensions":{"title":"Dimension","type":"object","additionalProperties":{"type":"string","minLength":1,"maxLength":100,"not":{"enum":[null]},"description":"Key-value pairs representing dimensions. Each key must be a non-null string with a minimum length of 1"},"description":"Object representing dimensions with key-value pairs"},"attributes":{"type":"object","description":"Attributes associated with the link, should be valid against the link specification attribute schema"},"entity_nrn":{"title":"NRN","type":"string","pattern":"^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$","description":"Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources"},"selectors":{"title":"Selector","type":"object","properties":{"imported":{"type":"boolean","default":false},"provider":{"type":"string","minLength":1,"maxLength":100,"default":"any"},"category":{"type":"string","minLength":1,"maxLength":100,"default":"any"},"sub_category":{"type":"string","minLength":1,"maxLength":100,"default":"any"}},"additionalProperties":{"anyOf":[{"type":"string","minLength":1,"maxLength":100},{"type":"number"},{"type":"boolean"},{"type":"null"}]},"description":"Key-value object representing instance selectors"}},"description":"Object representing link instances","additionalProperties":false,"title":"Link","example":{"name":"my-link","service_id":"9548393c-f1d1-4bbc-97a6-c3968862f2a4","specification_id":"5a872c9a-9a16-4a6d-a000-d0e7404a15aa","entity_nrn":"organization=1:account=1:namespace=1:application=1","dimensions":{"environment":"production"},"attributes":{"my_link_attribute":"my_value"}}}}}},"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>