Skip to main content
GET
/
api
/
whitelist
List all Whitelist records
curl --request GET \
  --url http://localhost/api/api/whitelist \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "results": [
    {
      "count": 123,
      "next": "<string>",
      "previous": "<string>",
      "results": [
        {
          "id": 123,
          "rules": [
            123
          ],
          "bucket": "<string>",
          "subject": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "created_by": 123,
          "modified_by": 123
        }
      ]
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cynopsis.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Query Parameters

​
bucket
string
​
limit
integer

Number of results to return per page.

​
offset
integer

The initial index from which to return the results.

​
rules
string
​
subject
string

Response

200 - application/json

Whitelist records

​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"