NUnullplatform
Approval

Read an approval

Changed on

Reads an approval.

get/approval/{id}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/approval/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

The ID of the approval.

Response

The operation was successful.

idinteger required

A unique identifier for the approval.

user_idinteger required

The ID of the user who initiated this approval request.

approval_action_idinteger required

The ID of the action that triggered this approval.

entity_idinteger required

The ID of the entity affected by this approval.

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

The entity that requires approval.

entity_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.

original_http_requestobject required

The HTTP request that triggered the approval.

approval_http_requestobject required

The HTTP request that must be executed to approve the action.

denial_http_requestobject required

The HTTP request that must be executed to deny the action.

status'pending' | 'approved' | 'auto_approved' | 'auto_denied' | 'denied' | 'cancelled' | 'expired' required

The current status of the approval request.

execution_status'pending' | 'executing' | 'success' | 'failed' | 'expired' required

The execution state of the approval action.

dimensionsobject required

The set of dimension/values pairs to which this action applies.

Example response

{
  "id": 1234,
  "user_id": 2345,
  "approval_action_id": 3456,
  "entity_id": 4567,
  "entity_name": "deployment",
  "entity_action": "deployment:create",
  "status": "pending",
  "execution_status": "pending",
  "dimensions": {
    "environment": "production",
    "country": "us"
  }
}

Changes

  • 728d4df70ca1Revision 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