---
title: "Read a link specification"
method: GET
path: "/link_specification/{id}"
tags: ["Link"]
---

# Read a link specification

`GET /link_specification/{id}`

Read a link specification

## Path parameters

- `id` string, uuid, required — Unique identifier for the entity represented as a UUID

## Query parameters

- `service_id` string, uuid
- `link_id` string, uuid
- `application_id` integer
- `scope_id` integer
- `dimensions` string

## Response `2XX`

Object representing link specifications

- object — Object representing link specifications
  - `id` string, uuid — Unique identifier for the entity represented as a UUID
  - `created_at` string, date
  - `updated_at` string, date
  - `visible_to` Def2[] — Array representing visibility settings for the entity. Specifies what/who can see this entity
  - `unique` boolean — Indicates whether the service can be linked only once by an instance of this link specification
  - `specification_id` string, uuid — Unique identifier for the entity represented as a UUID
  - `dimensions` Def9
  - `scopes` Def10
    - `provider` object
      - `values` union[], required
        - union
          - 'AWS:SERVERLESS:LAMBDA' | 'AWS:WEB_POOL:EC2INSTANCES' | 'AWS:WEB_POOL:EKS' | 'AZURE:WEB_POOL:AKS' | 'GOOGLE:WEB_POOL:GKE' | 'OCI:WEB_POOL:OKE'
          - string, uuid — UUID of a scope specification
  - `assignable_to` 'any' | 'dimension' | 'scope' — Specifies if the service can be assigned to any entity, only dimensions, or only scopes.
  - `attributes` Def7 — Object representing an attribute with a schema and associated values
    - `schema` object, required — Specification of the attribute schema. Must be a valid JSON Schema
    - `values` object, required — Values associated with the attribute. Must validate against provided schema
  - `selectors` Def6 — Key-value object representing instance selectors
    - `imported` boolean
    - `provider` string
    - `category` string
    - `sub_category` string
  - `use_default_actions` boolean — 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` boolean — 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` Def12, nullable — Configuration for resolving external context data via the nullplatform agent
    - `action` string, required — Action to send to the agent for resolving external data
    - `output_schema` object, required — JSON Schema to validate the agent response against
  - `external_resolution` object — Status of the external context resolution when the link specification was read
    - `status` string, required — Resolution outcome. One of: success, no_channel, agent_error, timeout, auth_error, service_unavailable, invalid_response
    - `error` string — Human-readable error detail when status is not success
    - `notification_id` string — ID of the notification sent to the agent. Present on error statuses to facilitate debugging

## Other responses

- `4XX` — Format for representing errors during API interactions
- `5XX` — Format for representing errors during API interactions

---

[API](https://skmtc.dev/nullplatform/apis/nullplatform-api.md) · [All operations](https://skmtc.dev/nullplatform/apis/nullplatform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nullplatform/nullplatform-api/revisions/1c4ea154b159/schema)