Approval

Check if approval is required

Changed on

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

get/approval/required

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/approval/required
  • Auth
    HTTP bearer

Query parameters

nrnstring required

Specifies the resource (application, scope, etc.) that requires approval.

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.

entity'deployment' | 'scope' | 'service:action' | 'parameter' | 'action_item' required

The entity that requires approval.

Example:deployment
action'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' required

The action that requires approval.

Example:deployment:create
dimensionsstring

Specify the dimensions you have configured.You can include multiple key-value pairs, separated by commas

Response

Returns whether approval is required for the specified parameters.

requiredboolean required

true when an approval will be required for these parameters, false otherwise.

Example response

{
  "required": true
}

Changes

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property message deprecated

    • info

      response property message deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status