Skip to content

List policies

Method

GET https://papi.afi.ai/api/v1/tenants/{tenant_id}/policies

Description

Get a list of policies available for the tenant. To list all available policies, use 'limit' and 'page_token' as query parameters.

Path params
tenant_id string required

Tenant to list policies at.
Query params
limit int32

Max number of items to return.
page_token string

Token from the previous list operation (next_page_token) to continue listing.
name string

Optional. Specific policy name to filter the listing by.

 
curl -X GET \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/tenants/{tenant_id}/policies
Successful response (200) schema
object

PoliciesPage is a result of listing policies.
next_page_token string

Next page token to continue listing operation, i.e. to be set as next request page_token. Empty on last page.
items array of objects

Array of policies.

object

Policy describes a policy.
id string

Policy ID.
tenant_id string

Tenant where the policy belongs to.
name string

Policy Name.
Response example
{
  "next_page_token": "string",
  "items": [
    {
      "id": "string",
      "tenant_id": "string",
      "name": "string"
    }
  ]
}