---
id: link-specification-action-read
title: "Read a link specification action"
description: "Read a link specification action"
sidebar_label: "Read a link specification action"
hide_title: true
hide_table_of_contents: true
api: eJztWm1v2zgS/isEUWDbnuSkTdJrDCyKoC+3Xuy1wSa9W1ziM2hxbHFLkSpJOXUN/ffDkJIs2bKTdHvXPaD5ElumZh7ODGeeGWlFdQ6GOaHViNMhlUJ9mNgcEjETib88YQn+GxpgnEbUsbmlwyt65q/ScUQ52MSI3H8d0l+BccIIyiEdOSTIoRHNmWEZODAoaEVtkkLG6HBF3TIHOqTWGaHmNKIzbTLm6JAWheC0jKhADR8LMEsaUcUyvxrMQiQwEYjOwMdCGOB0OGPSwia4i7CWjF6RmTaELxXLREIY5wJXMElyg/ZwAiwtoz+MzVvzLsB+QXN9OSqhHMzB7ILB8lzW3rwLmrP1+v8eKJvo/I5ew5Vfw2c5cw4Mivz3wxfDKxZ/Pov/dRifTuLxXza+PnwxjPYuePT40YsHu/bGRQbKCq3s7bt7Va8lH2AZL5gsgORMGEsKC/z+exZOIoSRP6x7g3YTyXslPhZABAflxEyA8cpdCgQvuCUxkBuwoBxwwixh5P370avGBjlz6doEG451poA/J1A8oxftRDXqQT6OqIWkMMItfc6aAjNgzgqX0uHVGH82YHOtLFjc29PffsN/XdTvpr9D4tbYhJpXObGbKDFmEq0cKIdCWof34HeLknpCXHvZGOLruBiu0AnfytLButtnMBPqF1BzNNyTiCrt9wiqyOjwShVSjstNDG9ZBkTPWloH5O+FdWQKhBGlVQxZ7pYkqCBMcaK0I/CxYJI4TVAqIrKymH8dRBeymNeIOq4bkLPC6Yw5kTApl2QOCosrHmOjM3LtrXJNEU1iAH+YMLe3unDmAJcXOb/P8rBge2G1rUo7reV6v0vwH5hJUrHwv6n156SwTme4TrC50ha2K//lMm/8FOJ6QC5SXUiOntIKNkwGnPhsZ4lQ/nqgFF4M4qxoCW6nzRjW8XzmnBHTwqPefw52nxcOM1ZINOq2lzvspd5YrZMEme1QXDApOPn54t1bchEUlhENW7yn6n8EuzBrdSJ8/NwIl3YBVJq9UuaAsDkTyjqsDAvBgVcAaVm2s9lVbYsG2bgx1hJPmm1Ff9/aDaYgpb4BXpejJVFeRBnRda06b7mitwL2JkbVMrXfPKs25A94yzIVNL9LW0j3PUS+h8jOEKmbhW6HE8okU8t3M1/dv0XBbJxflatb2ethfMri2Vn8Zrx6Xsbtr8f3+frkaRldX9vHjx5/RYkPaLkVB7st0/JU5Z9uVUXH9fSl3732Z/HadrMf0rEzSzaVbSIy1VoCU+3U1nveR4qjJLDkJgWXgmmxCpIwhdkU5SOJECHtYmZjKgEiPKFgZMaExJByzMGgZhFSghSfvw6krJBO5HKt2oYSIOwGUvgESYGGEorUIAbknZJLUrH7qQSkqoFlEURWibAeOVNKu6o5aFe35vKt5c0Uyk70Asw+Vsghl3qZYeMRhf6cYssUNred2V+Hs+HRomhyk4okbXvK767KvKm+mYTupVLPjGHYMwsHmd0Hq0aSg/HHGMFENGOKzQNzbVBvQTyXDCNC+SYgl8yhAHSggTbOGyGlL9CVH6ZAnBHzOWBBRPbtT8EoAPUN4dcoX41PQ/XaaP+75b+MKHzCRMJkOwJe19e2/Y87DqcPAW/GQzWMu7Ud2qjlwVxOEwuK439vxDko5/OCAavlAndXgyWcOU9ydOHywk320ay2phZFQjUNhVnrqxvumtXQW33SpjjNMLKLayuAXmo1E/MitCK79ui79U/O75UsBPMoOxHnIaMZQKFP+OQmhV7rNy6nWyZ5qVXYHHEpcySrSGUGbp2TG/+YwudgkfQ7uV2V9o+5XjzYAjJK8Gj3Ec+q63vji+2Q/IDqYwtu6D8smBHejj8MyOt2y46ZTwIzg5aFdmTo/ows2l0nFoBKCOGQg+KoQyvSsX3rQE28S4uNA7EjMC8cc4Vt5hGbIbAWhVlGtWF1p+E3zJJqpL7RiHgF/bHRHbQ3mnThEp0BlhRssofEFkkC1kZE6UmSMqVARiEGJ2CMNhFxIgNduIiwwqX1xZodF4otmPDZIyJC+cM3qc+btxyuvx3iT0XGVIy79InV30U4OCZksE7YKzoMJzYVaj890m6T6O1XNXpVu6R9K6Yp10lTA3IeUrAPCA8ogACL62YsEVIgYyAcpsV8jrq22qPgoXG51ZTdZ8S3N1U1Fd7f3GkzsTB+YlkeeFU1xMyWMZKw2G6srIzWTG+6g5S7jhGz5SSYfVI3cdsOKSNcpopsCqZvWfilneEON+3ao2bcbo/Lbo//f4h+d/tJnxwdnxwfs2cxO3x+Gh8fTVl8yk+exifTZ/AMjmfsOX9Cd/ZBdHYEz6dwehgfnp48jY9PDp/FU35yHCfH8NcTdsKOj06PaIeTV6ygzYnDpW6JooMK9GD9UGMAaiGMVsi5yI8/kmvKYQFS53jhGivXBmFtsc+GzTWEsJ/gjUv/F9Hjvll6qDBVPW4dNn+iLeGFrytn5yOCT6FMxaXvNVivGZZPdbdOj3xKeKk59AdNJyteXp7XmS/RHOmpr2O+EqZVmvQj4q64HZmv6tBCLvPyglVmYADbIZyFYJWcayM+N83ZHTP4RaqNi0jal8gD7ze18KU/RGAtsvJbBb/yVQB4Jau6r5pM+bS5ftZV1Va6nW+/OAy207n3XW2X9UbGIQhPvgfh9yD8tkHoN+ZSjdl+Di6Q+JQO6cF2TThY9TzVLA+C6s2lgpc0lKb6jYzCSDqkqXO5HR4csFwM2s3MINEZbT8R9W1aCMH2c9HG+ijIDxRwGfJ5v4hG1Yc39Wju539eevMKNdN4O+IJJn4yOBwc0jUtetvurc7OR366o63LmGqRoju8itLx5Gp9MO9yb7U7jIqDXDLhQ9qbblW55qqnXNOIDvsfOfd5B1cLjm1pqq1DiavVlFl4b2RZ4uXw4gE6jQtbNU59I4j23u71FsyOfX6A5ea7N57pYOOKY9C7o7n7qy97oaxftflCHPd+6WUvnK1Xbr4Q1T3efdnvqfXbNl+I5A+/p7IXX+eNmTXCMX4xIjDWewX5w1+r7PqI7NJczyHVsq2zRuTf6vqfauxLCyX2ECkwjtz5alWtPEsSyF1LxhaNQMs15eJvry8xv3Sz8kYWDo9Q+vCtVmHFpf4AqiwbuA6/I8Cy/A9Zsxgw
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 specification action"}
>
</Heading>

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



