---
id: entity-hook-action-read
title: "Read an entity hook action"
description: "Read an entity hook action."
sidebar_label: "Read an entity hook action"
hide_title: true
hide_table_of_contents: true
api: eJzdWP9u20YSfpXBokCTgJblREpbAingS9PWLZAGiYMWsAxhxR2J25C7zP6wwwr8r//f61xf517gXqGYXVIkLdV2i/QOOP8hS8vZ3W++mW92uFsm0GZGVk5qxVL2GrkArgCVk66GXOt3wDN6OGEJc3xjWXrBXvRP2WXCdIWGk82ZYCmLU5f0cBmnpga5YAmruOElOjS0yJZJ2rDiLmcJU7xEljJJZjbLseQs3TJXVzRqnZFqwxK21qbkjqXMeylYkzCD7700KFjqjMfkhjPnOcLZV6DX4HI84BI4DQILdEjO4QdeVgXtN59P8fPZdHqEj79YHc1OxOyIf3by9Gg2e/p0Pp/NptPplDWXCbOYeSNdHdxZITdoTr3LWXpxSY8N2kori5Z8eTyd0r99hAdwXXMLa+2VIFyZVg6Vo8m8qgqZBaqPf7a0wnafLb36GTPHhuRcRGKVUeRn2I8lLG7GEqbVstKFzOql9VmG1o7G1lwWLGHXOZJt2IQeU+ArQ6F3Mnooxd0xOxQir+R7jyAFIVtLNAci9lcCFB0+AGkM4RQMWu1NNoLw4OXrlw/BVpjJdS3VBq5zNAgul7aLUogG2jE0bTZcyV9CjJ6dpDzLtFfu2eOUMtxWPMNnT9JBHJ/NCGgbkzuxEl1kQQy17PD1GjOHAlZ1RHdYuqh8SYkw2DpITYdwCqwKXZeUZlGLASmFuPcs2ja7vLkX2EigzDrOau3hmitH0lshKB3oFsBX2rshzh5RmhnkbowyvTby5lBUcudUPyv+7CbEXzvbAR39jOFgN284tpu9Y6qf2w91M/uRdt4+q930JmFClqis1MoekvSY4O+xPrrihUeouDQWBK6lolwl8YSFOyUN8qDbectQXUmjVYh6SloWvqsIIWlNTaq1rGkOlYgD4e9iV3LleUF+7idEX3lXCI6/QwX080YdbDeZLNRCfQmPHr3UDtNHj+C5NwaVK+oEtCpqWLR7LRhIC9ZXlTYOxWShRqJsATV7Ze2jOjF0gFb3BicLRi4AfFQnQim+BfoK19qEpF07NPsuvImiREtFzeVoAv8Bt84ybyzEFUAbCEuA8kVRFdxRMf/UglQOjeIFFHojs5tA2+2b9rC4BWjXQNxZ5IbF7O6cIOs7yAw7h3y4Dd9O1b4SXQnqJPxHlLoB+i5Pcu7AGbnZoLE7rsfnRl8BQn62R2oLjBvD64P1tTNuDyNBOdmLqeXq37/+9p9//RPO1qD0YIbB2GQkcI1g0HmjQutXVnSs0JaRNemwPFiNbjn+KUM2aA4ctvun/VrHBIzCHNEyf/rZ53/TOd7t9zGP8djF3udcJMuuOB/wmz03deU0fK/VBl51CdGEZlBId7/j4RS+e/PDS4hPx4dDvwx4JdDAdS6zPPYPt9CyjcfVhDpLtA7FkoidlFhqUy+lWm5WZPRJ4ZClsyb+JcxJF5yKSfltkF54MPvpp/2e+HkhUTlAY7SBXQsNwiMlt1RXvJACpKq8owJVSmvJrf7l4qM1zdZx5+1zLUj5AQ9LWInW8g3ut78D67t18O35+SuIMyDTgvRXGbTEUHd+d51TNuTjAU42kwRm0yl9nNDHE/qYPRwFajadhmQR90jHUyh5lkuFR/SaxlcFtnsFXKF2ZdzhRhv5S1vfLJorEm57yI2rPxfLNj9CZxtouweIlZG4TiD3JVc9koHV7q0ggAsltmVjwf7BBbyOmy4YDbxV3Ls8QBYLNiZnaE0Qu4jeDVJE0fACBDouCxv71h7WeB8SektFeKUreUEHKAoI7CrHpUKxS+lhBnfSmR9SyJtI/02FSCVCnqsNlXFprceutzp9dQZWCvw/k4YdEtEmw5ykMZ8+po8n48DP/3eq6DqmZTRaRsr+a/o46xq2NnVekE1UCo3IDOGt4ldcFrTqnmAOTv9bpXOqwCv8UMVX2+hS6E0Nigm8KpBbBGdq4BsuFRTcoelUE3C5XNNl1AZDo0KXTCk7HlxNHcfe7HgrRUOvhcGxeC/lTUEdonOVTY+PeSUnw/Z3kulydPnzhgQT83x4BbRjhBbqbrVie0xGLGm/fN3dj3z343l41ZJqrWk64YnknUymkynrz9Hh9VtoGK0reRBve432x7d4NwOz7cvBXXd/0RuHH9xxVXCpaOtA1bbl92J49Te8X0qloJqQa+vIartdcYtvTdE0NPzeI71pXlwm7IobSQkYwiCkpe+CpWte2JuXe0PgD163lekh/Lkrv4M+dT23oo47vF6zlLGEvcM63lA2l03CcuQCTQAaH5xmGVZuMGWvuFLS7BLzmxfnRNE4VW6kRlj9IJztNlqc63eommaHztFvAtg0vwOQwY5p
sidebar_class_name: "get api-method"
info_path: docs/api/entity-hook
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 entity hook action"}
>
</Heading>

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



