UNunkeyed
gateway

List policies

Changed on

Retrieve an environment's gateway policies in evaluation order: the gateway evaluates them top to bottom and the first rejection short-circuits the request.

The full policy list is returned in a single response.

Required Permissions

Your root key must have one of the following permissions:

  • environment.*.read_policies (for any environment)
  • environment.<environment_id>.read_policies (for a specific environment)
post/v2/gateway.listPolicies

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/gateway.listPolicies
  • Auth
    HTTP bearer

Request body

projectstring required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

appstring required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

environmentstring required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Example request

{
  "project": "proj_1234abcd",
  "app": "proj_1234abcd",
  "environment": "proj_1234abcd"
}

Response

Policies retrieved successfully

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": [
    {
      "id": "pol_2gJbXhAr4",
      "name": "Block internal paths",
      "enabled": true,
      "match": [
        {
          "path": {
            "path": {
              "prefix": "/internal/"
            }
          }
        }
      ],
      "firewall": {
        "action": "ACTION_DENY"
      }
    }
  ]
}

Changes

  • 6fee91b79da3Revision changes
    • info

      removed the true enum value from the ///// response property for the response status

    • info

      removed the true enum value from the ///// response property for the response status

  • 2a504dcea6cbRevision changes
    • info

      added the optional property //// to the response with the status