Read a link specification action

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

<ParamsDetails
  parameters={[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"service_id","required":false,"description":"Service ID for dynamic additional properties"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"link_id","required":false,"description":"Link ID for dynamic additional properties"},{"schema":{"type":"integer"},"in":"query","name":"application_id","required":false,"description":"Application ID for dynamic additional properties"},{"schema":{"type":"integer"},"in":"query","name":"scope_id","required":false,"description":"Scope ID for dynamic additional properties"},{"schema":{"type":"string","pattern":"^(?:[a-zA-Z0-9_-]+:[a-zA-Z0-9_-]+(?:,[a-zA-Z0-9_-]+:[a-zA-Z0-9_-]+)*)?$"},"in":"query","name":"dimensions","required":false,"description":"Dimension key-value pairs used for dynamic additional properties"},{"schema":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"in":"path","name":"id","required":true},{"schema":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"in":"path","name":"linkSpecificationId","required":true}]}
>
  
</ParamsDetails>

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Object representing action specifications","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,"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"},"type":{"type":"string","enum":["create","update","delete","archive","unarchive","custom","diagnose"],"description":"Type of the action. Should be one of the specified values in the ActionType enumeration"},"parameters":{"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"},"results":{"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"},"service_specification_id":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"type":"null"},{"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}$"}],"description":"Unique identifier for the associated service specification"},"link_specification_id":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"type":"null"},{"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}$"}],"description":"Unique identifier for the associated link specification"},"retryable":{"type":"boolean","default":false,"description":"Indicates whether the action can be retried if the instance is in a failed state."},"parallelize":{"type":"boolean","default":false,"description":"Indicates whether multiple instances of this action can be executed in parallel. Only applicable to custom type actions."},"annotations":{"title":"Annotation","type":"object","properties":{"runs_over":{"type":"string","enum":["deployment","scope","instance"],"description":"Entity type over which the action applies"},"show_on":{"type":"array","items":{"type":"string","enum":["scope","performance","manage","deployment"],"description":"Place in nullplatform where the action will be able to be triggered"},"uniqueItems":true}},"additionalProperties":false,"description":"Object representing annotations with key-value pairs","default":{}},"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"},"enabled_when":{"type":"string","default":"","description":"Condition that must be met for the action to run"},"icon":{"type":"string","pattern":"^([a-zA-Z0-9_-]+:[a-zA-Z0-9_-]+)?$","description":"Icon associated with the action. Format: 'icon-set:icon-variation'. Empty string to clear."},"enabled":{"type":"boolean","description":"Indicates if the action is enabled depending on enabled_when"},"external_resolution":{"type":"object","description":"Status of the external context resolution when the action 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 action specifications","additionalProperties":false,"title":"ActionSpecification","example":{"name":"my-link-specification","type":"custom","parameters":{"schema":{"type":"object","properties":{"my_string_property":{"type":"string"},"my_number_property":{"type":"number","default":0}},"required":["my_string_property"]},"values":{}},"results":{"schema":{"type":"object","properties":{"my_string_property":{"type":"string"},"my_number_property":{"type":"number","default":0}},"required":["my_string_property"]},"values":{}},"service_specification_id":"134544a6-a089-43ba-9d52-5b6e6e4fa8d1","link_specification_id":"f3e8be90-0952-4506-bd54-c4e75a5a4393","retryable":true,"parallelize":true,"enabled_when":".service.dimensions.environment == \"development\"","annotations":{"runs_over":"scope","show_on":["scope","performance"]}}}}}},"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>