NUnullplatform
Approval

List approvals

Changed on

Lists approvals.

get/approval

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/approval
  • 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_name'deployment' | 'scope' | 'service:action' | 'parameter' | 'action_item'

The entity that requires approval.

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

The action that requires approval.

Example:deployment:create
status'pending' | 'approved' | 'auto_approved' | 'auto_denied' | 'denied' | 'cancelled' | 'expired'

The current status of the approval request.

Example:pending

The status of the approval.

approval_action_idinteger

The ID of the action that triggered this approval.

dimensionsstring

Filter approvals by the dimensions of the request, as comma-separated key:value pairs. Returns the approvals whose dimensions are included in the specified set; approvals that don't specify dimensions always match.

Response

The operation was successful.

Example response

{
  "paging": {
    "limit": 200
  },
  "results": [
    {
      "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

  • 48f4b247ee12Revision changes
    • info

      endpoint added