---
id: action-specification-list
title: "List action specifications"
description: "List action specifications."
sidebar_label: "List action specifications"
hide_title: true
hide_table_of_contents: true
api: eJztWm1v2zgS/isEscC2XdtN26TXGCgWQV/usuilQZPeLS7xGbQ0trilSJWknLqG//thSMqmLNlO0vS6d0i+xJbo4cOZ4cwzQ86pKkAzy5U8TmmfsgQ/Dk0BCR/zxL3oC24s7VDLJob2L+iRG0MHHZqCSTQv3Nc+fceNJV4AqQkwPdqhBdMsBwsaZcypSTLIGe3PKZOz92P3zHIrgPbpcYqzzQr8bKzmckI7dKx0zizt07Lk+L4+90fJP5dAeArS8jEHTcZKE5sBwQd2RjQUGgxICylhhjDy8ePxa7rozBsTFcxa0Cj03w9+7V/sdQ9Zd3zUfTuYv1h046/7N/n65Omic3lpHj18dIcSf6KLwaJDOYL9XIKe0Q6VLMflOB1p+FxyDSntj5kwgKtd6b3S9smHkxZ1R1pQesIk/+pM+RIRPBr88qDPkkSV0lYPHv76oI9Tm4IlED9kRSGCH8SPTaKKaNxPDYuelEIUglm0O/kARpU6AXLCciAPTj6cPFxZlMsJYSTjoJlOMp4wse4HMpalgyxDN6hOarlTd2vayrl8B3JiM9p/skGq4Dm3TbnNTZRza5znyjIfgSZqjJBLYQ3RYEstISUFaFKwCdBvhqXGYwPXwHXmNzR4aP5XTrcFm3DJnBFsplU5ySq4a+D+JPscfeH/eN8b0FOeQD2CD9uiwfVVy4xRCWeo0iC+Ht/vDf0DDC24/PS9rIyy7038w01c7eXr2PUsbEyeris0nUmW84SwNOU4mAlSaGR9lsN9jP5hW/c6Rn2H+/DOLNquWy4tTEBvRhsRuGuBPlqNvzn2QYcaSErN7cyBHgHToI9KpDAXA3ytwRRKGjC4uqe//47/6gDej/6AxNb5YcVSlCSrQsQBSpS0WgnhCcySdTGZEqXTGv+iHYqjQVqn2dU6H/9hcOY2du2LpbM4lr4L5ZTXv3Jo0bdXaujPqQM8iUjdhnGeVvYb5nTkj+dlTvtPbsUxkR0HcrhV+t5NmSKkK4K4iL3pYsmRw7wD99oPXWFgWjN0T24hN7sVxNPYHP/NcBY20HZa3qFSOQ2DRG1e4PbEda8VQ1j2qHE0a4/8vTSWjIAwIpXsQl7YGfFTOOeVyhL4XDJBrCJh01MjysndIDoT5aRCVGMKPXJUWpUzi4WYmJEJSGwwQErGWuXk0mnlkiKaRAO+GDLbhmlplZRZLHRoWaQ3Ge4HNAeGZYXZaSXX2V2A++DqyKl7J1efk9JYleM4ziZSGWi2QM5nxdJOvhPSI2eZKkWKllIS1lQGKZkyUYIhXLrnPlw4MYgztGZwOXH/JAov1mo+Kh3q7fugUSUux6UwZqVApTatHFt2ubBqTuJlxq44ZYKn5Lez9yfkzE+46FC/xBtO/Q+vl4iVXnGb1QGEmd2kzAJhE8alsZhRpjzFciVgWIsz4fES2WCprBnuNBN5f9vYtXwnhLrCmjxIIK4Ngute5bjTyBStSbMtZzEZqdotnoUFuQ0eaSZAWwuX9y5y7yItLrKxQ3DP/++a/99pi2VDxX9vtT+F1VpbJlSD1TM2EjERGSklgMk4tLXu92OZoiQw5CoDm4GOWAVJmMRoivKRRHAfdjGyMYldAEcoGBkzLtClLLPQq1iEECD417uBlJfC8kKspjY+BXCzhhS+QFKiorivwBBEj7yXYkZCITUSgFTVsyyCyIII45AzKZX1x0m17LZ8vDO96VKaoZqC3sYKUyiEmuVY43WoO6TAUiMsrhnZ3/i94dCiaHKV8SSLLeVWFyJvpq6GvlDcUcs0YFVICtBuGyOYDs2ZxEOAToy6AfFUMPQIWT8FucpAQ4zzigvhEnSwwwiI1XwyAe1rwdLtgmMP1OoSFneRvpY29dnrE8y6LlORgnFt6ul/0aHwBQMJE7EHvKmeNe2PK/a7DwGv+4Nf+O5yaC2Xe3VZRQzIFP87JU5A+ioXj5fEFFdXgSUps47kqNIWpR1uo1nxTBFFwmmWFGY1X9ULqVgN3WmTmOKE9a/jajjQKyXHfFL6UmTTGl1j5It1ayVTzkJ3IfI4BxnVABJtkg6vMmjV/tLktKGSV0r6xRGbMUvyQCrz0GGI3NkqoksXg3nSbuQ4K12w7tej7r/2uofD7uCXfv1r2+nkcYJbu414hqrvrUu2ffIzTt81YPvuw5Rp7vT4c4+8iUt2jHwCmO5FGtoQodsjMo+rTkwAQQhJoQCZ4hxKkpruow01dCYt1zbEBsc8s8yWZtmPWHeBlSiMMjKGVUuQ5Iphu4mlzULETdDuGzGQD6uZVGkTlQOmFCyy+8SUSQLGdIhUwyRjUoLoeB8cgtZKd4jlOajSdggrbVY9rNhxKdmUcRc9OoRLt/mG1X5zmsPxuyH+rcyZ7OIqXWB1vyIpWMaF145fKxoMOzYBteseKbtO9LZPdfy6Mkn8UwxTthameuTUh2DnEA6QB4EtO0XGLOGCI2MgKYzKietDNsojb6HBolGUtcb5tkshdEeo2tJBxcT4heWF51WhT53PukjCumZtZFDasntTb6RsDsZ1l8xnQ6/2YVXENQ2y6OAw31JtG+bfxBFub12vLdMM4vJ4Ua/x/wfRby4/6ZNn+wf7++x5l+29OOzuPxux7mF68LR7MHoOz2F/zF6kT+jGOoiOn8GLERzudfcOD5529w/2nndH6cF+N9mHvxywA7b/7PAZrXHywApiTuwf1VMU7QXQvZTnII3jpCCnXCuJnIu8fEkuaQpTEKrAB5eYudYIa8Q+l2xuSQjbCd5ggX91FYdzgZUXNNL19zv+8Gj2285cfLoL5CCa2IUXQ9LSJbmj02OCRwg6EPvbHKi8cXF3ZyvLxadXKoV2D66F6PPz0yoMJypFruySaqUSH+mxX10XtyEMh3LRB1Ynz2tlDBqwNkPVYsqeKB0uVd0gnZxlStsOydqyii9CdCV85nY0GIMlwk7Br11KgjTICr8LbTIXw1cHdiHR02bwv7UbNHOLs12ll9VCBt4JD+6d8N4Jf6wTuoXZTGHqmbgrdAXDipE+brtES33mq66/llrQPs2sLUz/8WNW8F5cK/USldfOwl0V6J0qPhFf6hMFuX4FDsNywQ2infDhbdX5++2f505hXI4V/hzxeKU96e319uiKddWuXx6dHrvmkTI2ZzLiXJuv/K7bdr7aZDsuCocloXEfF4Jx55lOX/Og4YvWa8qYCTNlLL6fz0fMwEctFgt87G80oN5TbkJpFVjmJ5hVt2UdTcGqE3uYGwb6u6HbR25Z943udm5QhQdSHZXfEsptrnNuxbO8R3pLQN/QGt+Ka8t9yO+JtKUdvMOc7bf5bmveW94Gu5YqvwXYrW407dbct0D6lvtKW5E1Lk6tAA7wi+a+CrnAGikDlmJtcDEPvz5KEijiDdVgJihlmYH++uYca456WlhLA/E1MCZnkez53I84V59ALha0WoLF73g1bLH4D3LTYqY=
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={"List action specifications"}
>
</Heading>

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



