---
id: link-specification-list
title: "List link specifications"
description: "List link specifications"
sidebar_label: "List link specifications"
hide_title: true
hide_table_of_contents: true
api: eJztWltz27gV/isYzM402VK242bbRDOdHW2spN54bY9lJzt1VC1EHonYkAADgHZUjf575wAgCYq6xG7afUleYoEAzv07F3JJZQGKGS7FaUL7NOPi40QXEPMZj+1yP+Pa0IgaNte0f0vPuPhIxxFNQMeKF7iF9ukZ14bgYdI6rGlEC6ZYDgYUHl9SHaeQM9pfUiYWFzO7ZrjJgPbpaYKEFgX+rY3iYk4jOpMqZ4b2aVlyfN4mfCP4pxIIT0AYPuOgyEwqYlIguGAWREGhQIMwkBCmCSM3N6cndBUtO4QKZgwovPRfT37s3x71XrLebNB7PV6+WPXCn88f8vPZ8Sr68EF///T7r3jjd3Q1XkWUI7OfSlALGlHBchTH6kjBp5IrSGh/xjINKG2j90rb51fnG9QdaEGqORP839aSf0cOvh//+UmfxbEshakWnv74pI+kdcFiCBdZUWTeDcJlHcsi2Pddx6LnZZYVGTNod3IFWpYqBnLOciBPzq/OnzYW5WJOGEk5KKbilMcsW/cDEd6l/F2ablGdUGKv7ta0lXNxBmJuUtp/tuXWjOfcdO/tRlDOjbaeK8p8CorIGbJcZkYTBaZUAhJSgCIFmwP9r9mSs5mGL+Br5OIZHGvulNVtweZcMGsEkypZztOKXboaR1RDXCpuFjbAp8AUqEGJDN2O8bECXUihQSP7x7/+iv+1CV9Mf4fYtK1d0ZSCNLBiuYmlMEpmmWOn1iETCZEqaWmTRhR3gzAWhRo3PfxdI+VNsYKoNwqR7cyjolO8tLxi9CjEU8OdXJbdeWCgLfucizTbuDAwB+UMyfMyp/1nj/IX9HRv6J23Hz3U6pA0xl6FPnRb+7unO7aP3daGB6YUQ2fkBnK9X0E8CY3x/0wTPlx2h1hEhbQaBoHavEXYQbnXgA0hTM4Cqgfkl1IbMgXCiJCiB3lhFsSRsK4rpCHwqWQZMdKCGXKks3L+dTgaZeW84qiVtw/IoDQyZwZBNVuQOQisEiAhMyVz8sFq5QNFbmIF+GDCzCaeaqskzCBo0bJIHrL9jms+zWBiZOgA73CVZ4gu0bpHtSUc4GobQ+7qw0SDwSW95gwHpHH/+5SZw/tUkpgJogGISbn2+1r++y2ponVtmAWWnUqZARMdfk5FgmJYBYNJwalfg7rjMVhdT8HWk5AQKbIFkSIGMl0QJggX2jD8aT2X6w11pw2TcGHyByJIwnMQ2lbDAQutbEJOqj37csoqoixJOB5i2WULJHdDaAPRHeNgnLGshC8BaK+t1WorI76KCFNC/fcYj1ln3aGLET7fn1uVvOMJqP2S75dNCqg6kTWf8PBJB+9H/dHw6t3w6mw4GvXPBr/8dDKgkV1/P/xpcnlxcdYfvjo+PR9dD85fDUedZ2/t0j9vrobN4sAuvrm4eHMWrL55O6QRvXh12ixdvB1iIt0BmJt99ub0BKOEEavz9RjBhJBzcerU8OxBJvVKHe85hE+15nPBAhTfomMmLH4HkWC57jabDTrz2SbccBQhwaTJxMIHaOSApInGiEjl1pxHHmAgMGMUn5am7aCDanWvW3Zq8npfAjNWZsbF8EaBvP/7hFxzQtydYbFwxzKekJ9HF+dk5AhuiuEvIf3OHkKVyZjbDH/PTdpmwFO2RJkBwuYMMZj4EEw8g51K0C/XnI1rZS0w8+igPtm0dy2TZ5m8xw7I30BsfqT7fHZ/T8FEoGorPPMC2RIs0IxnDSEMMoiNVG0U84t7fYTnhVRmIxQHtqriZwPQbSn5cva5/nV0FFxlQwtrNWZgLtXiK1yly+nkq123I6kFQ6IHUAig0jVH4cCnSXvBJiytuwXyW1j0rNWJ3OA5dSHSuAPWQBomXr4Ji02d93cXRB1M6xY1RKeyzBLCSiOrgpxgD+hK8Ii42jqybptABhiqjgFXtreCWtewcuKY1QiXRpXgijy4Xx/lrckmWN5ubreJ9j4FYS+OGsEweAnXRBbO6JbnpsuYLtpVJlZa7COIRg7H/J80+Q2v+q2GhQNiybnoJ4xg/wKqV0NVRbjCqQeJD5+ximdZGPXDaq0b9SgC5j3at9KvoYAzzf7YWYNBewp51SBshrNWnYNw/TnW49kdemfFLEmYsflBlqYozWRXhgopBdkFydTo39CrZjhVQtgRyBsqCC//Ol8d4H8lxYzPSzek3iajHeh8NlZWcseZn4sELmRZDo04sdeUa0bYooyRYabUdfe+Tra5CvsZsS2A7xk6Hku6VYO9fpMvtNm4aujI0sQyhwNyIbAT6hNdxjFoHREhJ3HKhIAsclJPQCmpImJ4DrI0ESJIWi362mlSCnbHuPXXiHBhzT2pLGz1hvv3s/iPMmeih1LiVcSeIgkYxjOnGycrxiBONzzXdtIiTadf20nKFbfW0sFRDAzTCowDculAm0jhGXJMgA36GYtxHIC+ncC0nM9dg7NWyzgL2Xp3f02x+U3IztDYOmnECvkzy4vM9tV+epsvekijp9d2dpteCtOj6YsXR6w3/Rs87z0/nr7ovXwxe9l7fhQf//U4/uElO/4LbVp3B1XtnhXEHVdS5H5k2ujFba4Kz1v06qSs4lobN/5ca/rCeqY5+ZgGC3uenpz1WK2GniWzphXXo7S7EN9stKv97cjYjtZ8MXEeOamyzoYGOcJtrvjYtM2XJUEpdLTuchvIjMMyf2X/tc/4iXMzcu3A6f9urO64eb5plv/atqkevAPCNhg1SUo78RxcnhIcTquqbHrEoH5oUWpvl2aj+ZVMYLNJWoB2fX1ZgVYsEyDcza4qlThcxOq6fd0W0PJzJAdD9j6nlRkowFoSVesLaz8lfAD4jlKpTETSTRiMJ7GQqqt2dFHQGt8m7b34xAI4JP4uf853gLaLqrGtSoq0C5WPdoMuElvbVXppBBk7J/zhmxN+c8I/1gmtYCaVmILn9kVrwbCip4fdbywwWYK6qz6RKFVG+zQ1ptD9w0NW8IOwkj2IZd56w2prdOdS4XvWWpt4kR2m4Tbs0+wmGvk/XlcjxJ/fX1t1cTGzczrkx6ns2cHRwRFtapTW24TB5SlasZDa5EwENcqOb0JaFlk2AbbrjJcGrXpYZIxbl7SqWnrV3m74fAUTYCq1wafL5ZRpuFHZaoXL7oU4KjzhGn20eQX+ERbVpxQ23dI+teOCLRvdhwO7d+4Q+UEv/rcowjFSvXt9JCuPede/k5/6I4OGoTH+UNz1xbdY0KTAbDl4u/SnBnEMRXiqg7p4Sx1db4bXWMq1nX7NycMJkiv9qruXS7fjWn4EsVrRinWDv3EmtFr9BzgtAIA=
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={"List link specifications"}
>
</Heading>

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



