Control lists API

How to Authenticate the APIs 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 Settings > API keys in Panorama.

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

get

Authorizations

Query parameters

pageableobjectRequired

typestring · enumOptionalAvailable options:

Responses

*/*

objectOptional

get

HTTPcURLJavaScriptPython

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-04-22T11:01:27.396Z",
      "lastUpdatedAt": "2025-04-22T11:01:27.396Z"
    }
  ],
  "size": 1,
  "number": 1,
  "totalPages": 1,
  "totalElements": 1
}

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

get

Authorizations

Query parameters

pageableobjectRequired

typestring · enumOptionalAvailable options:

Responses

*/*

objectOptional

get

HTTPcURLJavaScriptPython

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-04-22T11:01:27.396Z",
      "lastUpdatedAt": "2025-04-22T11:01:27.396Z"
    }
  ],
  "size": 1,
  "number": 1,
  "totalPages": 1,
  "totalElements": 1
}

Create new control list.

post

Authorizations

Body

addressstringRequired

chainIdsstring[]Optional

typestring · enumRequiredAvailable options:

productTypestring · enumRequiredAvailable options:

Responses

*/*

objectOptional

post

HTTPcURLJavaScriptPython

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

*/*

objectOptional

put

HTTPcURLJavaScriptPython

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"
}

Delete control list by id.

delete

Authorizations

Path parameters

controlListIdstringRequired

Responses

*/*

objectOptional

delete

HTTPcURLJavaScriptPython

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"
}