---
id: service-specification-actions-read
title: "Read a service action specification"
description: "Read an action specification of a service specification"
sidebar_label: "Read a service action specification"
hide_title: true
hide_table_of_contents: true
api: eJztWm1v2zgS/isEUWDbnuSkbdJtDCyKoC+3Xuy1wSa9W1ziM2hxbHFLkSpJOXUN/ffFkJIsy7KTtL3rHtB8iSVRw2deOPMMxRXVORjmhFYjTofUglmIBCY2h0TMROKfTFiC/+zQAOM0oo7NLR1e0lN/m44jysEmRuT+ckh/A8YJUyS8RjZkET0jjFTTbD6iEc2ZYRk4MCh/RW2SQsbocEXdMgeE54xQcxrRmTYZc3RIi0JwWkZU4MQfCjBLGlHFMmgpIxC0gQ+FMMDpcMakhS7m8wrR6CWZaUP4UrFMJIRxLnAEkyQ3aConwNIy+mJsUqj3twL2q1DvvwCVUA7mYHbBYHkuay/fBs3pevx/D5RNdH5Lr+HIr+GznDkHBkX+5/7z4SWLP53G/z6MTybx+G+dy/vPh9HeAQ8ePnh+b5duXGSgLK6mm7V7WY8l72EZL5gsgORMGEsKC/zuOgsnEcLIr+G9QdtF8k6JDwUQwUE5MRNg/OQuBYI33JIYyA1YUA44YZYw8u7d6GVjg5y5dG2CjmOdKeCvCbTKH+ftJDXqAT+OqIWkMMItfdqaAjNgTguX0uHlGB8bsLlWFiyq9/j33/HfJvC30z8gcWt4Qs178yeGTaKVA+VQSGv9HvxhUVJPlGsvG6N8HRrDFfrhWxk7GHh7GWZC/QpqjoZ7FFGlvY6giowOL1Uh5bjsYnjDMsCasp51QP5RWEemQBhRWsWQ5W5JwhSEKU6UdgQ+FEwSpwlKRURWFvOvg+hcFvMa0YbrBuS0cDpjTiRMyiWZg8LSiyvZ6IxceatcUUSTGMAHE+b2FhjOHODwIud3GR4GbA+s1Kpmp7Vc73cJ/gczSSoW/pla/04K63SG4wSbK21hmxNcLPPGTyGuB+Q81YXk6CmtoGMy4MQnPEuE8vcD2fBiEGdFWlCdNmlYx/Opc0ZMC496/zrYvV44zFgh0ajbXu6SGq9YPScJMtuhuGBScPLL+ds35DxMWEY0qHjHqf8Z7MKs1Ynw8XMtXLoJoJrZT8ocEDZnQlmHxWEhOPAKIC3Ldja7rG3RIBs3xlriSrOt6O8b2yELUupr4HVFWhLlRZQRXZers5Yreotgb2JULVN75VmlkF/gLctU0LyWtpDue4h8D5GdIdLf/IQyydTy7cxX929RMBvnV+XqRgJ7GJ+weHYavx6vnpVx+/LoLpePHpfR1ZV9+ODhV5R4j5ZbcbDbMi1P9XeNZRSaqe9e+2t6DZ2z7TIDzizZVLaJyFRrCUy1U1vveh8pjpLAkusUXAqmxSpIwhRmU5SPJEKEtIuZjakEiPCEgpEZExJDyjEHg5pFSAlSfPo6kLJCOpHL9dQ2lABhO0jhIyQFGkooUoMYkLdKLknF7qcSkKoGlkUQWSXCeuRMKe2q5qBd3ZrbN5Y3Uyg70Qsw+1ghh1zqZYaNRxRadIpdU1BuO7O/CmvDo0XR5DoVSdr2lNeuyrypvp6E7qWanhnDsG0WDjK7D1aNJAfjlzGCiWjGFJsH5tqg3oJ4JhlGhPJNQC6ZQwHoQANtnNdCSl+gKz9MgTgj5nPAgojs26+CUQDqG8KvUb4an4bq1dkB2Cz/ZUThIyYSJtsR8Kq+t+1/1DisPgTcjYeg+M3tUKeWB3M5TSwojv+9EeegnM8LBqyWC9SuBks4c57k6MLlhZvso1ntmVoUCadpKMx6vrrhrlkNvdEnbYpT6d/FtRVAL7SaiXkRWpFdOvpu/aPzupKFYB7lRsR5yGgGUOgTPrlOodf6jcvplkleaBWUIy5ljmQVqczArXNy4x9T+Bwskn4nt6vS/p2u5/e2gIwSXNp9xLPq+l77YjskP+D0sQU39D8WzAhvxx8G5FW7ZcfMJ4GZQctCOzJ0f0YW7a4TC0AlhHDIQXGcQyuyYfvWgpp4lxadBbEjMM8dc4Vt9iO6IbAWhVlGtWFtbpJfM0uqzfZOI+In6I+NzS34ZiZduERngCUFm+whsUWSgLURUXqSpEwpkFGIwQkYo01EnMhAFy4irHBpfbNmx4ViCyZ89oiIUH7xTer15i2H42+G+HORMRWjlj6x+rcIB8eEDNYJuqLDcMemQu13j7TrEr39U41e1i5pv4ppym2kqQE5CynYB4QHFECAxXEzlggpkDEQDtNiPse5ttqj4KFxudWU3WWLb2+qaiq8f/m88w0FPrIsD7yq2sfMljGSsLj7taUyWrN7s7mRctttxGw5CWaf1E3ctkPKCIepIpuC6RsWnrQz3GHXrj3TjNvtcbnZ4/8fot/dftJHT46Oj47Y05gdPjuJj55MWXzCjx/Hx9On8BSOZuwZf0R39kF09gSeTeHkMD48OX4cHx0fPo2n/PgoTo7gx2N2zI6enDyhG5y8YgVtThxubZYoOqhAD9bfNQagFsJohZyL/PQTuaIcFiB1jjeusHJ1CGuLfTZsriGE/QRvXPq/iB717aWHClPV49Zi8yvaEl74unJ6NiL4IcpUXPpOG+s1w/Kp7sbdI58SXmgO/UGzkRUvLs7qzJdojvTU1zFfCdMqTfot4k1xOzJf1aGFXOblBavMwAC2Q7gXglVyro341DRnt8zg56k2LiJpXyIPvN/Uwpd+EYG1yMpvFPzSVwHglazqvWpnyqfN9eeuqrbS7Xz72WGwnc6972q7rBUZhyA8/h6E34Pw2wahV8ylGrP9HFwg8Skd0oPeqnKw6v+2WR4EAN3Rgpc0FKj6aEZhJB3S1LncDg8OWC4G7ZZmkOiMtr+L+mYtBGL762jjAxTktxVwGLJ6P4hG1Y/X9QbdL/+68EYWaqbxdcQTDP1ocDg4pGty9KbdYZ2ejfwej7YuY6pFjcJRlWZnsY+OdQNjtV6hX3DSpdIbo+Ygl0z4kPdGXVWuu+wnBDSiw50fpvu8hy8Ijs1rqq1DuavVlFl4Z2RZ4u1wQgGdyoWt2qu+jYq24nc6LrND2/ew7B7S8XwI21vcLL09mtufkdkLZX0m5zNx3Pl0zF44W2dzPhPVHQ7J7PfU+ljOZyL54gMte/FtHK1ZIxzjhRGB194pyO//VuXgB2TXzPVupVq256wR+eNf/9MZd2SGEpuNFBhHkn25qgafJgnkriVmi2+g8Zq68vdXF5hiNhN3J1GHby19EFerMOJCvwdVlg1ih9cIsCz/BETMNAs=
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 service action specification"}
>
</Heading>

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



Read an action specification of a service specification

<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":"serviceSpecificationId","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>