---
id: link-read
title: "Read a link"
description: "Read a link"
sidebar_label: "Read a link"
hide_title: true
hide_table_of_contents: true
api: eJztWG1vGzcS/isEcR+Su5UsObYTL1AcjHN6517qBraDFlB86og70rLmkhuSq0Qn7H8vhtyVdiXlxYce/KX6IooiZx4+80quuSnRgpdGX2U85Urqh9QiZDzhHhaOpxP+RuoHfp/wDJ2wsqS1POU3CBkDRht4wkuwUKBHSzvW3IkcC+DpmnvpFfKUXwWJq5LGzlupFzzhc2ML8DzlVSXp/76Gd1p+qJDJDLWXc4mWzY1lPkdGE37FLJYWHWqPGQPHgL17d3XJ64RL2l6Cz3nCNRSkM8i3+KGSFjOeelthfZ9wh6Ky0q8C6hmCRXtR+Zynk3v626IrjXbo6CjHv/xCX32QP81+Q+G3UKReBE6Y1M6DFuh4woXRHrWn3VCWSopA+NFvjkT02IoEmSCUaLVkHi8jAJk9GaORxfWevkLqN6gXxNg44QV8an8dn54mXJtwZtRVwdOJrpS6r3cxXUOBzMw7KIbsx8p5NkMGTBs9wKL0KxZVMtAZ08Yz/FCBYt4wkkoInaoW/x+Et6pa7CK8qLwpwEsBSq3YAjUFEWZsbk3B3ge63vMAq0Qh543Fp09owQwduf70ECDQq5/mIQSeAtrGZtGUe5nmMiJn1WcVgHNGyGCA3vHo3AU6B4sYQO3pfoxz2yOCtbDiCZceC/f1QFS4RHXI2Ro/4hnOKvot9dw0X0QdQUr4R7DtV7PLWmOJX/CgYqadQ6WI6UZAn5AGPnO4REpeLOAZssu4zVFYvA9bow82FBwC3Bd8R1wKT5HV7GFt6qoT7mWBzkNRdgTpqpih3RfULm3jphUnNSukUtKhMDpzvK67WXmygXqfcMgySeJAve2QPwflcFfdoSTc2p19lD7foSrqFRbJZabgDzGzcfYMPNLxqzJ7zHKwIpfLb1yfBN+HGXknlabdA/6cow48tlWFfQTHFDjPWj1D9ivJ+JV9zKXC/mLpQs5sl4a85MFX7ks+XKLOpF5MI00UA3GCN8zFYWAlDqP4Ziy8XCLf0hDcW6owEARK0Xgv1m8DrNZrqJAO2W1uKpVRPTB6UyqaOMeMLUFV6MizYq6piqahCcdEu5QCnzTxygK1k0b3UtBlO7tFskk2hz3/EaVtPBp9W2n7N64GgT9WgrSuH0Fb4EP2GkTOHnDFil5pJqltZQ5xBqyQWhZVwVTAQuYa8z29hwJ2qy6KeuhjCzHlvZWzyuPBHN1XcbFZ2y0PQXLrWglzG9dagpIZgwVQ0GxW9MsJ2+hnTctWU7iQ+afa6q55r2+uD7hYCd4jLeT/MXYBWv43yP1uMhqc//X+b89SEMJU2rcTz//+LKVWwpUgsDvZ6SK7006YsrPuL3ukXFdKlQo8+Tq7QWcqK5CFFuzZ9c31875FgOUSbYhgAWrX93VXlm1kuRh0CoU3tufwt83kAX/f6XKL0liPWcfEM2MUguadyhjqQB32LmWG9vHxsS2yoFcEW4DHhbGrP0CUq2bTP0xc/fmM0GncHqGh13KF+t2Zabne78u+kD3MgXjeVJ+tO9TflAj2rk9f7ARa/3oTL6L4CYpShV6nufkVq0FzSe0WA35+evLqxfkLMZiPs/HgZDYTg/OXcDYQL87PXr06O54fwwk/1L/zU3j18licw+AcxmeDEzjLBjAajQbZCF+ejE5gfArA+4mB98J9vInzcSe8x72oHvPdyoF6Ka3RRbhIkt9nlWjLXD8xFqspnXi6mQ0sTIOpeB0+CT85dJv9PtTAEN49k4QO1bGsCpn+4u0Vk9qjhQDgcTfcxlyvm573y7kgdin/MBl+vef8193dWxY3MGEyan+ygEMvYp0OGinO++I+0ws3BT/sivIiK3O0SF5NF9EmxBu7hmoQlHxV+G1urE9YXhWgB/TcQq1fo4t2MtLZ5o/HdPCX6EOX1chq2+6YJUNO38RSbO0/+QNR+T+7QbeV79hue8XZ9PfRCU//dMI/nfBpnTAczOeGMvsCfezScp7yI8qhR2uZ1U3paB83K6t4ynPvS5ceHUEph91WaChMwbtPi7fkdtGTug+MGxJJEGkIy6gAh0U8aQbft9eSH36+CyyFJ4F0zQlPZGo8HA1HfFsKe13exdsrMl5pnC9Ad+pi/wG3x/16G0o7yxrMZLKjUoEM/hYIWTe8TXizNJXhfpcb52l2vZ6Bw3dW1TVNf6iQWqPJfcKXYGW8+k7WPJOOxtnhm34X2LObxs7P2eeAta87mt52YvlLOU/4A67ik3BoanKE0EBO1s0fF0Jg6Ttb9rIJ2XfjNf98fUdNSt+qO1bs9mh9OOt1XHFnHlDX9Qadp98EsK5/B0KoOi4=
sidebar_class_name: "get 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={"Read a link"}
>
</Heading>

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



Read 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={undefined}
>
  
</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>