Skip to main content
GET
/
api
/
whitelist
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "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
        }
      ]
    }
  ]
}

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"