---
id: link-update
title: "Update a link"
description: "Updates a link"
sidebar_label: "Update a link"
hide_title: true
hide_table_of_contents: true
api: eJztWv9v27YS/1cI4v3Qvic7dpqkjYBhyGs6LFuXBUmKDXAz7yydLS4UqZKUU8/w/z4cKdmS7TRN0YcUeM4vpijy7nhfP8doznWBBpzQ6izlMZdC3cZlkYJDHnEHE8vjAX8r1C2/iXiKNjGioNU85u/8MsuA0S4ecYMfSrTuvzqd8XjuH4XBlMfOlBjxRCuHytErKAopEs927y9L1ObcJhnmQCM3K5DHXI/+wsTxiBeGhHQCLb1VkGNjlXVGqAmPeC7UW1QTl/G4H/EcPtZP+4eHEVfaM0ZV5jweqFLKm8X6gc4hR6bHzGXIUDnhZl32S2kdGyEDprTqYF64GQssGaiUKe0YfihBMqcZUeWBKp17aAtMxLg651Ck/uRq9uuYx4M5d8JJOsBZSppeO8xYmxwcj3lZCnq/pnklPpTIREpSjgUaNtamITYzWBi0qBymDMhC796dnfJFtNRaEHXDpKdBclbeywCs1YkAItw6Hp07R2thEqxUn+6XMLc6IhgDMx5x4TC3D1tb4hTlNnNXluQpjkp6Fmqsqx9SHYkU8Tsw9U+1yxhtSL/gQAaXHkMpSdMVgbZCKvGZxSka0qyXp8tOwzZLZn/vt77nDRVsE7hN+Jp0mTjynGoPq+NjEXEncrQO8qJBSJX5CM0moXpp7bk1OaFYLqQUFhOtUssXi6gRkoOlqDcRhzQVRA7kRUP5Y5AW19n96s20cjAKhNru7E64bE1Vga914Er7KTMWqFKhJsPEYMg91QSPuJ8KQ5+ZwhBMkolpNU6cmOJyElNvYSH9IAGVoKTxhrtfebFqxVEW67KrTJcypZDXapkNKlfHlE1BlmhJuSHcyrxKn2Q2cM6IUelwq2O3eZ8s1zZjymuwFiZidinMFKRIGUxAKOuWK9oxyJb8WZVMSfUoMXHatKLyqppcheU94SfyQhuHaeM8I60lguKN2PGesvB7pyJF86j03O/1mmEIakZiJ+Bwos3sK5Cy5Wj41cgt7ouWVmp/BIdWUvYR3pipdb2ZuTeK188463jnZHpLiJLXUBywlTssKPioWgyVUU3nOL8831KRCnAOaSH/Q5sJKPG397nvBr3O8b9v/vMshiTRpXL1xPPvn8VUqm0BCTYnG7W/OW0TXTTW/WsjYM5LKQsJjvI7u0SrS5Mg8zX72fnl+fP2gYFlAo3PBwnI9UqmmrRMRSukqofTnQ+8WqGWP5A+a62+DRgJP0JeSFwBGZ7POhV+smimIkGPFPjx4cGrF8cvks64n/Y7B6NR0jl+CUed5MXx0atXR/vjfTigPRsYgx/Cq5f7yTF0jqF/1DmAo7QDvV6vk/bw5UHvAPqHALxtfN4yaX9py37DhP2W5fpkH5GjskIrG6DVVBitcg/xKBWkZbI9MeazIZ14uJz1Whh67+UL+vsCM1D6AQM5OqRcN2gByieAWlzQ9gJcxqPa1J5+GxYTBrOYlFQxvdQjBIPmpKT0MLih1wZtoZUNutv//Xf6+QIv/UrwO8DYJ9Hot4/8rSwn/xsJr2Q5WZfwpHSaoG4CUs7YBBVBEUzZ2OicvffqCqh0WyPyJBbcdUa7zmjXGTU7o9DvpENw2zSzdHZ/IbOoGqDPX173Q5+1PvK+DyPyznBj0z7gbxmGrmcJJu/AMgnWsZpPl/1JNP5kd5mQ2F4srM+Zyxbt/6ctbOK6p0q8LahWi3Baz27pA+/rch7XPX1OaVt1LgUIY9sRtBK8y95AkrFbnLG8VZqJal2ZfZwBy4USeZkz6WUhc/X5Z4HKFbtA6rYt27fa5O8aubVGbnfvsbv3uO/eY9fkfxtN/iLiB9u62R98DfTh3TKJR6iWpaXP9CcXZ0wohwa8AI/rcCtzvakw76dzQUApr3WKD2POH6+vL1jYwBKdEvxJvRxqEuq050hx3iZ3DxauCr7fFegFrYzRIHk1NaJViFd29dXAM3mQ+FWmjYtYVuagOgYhJehX8aKdjHjW+eMxCP4UnUdZFa0adocs6XP6MpYCtP/otkTlF7tBE8o3bLdqcZb4Pjjh4c4Jd074tE7oD+YynYYrwyQLOC3jMd+jLLo3F+miKh719WZpJI955lxh4709KES3CYa6ic5583Lxihwv+FLzinGpRiJEHPwyKsF+EY+qwQ91Y/LTb9deT+TQl6t/+L/ZlbyHSl51ExPPOdkw+Fe/2+v2+ApAtLDxycWZv9bW1uWgGqoNX16sPrxo+ex8lYI2P9GojE3evldIEP4U3pPmlcMNeLU0Fr41zrR1NDufj8DiOyMXC5r+UCKhysFNxKdgRLg1GMx5KiyN0+2XJE3Znl1WIfKc3SdYfTGm6FosqDHmPOK3OAu36R4PZggeew/m1YvXgUfnmravNm6kY0KXYcdJkmDhPrn2phGiFyfXr3+k0Ki+dMl9HuUG7ijy4S5IqQtX+5Cfm3MJalL67MUDUQ+r23G4FndNXN3Ww3weVlzrW1SLxVItjp5JM4vFPyTgdcs=
sidebar_class_name: "patch 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={"Update a link"}
>
</Heading>

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



Updates a link

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

<ParamsDetails
  parameters={[{"schema":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"in":"path","name":"id","required":true}]}
>
  
</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"},"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"}},"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"},"attributes":{"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"},"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"}}}}},"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>