Read an entity hook action.

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

<ParamsDetails
  parameters={[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true,"description":"The ID of the entity hook action to delete.","example":"550e8400-e29b-41d4-a716-446655440000"}]}
>
  
</ParamsDetails>

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The entity hook action was found.","content":{"application/json":{"schema":{"type":"object","required":["id","nrn","entity","action","on_policy_success","on_policy_fail","when","type","on"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the entity hook.","example":"550e8400-e29b-41d4-a716-446655440000"},"nrn":{"type":"string","description":"A resource identifier (NRN) specifying where this action applies.","example":"organization=1:account=2:namespace=3:application=4"},"entity":{"type":"string","description":"The type of entity affected by this entity hook action.","enum":["application","scope","deployment","namespace"],"example":"scope"},"action":{"type":"string","description":"The specific action you want to be notified about.","enum":["deployment:create","deployment:write","deployment:delete","scope:create","scope:write","scope:delete","application:create","application:write","application:delete","namespace:create","namespace:write","namespace:delete"],"example":"scope:create"},"dimensions":{"type":"object","description":"Key-value pairs defining the scope of the action.","example":{"environment":"production","country":"us"}},"on_policy_success":{"type":"string","enum":["manual"],"description":"The action to be taken on the entity hook success.\n\n> **Note:** Currently, only \"manual\" is supported.\n","example":"manual"},"on_policy_fail":{"type":"string","enum":["manual"],"description":"The action to be taken on entity hook failure.\"\n\n  > **Note:** Currently, only \"manual\" is supported.\n","example":"manual"},"when":{"type":"string","enum":["before","after"],"description":"Specifies whether the hook occurs before or after nullplatform's internal logic.\n","example":"before"},"type":{"type":"string","enum":["hook"],"description":"The type of entity hook action.\n\n> **Note:** Currently, only \"hook\" is supported.\n","example":"hook"},"on":{"type":"string","enum":["create","update","delete"],"description":"Specifies the type of action that triggers the hook.","example":"create"},"policies":{"type":"array","description":"The policies applied to the entity.\n\n> ℹ️ If no policies are found, we return an empty array.\n","items":{"type":"object","properties":{"id":{"type":"integer","description":"A unique identifier for the policy.","example":5678},"nrn":{"type":"string","description":"A resource identifier (NRN) specifying where the policy applies.","example":"organization=1:account=2:namespace=3:application=4"},"name":{"type":"string","description":"The name of the policy.","example":"Crypto Kong Policies"},"conditions":{"type":"object","description":"A JSON object defining the conditions under which this policy applies.","example":{"scope.requested_spec.memory_in_gb":{"$lte":4}}}}}}},"title":"entityHook"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>