List action specifications.

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

<ParamsDetails
  parameters={[{"schema":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"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}$"}]},"in":"query","name":"id","required":false},{"schema":{"title":"NRN","type":"string","pattern":"^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$","description":"Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources"},"in":"query","name":"nrn","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"limit","required":false,"description":"Limits the number of results returned per page"},{"schema":{"type":"string","minLength":1},"in":"query","name":"offset","required":false,"description":"Specifies the offset for paginating through results"},{"schema":{"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}$"}]},"in":"query","name":"service_specification_id","required":false,"description":"Unique identifier for the associated service specification"},{"schema":{"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}$"}]},"in":"query","name":"link_specification_id","required":false,"description":"Unique identifier for the associated link specification"},{"schema":{"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}$"}]},"in":"query","name":"service_id","required":false,"description":"Service id identifier for dynamic additional properties"},{"schema":{"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}$"}]},"in":"query","name":"link_id","required":false,"description":"Link id identifier for dynamic additional properties"},{"schema":{"anyOf":[{"type":"null"},{"type":"integer"}]},"in":"query","name":"application_id","required":false,"description":"Application id identifier for dynamic additional properties"}]}
>
  
</ParamsDetails>

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Object representing pagination parameters for controlling the number and order of results","content":{"application/json":{"schema":{"title":"ActionSpecificationList","type":"object","properties":{"paging":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"description":"Limits the number of results returned"},"offset":{"type":"integer","minimum":0,"description":"Specifies the offset for paginated results"}},"required":["limit","offset"]},"results":{"type":"array","items":{"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"]}}}}},"required":["paging","results"],"description":"Object representing pagination parameters for controlling the number and order of results"}}}},"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>


      