Sign in
Link

Read a link specification

Read a link specification

get/link_specification/{id}

Path parameters

idstring uuid required

Unique identifier for the entity represented as a UUID

Query parameters

service_idstring uuid

Service ID for dynamic additional properties

link_idstring uuid

Link ID for dynamic additional properties

application_idinteger

Application ID for dynamic additional properties

scope_idinteger

Scope ID for dynamic additional properties

dimensionsstring

Dimension key-value pairs used for dynamic additional properties

Response

Object representing link specifications

idstring uuid

Unique identifier for the entity represented as a UUID

created_atstring date
updated_atstring date
visible_toDef2[]

Array representing visibility settings for the entity. Specifies what/who can see this entity

uniqueboolean

Indicates whether the service can be linked only once by an instance of this link specification

specification_idstring uuid

Unique identifier for the entity represented as a UUID

dimensionsDef9
assignable_to'any' | 'dimension' | 'scope'

Specifies if the service can be assigned to any entity, only dimensions, or only scopes.

use_default_actionsboolean

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_namingboolean

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

Example response

{
  "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": {}
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.