List link specifications

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

<ParamsDetails
  parameters={[{"schema":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"type":"string","pattern":"^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12},\\s*)*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}]},"in":"query","name":"id","required":false},{"schema":{"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"},"in":"query","name":"nrn","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"limit","required":false,"description":"Limits the number of results returned per page"},{"schema":{"type":"string","minLength":1},"in":"query","name":"offset","required":false,"description":"Specifies the offset for paginating through results"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Object representing pagination parameters for controlling the number and order of results","content":{"application/json":{"schema":{"title":"LinkSpecificationList","type":"object","properties":{"paging":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"description":"Limits the number of results returned"},"offset":{"type":"integer","minimum":0,"description":"Specifies the offset for paginated results"}},"required":["limit","offset"]},"results":{"type":"array","items":{"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,"not":{"enum":[null]},"description":"Name of the entity. Must be a non-empty string and not equal to null"},"slug":{"type":"string","minLength":1,"not":{"enum":[null]},"description":"Slug of the specification. Automatically generated from \"name\""},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"visible_to":{"title":"Visibility","type":"array","description":"Array representing visibility settings for the entity. Specifies what/who can see this entity","items":{"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"}},"unique":{"type":"boolean","description":"Indicates whether the service can be linked only once by an instance of this link specification"},"specification_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"dimensions":{"title":"Specification Dimension","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"required":{"type":"boolean"},"values":{"type":"array","items":{"type":"string"}}},"additionalProperties":false,"required":["required"]}},"scopes":{"title":"Specification Scope","type":"object","properties":{"provider":{"type":"object","properties":{"values":{"type":"array","items":{"oneOf":[{"type":"string","enum":["AWS:SERVERLESS:LAMBDA","AWS:WEB_POOL:EC2INSTANCES","AWS:WEB_POOL:EKS","AZURE:WEB_POOL:AKS","GOOGLE:WEB_POOL:GKE","OCI:WEB_POOL:OKE"]},{"type":"string","format":"uuid","description":"UUID of a scope specification"}]},"minItems":1}},"additionalProperties":false,"required":["values"]}},"additionalProperties":false},"assignable_to":{"type":"string","enum":["any","dimension","scope"],"description":"Specifies if the service can be assigned to any entity, only dimensions, or only scopes."},"attributes":{"title":"Attribute","type":"object","properties":{"schema":{"type":"object","default":{},"description":"Specification of the attribute schema. Must be a valid JSON Schema"},"values":{"type":"object","default":{},"description":"Values associated with the attribute. Must validate against provided schema"}},"required":["schema","values"],"propertyNames":{"enum":["schema","values"],"description":"Allowed property names"},"additionalProperties":false,"description":"Object representing an attribute with a schema and associated values"},"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"},"use_default_actions":{"type":"boolean","description":"Specifies if the link specification should autogenerate its create, update, and delete actions from the attributes schema. Defaults to true for new specifications"},"use_default_naming":{"type":"boolean","description":"When true, the link name is optional and generated by nullplatform or taken from the schema's `name` property. When false, a caller-provided name is required. Defaults to true for new specifications"},"external":{"title":"External","type":"object","nullable":true,"properties":{"action":{"type":"string","minLength":1,"description":"Action to send to the agent for resolving external data"},"output_schema":{"type":"object","description":"JSON Schema to validate the agent response against"}},"additionalProperties":false,"required":["action","output_schema"],"description":"Configuration for resolving external context data via the nullplatform agent"},"external_resolution":{"type":"object","description":"Status of the external context resolution when the link specification was read","properties":{"status":{"type":"string","description":"Resolution outcome. One of: success, no_channel, agent_error, timeout, auth_error, service_unavailable, invalid_response"},"error":{"type":"string","description":"Human-readable error detail when status is not success"},"notification_id":{"type":"string","description":"ID of the notification sent to the agent. Present on error statuses to facilitate debugging"}},"required":["status"]}},"description":"Object representing link specifications","additionalProperties":false,"title":"LinkSpecification","example":{"name":"my-link-specification","specification_id":"eb0b880a-b7e4-42b8-98f9-40c262c59a23","unique":true,"dimensions":{"environment":{"required":true,"values":["production","staging"]}},"scopes":{"provider":{"values":["AWS:SERVERLESS:LAMBDA","AWS:WEB_POOL:EC2INSTANCES","uuid-of-a-specific-scope-specification"]}},"assignable_to":"any","attributes":{"schema":{"type":"object","properties":{"my_string_property":{"type":"string"},"my_number_property":{"type":"number","default":0}},"required":["my_string_property"]},"values":{}}}}}},"required":["paging","results"],"description":"Object representing pagination parameters for controlling the number and order of results"}}}},"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>