---
id: approval-required-read
title: "Check if approval is required"
description: "Check if an approval is required for the specified NRN, entity, action, and dimensions."
sidebar_label: "Check if approval is required"
hide_title: true
hide_table_of_contents: true
api: eJztWG1v2zYQ/isHfkoCxXbb5IuADMiKbus+FEXiYh2SIDlTZ4sNRaok5cQ1/N+Ho2RLcl7brSswzB9ki6LunnvuhXdeioy8dKoMyhqRitc5yWtQU0ADWJbOzlGD8uDoc6UcZTC1DkJO4EuSaqoog3cn7xIgE1RYJICSBSWAJoNMFWS8ssYPRCJsSQ754dtMpGIt+3ItOHWEmUhEwJkX6Zk4bjaIi0Tc7ptK61JjmFpXiHQppC0KNNmlwYJEKoZrcSLZPKqRiFQov1EiVonwJCunwkKkZ0sxIXTkjquQi/TsYnWRiBIdFhTI+bhBsYTPFbmFSESjzTgjEuFlTgUymLAoedkHp8yMVWzUpcFVlGxRfNow5yOPjrytnCTYwbLUSmLNn5e2pAQoyMEuhBzD2gN+45YBnJtz8xPs7b2zgdK9PRjnysPUam1vPCDkihw6mSuJGnxwlQyVowQKQqPMLHq5keUBHYGnABgiLDbVlygJNM1JJ4BaQwehjx6OKD3cqJArU8NsX7xRWoMyOTlVy3SVpsE5c0e3WJSaSbNuhkZ9iTKPXqQopa1MOHqZbuQcHaQdvUcHaVR6dChWyf3uqUPxEQ9tO2ScUxO/DzHNkE1VcFxmVGq7KMiEqMGWxN/k5kpS2sRcJ4pEIurFSxWo4GBube+JCiroDvono+h5oO/T9RBvG/Bfw1v90lfxlkpHGGhN3/ato62FG6c6dxlp6tz6YMs7DmhFbvwQy8u+Z9nB952ScgrqOW2tZjTddl/q6BPJ8JAXW7VrZzaUPsuZTzP5iMqHfNqW4OdWrClq/0DJWsQsPmtlXuwMMyv9sF3ZhYWtIMc5gbRmqmaVo2zwp61AogFlpK4ygqLSQZWa4JoW+3PUFUGJyvkEPLHHAmUwWUCs5L5nOZm5ctZE00tns6o+bmLRcIu08oJruCNfWuPJs60vRyP+6ht0QqFyxsNNTiEn99yjrj0cBvGkMYETKl2KToUafvKsYtmhu2X3rP3NZ43jQzGoGmi7a+OgibWa0NzJvCsOoitGb3oHdSy5E7pjgqcO9ASuopOvwLLtN8pTL7xY9ip+EnHw8eNd8l5rRSYAOWcdbLiGrCIIFpSZo1YZKFNWAayDQnnPx803ktdQYScx9ZIemT5gqPxrm3HSRTwiEQV5jzO6S3BndytXmUCzmOh9I38bj99D/QZImzGnpSPPJdfMumEhQXb52KHBbJDAwWjElxd8ecWXg90eyQej0YpJ6GF5oM4eQ4EyV4b2uYjhRFOjK+KKBUNioJl16kvTVXA9JAdTVLpyffeKCWaxISLPZ0FD2zNATJyiaQJ5VaBpkXR2gZ1G5TU4Frdm41z8jBmc1ErPBS98MFiFPELOzkWfnO5uhrj26NMgs0zxT9SQUUDFfc3EVqGF1dczzutcIR/gBj0UqLnDpAwiuyagMpRtQrobwesMObwvQ05r+rczRJksxrmZcdYq7yuCWPIJjt+/Ba8y+o+lhu8S0QTDIafG4eglX171HX/447KCjXUG9WW96bKm7F/Lj7eNemhC5w3vqTPltO5t4IPBOSrNUu8kzL2vf9fUOTZQGbotSfJpXZtkpawcH/jwXhN6guAWgDNUBjQGcuusYVZvw7ox4THrmhYi3Z7zEhF7g78173E7UFDILQ+dMwqxJ+Rpr5Ux3Oyu+8j16Fc5LVKRh1D6dDjEUg266AbSFrHZWM+Tp5yWdTZ1p8oN7yxo3YTFMhw3iaT58Yt1BQaRit//GAtmSJmp5dcZT23Yi8FoMOp0l5sReZWI0vpQYKwPDUftJH9Pb7Pt/mVbdL7jXwANE4Fuw7DUqGJnHGleNl45Ex3Pdlul3PrAj5fLCXr64PRqxct1u8veypTnzHigg+3at3PSyN2F/0fx+31Sp2P9P0eTgyLOGN/E8rNG1UdwbAb6fwbKk4PWI1A2M/I3QvnBg9QjlvUmxda6C75xis2L/5AlIifMyHWq9rGUVIbOW3eall4R/vXNmKfqfnHcKoZRevMITdf1y2W9Y2yvyaxWYg0/8L1YXaxWq78AZNtR3g==
sidebar_class_name: "get api-method"
info_path: docs/api/approval
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={"Check if approval is required"}
>
</Heading>

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



Check if an approval is required for the specified NRN, entity, action, and dimensions.

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

<ParamsDetails
  parameters={[{"in":"query","name":"nrn","schema":{"type":"string"},"required":true,"description":"Specifies the resource (application, scope, etc.) that requires approval. \n\n> **Note:** This follows a hierarchical structure, meaning if approvals are set at the namespace level, all applications and scopes within that namespace will inherit the rule.\n","example":"organization=1:account=2:namespace=4:application=4:scope=5"},{"in":"query","name":"entity","schema":{"type":"string","description":"The entity that requires approval.","enum":["deployment","scope","service:action","parameter","action_item"],"example":"deployment","title":"entity"},"required":true,"description":"The entity that requires approval.","example":"deployment"},{"in":"query","name":"action","schema":{"type":"string","description":"The action that requires approval.","enum":["deployment:create","scope:create","scope:recreate","scope:write","scope:delete","scope:stop","service:action:create","parameter:read-secrets","action_item:resolve","action_item:defer","action_item:reject"],"example":"deployment:create","title":"action"},"required":true,"description":"The action that requires approval.","example":"deployment:create"},{"in":"query","name":"dimensions","schema":{"type":"string"},"required":false,"description":"Specify the [dimensions](/docs/dimensions) you have configured.You can include multiple key-value pairs, separated by commas","example":"environment:production,country:us"}]}
>
  
</ParamsDetails>

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Returns whether approval is required for the specified parameters.","content":{"application/json":{"schema":{"required":["required"],"properties":{"required":{"type":"boolean","description":"`true` when an approval will be required for these parameters, `false` otherwise.","example":true}}}}}},"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>