CUBE3 Documentation
  • CUBE3 Documentation
  • Detect Products
    • Inspector
    • Monitor
    • Sonar
      • Sonar Feeds
  • Protect Products
    • RASP
      • Quick Start
        • ERC-20 Non-Upgradeable (Foundry)
        • ERC-20 Non-Upgradeable (Hardhat)
        • ERC-20 Upgradeable (Foundry)
        • ERC-20 Upgradeable (Hardhat)
      • RASP Integration
        • 1. Installation
        • 2. Integration
        • 3. Deployment
        • 4. Registration
        • 5. Interaction
        • 6. Inspection
      • CUBE3 Protocol
      • CUBE3 SDK
  • Manage Products
    • Transactions
    • Alerts
      • Email Integration
      • Slack Integration
      • Telegram Integration
      • Discord Integration
      • Webhook Integration
    • Rules
  • API Documentation
    • Inspector API
    • Validation API
      • Troubleshooting
    • Management API
      • Monitor API
      • Alert API
      • Control lists API
    • Authentication
    • API Rate Limits
  • Risk Engine
    • Risk Scoring Introduction
    • Risk Scoring Detailed Overview
  • Settings
    • Billing
    • Organization
    • API Keys
  • Supported Blockchain Networks
    • CUBE3 Detect Products
    • CUBE3 Protect Products
  • Testing Guide
Powered by GitBook
On this page
  1. API Documentation
  2. Management API

Control lists API

PreviousAlert APINextAuthentication

Last updated 4 months ago

The REST API provides endpoints to manage control lists. Control lists allow customers to specify addresses that should be allowed by default (ex: KYC addresses) and blocked addresses that should never be allowed to interact with a customer platform. This API allows users to create, retrieve, update, and delete these lists. It is secured using a Management API key, which can be found under in Panorama.

How to Authenticate the APIs
Settings > API keys

Fetch control list page, optionally sorted and/or filtered by type.

get
Authorizations
Query parameters
typestring · enumOptionalPossible values:
Responses
200
OK
*/*
get
GET /api/v2/management/control-lists HTTP/1.1
Host: validation-api.cube3.ai
X-Api-Key: YOUR_API_KEY
Accept: */*
200

OK

{
  "content": [
    {
      "id": "text",
      "address": "text",
      "chainIds": [
        "text"
      ],
      "type": "ALLOW",
      "productType": "SONAR",
      "createdAt": "2025-05-12T21:24:59.952Z",
      "lastUpdatedAt": "2025-05-12T21:24:59.952Z"
    }
  ],
  "size": 1,
  "number": 1,
  "totalPages": 1,
  "totalElements": 1
}

Fetch control list page, optionally sorted and/or filtered by type.

get
Authorizations
Query parameters
typestring · enumOptionalPossible values:
Responses
200
OK
*/*
get
GET /api/v2/management/control-lists HTTP/1.1
Host: validation-api.cube3.ai
X-Api-Key: YOUR_API_KEY
Accept: */*
200

OK

{
  "content": [
    {
      "id": "text",
      "address": "text",
      "chainIds": [
        "text"
      ],
      "type": "ALLOW",
      "productType": "SONAR",
      "createdAt": "2025-05-12T21:24:59.952Z",
      "lastUpdatedAt": "2025-05-12T21:24:59.952Z"
    }
  ],
  "size": 1,
  "number": 1,
  "totalPages": 1,
  "totalElements": 1
}

Delete control list by id.

delete
Authorizations
Path parameters
controlListIdstringRequired
Responses
200
OK
*/*
delete
DELETE /api/v2/management/control-lists/{controlListId} HTTP/1.1
Host: validation-api.cube3.ai
X-Api-Key: YOUR_API_KEY
Accept: */*
200

OK

{
  "controlListId": "text"
}
  • GETFetch control list page, optionally sorted and/or filtered by type.
  • GETFetch control list page, optionally sorted and/or filtered by type.
  • POSTCreate new control list.
  • PUTUpdate existing control list, found by id, chain id's.
  • DELETEDelete control list by id.

Create new control list.

post
Authorizations
Body
addressstringRequired
chainIdsstring[]Optional
typestring · enumRequiredPossible values:
productTypestring · enumRequiredPossible values:
Responses
200
OK
*/*
post
POST /api/v2/management/control-lists HTTP/1.1
Host: validation-api.cube3.ai
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "address": "text",
  "chainIds": [
    "text"
  ],
  "type": "ALLOW",
  "productType": "SONAR"
}
200

OK

{
  "controlListId": "text"
}

Update existing control list, found by id, chain id's.

put
Authorizations
Path parameters
controlListIdstringRequired
Body
chainIdsstring[]Optional

New chain id's to be replaced in control list.

Responses
200
OK
*/*
put
PUT /api/v2/management/control-lists/{controlListId} HTTP/1.1
Host: validation-api.cube3.ai
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "chainIds": [
    "text"
  ]
}
200

OK

{
  "controlListId": "text"
}