Skip to main content
POST
/
api
/
buckets
Create a bucket
curl --request POST \
  --url http://localhost/api/api/buckets \
  --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.

A bucket can be described in simple terms as a group of transactions to fit a set of screening metrics. Often, this is done to segment transactions conducted by different customer groups, depending on different business needs. By default, all transactions uploaded into Athena will be registered into the Bucket named “Ordinary”. Please note that the name and description of this bucket cannot be modified nor deleted. To create your own bucket, perform the following API call. Take note that Bucket names must be unique.

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Body

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

​
name
string
required
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

201 - application/json

Bucket created 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