Management API

Overview

The Management REST API provides endpoints to manage monitored addresses. This API allows users to create, retrieve, update, and delete monitored addresses. It is secured using a Management API key, which can be found under Settings > API keys in Panorama.

Authentication

All endpoints require a valid Management API key in the X-Api-Key header.

Endpoints

1. Create Monitored Address

Creates a new monitored address.

URL: /api/v2/management/monitor

Method: POST

Headers: X-Api-Key: <Management API key (string)>

Request Body:

{
  "address": "string",
  "name": "string",
  "chainId": "string",
  "enabled": true
}

Supported chains: CUBE3 Detect Products

Response:

• 200 OK: Returns the created monitored address.

Example request:

curl -X POST "https://management-api.cube3.ai/api/v2/management/monitor" \
     -H "X-Api-Key: your-api-key" \
     -H "Content-Type: application/json" \
     -d '{
           "address": "0x1234567890abcdef",
           "name": "My Monitored Address",
           "chainId": "1",
           "enabled": true
         }'

2. Get All Monitored Addresses

Retrieves a paginated list of all monitored addresses.

URL: /api/v2/management/monitor

Method: GET

Headers: X-Api-Key: <Management API key (string)>

Query Parameters:

• page (optional): Page number (default is 0)

• size (optional): Page size (default is 25)

• address (optional): Filter by address

• name (optional): Filter by name

Response:

• 200 OK: Returns a paginated list of monitored addresses.

{
  "content": [
    {
      "id": "string",
      "address": "string",
      "name": "string",
      "chainId": "string",
      "enabled": true
    }
  ],
  "size": 25,
  "number": 0,
  "totalElements": 1
}

Example Request:

curl -X GET "https://management-api.cube3.ai/api/v2/management/monitor?page=0&size=25" \
     -H "X-Api-Key: your-api-key"

3. Update Monitored Address

Updates an existing monitored address.

URL: /api/v2/management/monitor/{id}

Method: PUT

Path Parameter: id ID of the monitored address to delete (string)

Headers: X-Api-Key: <Management API key (string)>

Request Body:

{
  "name": "string",
  "enabled": true
}

Response:

• 200 OK: Returns the updated monitored address.

Example Request:

curl -X PUT "https://management-api.cube3.ai/api/v2/management/monitor/12345" \
     -H "X-Api-Key: your-api-key" \
     -H "Content-Type: application/json" \
     -d '{
           "name": "Updated Monitored Address",
           "enabled": false
         }'

4. Delete Monitored Address

Deletes an existing monitored address.

URL: /api/v2/management/monitor/{id}

Method: DELETE

Headers: X-Api-Key: <Management API key (string)>

Path Parameter: id ID of the monitored address to delete (string)

Response:

• 200 OK: Indicates the monitored address was successfully deleted.

Example Request:

curl -X DELETE "https://management-api.cube3.ai/api/v2/management/monitor/1234" \
     -H "X-Api-Key: your-api-key"