Skip to main content
PATCH
/
api
/
buckets
/
{id}
Update a bucket
curl --request PATCH \
  --url http://localhost/api/api/buckets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "active_indicator": true,
  "description": "<string>",
  "rule_id": 123,
  "rule_setting": {},
  "activate_rule": true
}
'
{
  "bucket_rules": [
    {}
  ],
  "rule_id": 123,
  "rule_setting": {},
  "activate_rule": true,
  "last_timestamp": "<string>",
  "modified_by": {
    "id": 123
  },
  "created_by": {
    "id": 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.

Rules are defined as prefixed, situation-based scenario to detect suspicious transactions. Parameters on the other hand are configurable settings inside every rule. Activating / Deactivating a rule in a given Bucket. To activate a given rule, set the field [activate_rule] in the following API call to “True”. Otherwise, to deactivate the rule from screening, set it to “False”. 
{
	"rule_id":1
	"activate_rule":"True"
}

​

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 bucket.

Body

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

​
name
string
Required string length: 1 - 255
​
active_indicator
boolean
​
description
string
​
rule_id
integer
write-only
​
rule_setting
object
write-only
​
activate_rule
boolean
write-only

Response

200 - application/json

Bucket updated successfully.

​
bucket_rules
object[]

List of bucket rules.

​
rule_id
integer

Rule ID.

​
rule_setting
object

Rule settings.

​
activate_rule
boolean

Activate rule.

​
last_timestamp
string

Last timestamp.

​
modified_by
object
​
created_by
object