Skip to main content
PATCH
/
api
/
whitelist
/
{id}
Update a Whitelist record
curl --request PATCH \
  --url http://localhost/api/api/whitelist/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rules": [
    123
  ],
  "bucket": "<string>",
  "subject": "<string>"
}
'
{
  "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
}

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

Path Parameters

​
id
integer
required

A unique integer value identifying this whitelist.

Body

application/json

Whitelist modification request payload

​
rules
integer[]

List of rule IDs

​
bucket
string

Bucket identifier

​
subject
string

Subject identifier

Response

Whitelist record updated successfully

Whitelist object with all details

​
id
integer
required

Whitelist record ID

​
rules
integer[]

List of rule IDs

​
bucket
string

Bucket identifier

​
subject
string

Subject identifier

​
created_at
string<date-time>

Creation timestamp

​
updated_at
string<date-time>

Last update timestamp

​
created_by
integer

ID of user who created the record

​
modified_by
integer

ID of user who last modified the record