---
id: action-specification-read
title: "Read an action specification"
description: "Read an action specification of a service or link."
sidebar_label: "Read an action specification"
hide_title: true
hide_table_of_contents: true
api: eJztWm1v2zgS/isEUWDbnuSkjdNrDCyKoC+3Wey1wSa9W1ziM2hxbHFLkSpJOXUN/ffDkJIsyS9J2h56BzRfYknU8JkXzjxDcUV1DoY5odUZpyPKEvw5sTkkYiYS/2BkgHEaUcfmlo6u6KkfQ8cR5WATI3J/OaK/A+OEKRJkkI4MomeEEQtmIRIg2hAp1IcBjWjODMvAgUHRK2qTFDJGRyvqljnQEbXOCDWnEZ1pkzFHR7QoBKdlRAXO+bEAs6QRVSzzo8MEE4F4DXwshAFORzMmLfThXlRgzl6RmTaELxXLREIY5wJHMElyg8ZxAiwto6/GhhrfCdhvQn34ClRCOZiD2QWD5bmsnHInNKfr8f89UDbR+R29hiO/hc9y5hwYFPnvhy9GVyz+fBr/6zA+mcTjv/QuH74YRXsHPHr86MWDXbpxkYGyQit7u3av6rHkAyzjBZMFkJwJY0lhgd9fZ+EkQjjzy3dv0PaRvFfiYwFEcFBOzAQYP7lLgeANtyQGcgMWlANOmCWMvH9/9qqxQc5cujZBz7HOFFCOI2ohKYxwS7/yp8AMmNPCpXR0NcbHBmyulQWLqjz94w/81wX5bvonJG4NRaj51uyDlk+0cqAcCmktgYM/LUraEijay8ZAWVt3tEJVvpdhgzE3IzkT6jdQczTck4gq7XUEVWR0dKUKKcdlH8NblgFm5PWsA/L3wjoyBcKI0iqGLHdLEqYgTHGitCPwsWCSOE1QKiKysph/G0QXspjXiDquG5DTwumMOZEwKZdkDgrrFS4GozNy7a1yTRFNYgAfTJjbm6M5c4DDi5zfZ3gYsDmwUquandZyvd8l+B/MJKlY+Gdq/TsprNMZjhNsrrSFzYp6ucwbP4W4HpCLVBeSo6e0gp7JgBOfMywRyt8PpdqLQZxVpUd12nV3Hc+nzhkxLTzq/etg93rhMGOFRKNuerlPCbxi9ZwkyGyH4oJJwcmvF+/ekoswYRnRoOI9p/5HsAuzVifCx8+NcGkXQDWzn5Q5IGzOhLIO8+tCcOAVQFqW7Wx2VduiQTZujLXElWZb0b9tbK/eSqlvgNdJfUmUF1FGdJ3xz1uu2FpHtiZG1TK1V55VCvkF3rJMBc1raQvpfoTIjxDZGSI15e5k7Ukok0wt3818df8eBbNxflWubuWAh/EJi2en8Zvx6nkZty+H97l88rSMrq/t40ePv6HEB7TciIPdlml5qu65Ov5Bx/l+5IfX/je9hs7ZdJkBZ5ZsKttEZKq1BKbaqW3rej9THCWBJTcpuBRMi1WQhCnMpigfSYQIaRczG1MJEOEJBSMzJiSGlGMOBjWLkBKk+PxtIGWFdCKX66ltKAHC9pDCJ0gKNJRQpAYxIO+UXJKK3U8lIFUNLIsgskqE9ciZUtpVzUG7ujW3by1vplB2ohdg9rFCDrnUywwbjyh0uRQ7pKDcZmZ/HdaGR4uiyU0qkrTtKa9dlXlTfTMJ3Us1PTOGYecpHGR2H6waSQ7GL2MEE9GMKTYPzLVBvQHxXDKMCOWbgFwyhwLQgQbaOG+ElL5AV36YAnFGzOeABRHZt18FZwGobwi/RflqfBqqV6+J7pb/MqLwCRMJk+0IeF3f2/Q/ahxWHwLux0NQ/PZ2qFfLg7mcJhYUx//eiHNQzucFA1bLBWpXgyWcOU9ydOHywk320az2TC2KhNM0FGY9X91w16yG3uqTNsWp9O/j2gigl1rNxLwIrcguHX23/sl5XclCMI+yE3EeMpoBFPqET25S2Gr9xuV0wyQvtQrKEZcyR7KKVGbg1jm58Y8pfA4WyXYnt6vS/s2iFw82gJwluLS3Ec+q63vji+2I/ITTxxbcyP9YMCO8HX8akNftlh0znwRmBi0L7cjQ2zOyaHedWAAqIYRDDorjHFqRju1bC2riXVr0FsSOwLxwzBW22Y/oh8BaFGYZ1YbV3WK+YZZUW9W9RsRPsD02uhvYzUy6cInOAEsKNtkjYoskAWsjovQkSZlSIKMQgxMwRpuIOJGBLlxEWOHS+mbNjgvFFkz47BERofzim9TrzVsOx98O8ZciYypGLX1i9W8RDo4JGawTdEWH4Y5NhdrvHmnXJ3r7pzp7Vbuk/SqmKddJUwNyHlKwDwgPKIAAi+NmLBFSIGMgHKbFfI5zbbRHwUPjcqMpu88W395U1VR4/3KnzcTC+IlleeBV1Z5ltoyRhMW2N7IyWrN7091Iues2YracBLNP6iZu0yFlhMNUkU3BbBsWnrQz3GHfrlumGbfb47Lb4/8fot/dftInR8Pj4ZA9i9nh85N4eDRl8Qk/fhofT5/BMxjO2HP+hO7sg+jsCJ5P4eQwPjw5fhoPjw+fxVN+PIyTIfz1mB2z4dHJEe1w8ooVtDlxuNUtUXRQgR6sPw0MQC2E0Qo5F/n5Z3JNOSxA6hxvXGPl6hHWFvts2FxDCLcTvHHp/yI63LaXHipMVY9bi82vaEt44evK6fkZwW85puLS99pYrxmWT3W37h75lPBSc9geNJ2seHl5Xme+RHOkp76O+UqYVmnSbxF3xe3IfFWHFnKZlxesMgMD2A7hXghWybk24nPTnN0xg1+k2riIpNsSeeD9pha+9IsIrEVWfqvgV74KAK9kVe9VO1M+ba6/GFW1lW7m2y8Og8107n1X22WtyDgE4fGPIPwRhN83CL1iLtWY7efgAolP6YgebDsGcbASvKSh4tTHFQoj6YimzuV2dHDAcjFo9yiDRGe0/aHTd18hstqfOxujoiC/T4DDkKb7QTSqfrypd9x+/eelt5pQM42vI55guSeDw8EhXbOdt+2W6fT8zG/aaOsyplpcZ9/Jjb6LV+u19mUnPipd0fUHuWTCx6035Kqy/9XWYyg0oiPBsZ9MtXU4arWaMgvvjSxLvB2+u6NbuLBVx7Nt76Ctwb0OgezA/gGW/aMnnqJgx4n7l3dHc/eTH3uhrE+afCGOe5/52Atn48TJF6K6x9GP/Z5aHzb5QiRffUxjL77OgZE1wjFeGBGo5r2C/OHvVVp8RHbNXG8gqmV7zhoRHmpC5p0C48g4r1bVg9Mkgdy1Xtkovgi7SbJ/e32JTLab9HpJLnx42AZntQojLvUHUGXZoHN4jQDL8j+cIZR5
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 an action specification"}
>
</Heading>

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



Read an action specification of a service or link.

<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}]}
>
  
</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>