Alert API

The Alerts API enables users to create, update, delete, and test alert configurations, as well as send notifications through various channels. It supports integrations with platforms like Slack, Discord, Telegram, email, and even custom webhooks, allowing organizations to respond swiftly to critical events while maintaining operational efficiency. The API is secured using a Management API key, which can be found under Settings > API keys in Panorama.

PreviousMonitor API NextControl lists API

Last updated 2 months ago

Get all alert configurations

Retrieve all alert configurations. This endpoint returns all alerts with filtering information such as name, channel product and so on.

get

/api/v2/management/alert-configurations

Authorizations

Header parameters

X-Api-Keystringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations' \
  --header 'X-Api-Key: text'

200

{
  "alerts": [
    {
      "alertId": "text",
      "alertName": "text",
      "alertSentCounter": 1,
      "transactionFilter": {
        "validationStatusConfiguration": {
          "alertOnSafe": true,
          "alertOnWarning": true,
          "alertOnUnsafe": true
        },
        "validationEnforcementConfiguration": {
          "alertOnPassed": true,
          "alertOnBlocked": true
        },
        "fromScore": 1,
        "toScore": 1,
        "fromTotalLoss": 1,
        "toTotalLoss": 1,
        "categories": [
          "fraud",
          "cyber",
          "compliance"
        ],
        "subCategories": [
          "maliciousInteraction",
          "mixerMaliciousContractInteraction",
          "reentrancy",
          "financialScamInteraction",
          "rugPullInteraction",
          "impersonationScamInteraction",
          "maliciousProtocolUpgrade",
          "addressPoisoning"
        ],
        "chainIds": [
          1,
          10,
          11155111,
          56,
          137,
          42161,
          43114,
          8453
        ]
      },
      "isActive": true,
      "alertType": "SONAR",
      "destinationIds": [
        "text"
      ]
    }
  ]
}

Update alert configuration

Update specific alert configuration with filters like: score, block chains, total loss amounts and so on.

put

/api/v2/management/alert-configurations

Authorizations

Header parameters

X-Api-Keystringrequired

Body

alertIdstringrequired

alertNamestringrequired

isActivebooleanrequired

transactionFilterobject

alertTypestring · enumrequired

Options: SONAR, MONITOR, RASP

destinationIdsstring[]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations' \
  --header 'X-Api-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{"alertId":"text","alertName":"text","isActive":true,"transactionFilter":{"validationStatusConfiguration":{"alertOnSafe":true,"alertOnWarning":true,"alertOnUnsafe":true},"validationEnforcementConfiguration":{"alertOnPassed":true,"alertOnBlocked":true},"categories":["fraud","cyber","compliance"],"subCategories":["maliciousInteraction","mixerMaliciousContractInteraction","reentrancy","financialScamInteraction","rugPullInteraction","impersonationScamInteraction","maliciousProtocolUpgrade","addressPoisoning"],"chainIds":[1,10,11155111,56,137,42161,43114,8453]},"alertType":"SONAR","destinationIds":[null]}'

200

{
  "alertId": "text",
  "alertName": "text",
  "alertSentCounter": 1,
  "transactionFilter": {
    "validationStatusConfiguration": {
      "alertOnSafe": true,
      "alertOnWarning": true,
      "alertOnUnsafe": true
    },
    "validationEnforcementConfiguration": {
      "alertOnPassed": true,
      "alertOnBlocked": true
    },
    "fromScore": 1,
    "toScore": 1,
    "fromTotalLoss": 1,
    "toTotalLoss": 1,
    "categories": [
      "fraud",
      "cyber",
      "compliance"
    ],
    "subCategories": [
      "maliciousInteraction",
      "mixerMaliciousContractInteraction",
      "reentrancy",
      "financialScamInteraction",
      "rugPullInteraction",
      "impersonationScamInteraction",
      "maliciousProtocolUpgrade",
      "addressPoisoning"
    ],
    "chainIds": [
      1,
      10,
      11155111,
      56,
      137,
      42161,
      43114,
      8453
    ]
  },
  "isActive": true,
  "alertType": "SONAR",
  "destinationIds": [
    "text"
  ]
}

Create new alert configuration

Create new Alert configuration with detailed filters like: score, block chains, total loss amounts and much more.

post

/api/v2/management/alert-configurations

Authorizations

Header parameters

X-Api-Keystringrequired

Body

alertNamestringrequired

transactionFilterobject

alertTypestring · enumrequired

Options: SONAR, MONITOR, RASP

destinationIdsstring[]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations' \
  --header 'X-Api-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{"alertName":"text","transactionFilter":{"validationStatusConfiguration":{"alertOnSafe":true,"alertOnWarning":true,"alertOnUnsafe":true},"validationEnforcementConfiguration":{"alertOnPassed":true,"alertOnBlocked":true},"categories":["fraud","cyber","compliance"],"subCategories":["maliciousInteraction","mixerMaliciousContractInteraction","reentrancy","financialScamInteraction","rugPullInteraction","impersonationScamInteraction","maliciousProtocolUpgrade","addressPoisoning"],"chainIds":[1,10,11155111,56,137,42161,43114,8453]},"alertType":"SONAR","destinationIds":[null]}'

200

{
  "alertId": "text",
  "alertName": "text",
  "alertType": "SONAR"
}

Change alert configuration status

Change alert configuration status from active to inactive or vice versa

put

/api/v2/management/alert-configurations/{alertConfigurationId}/status

Authorizations

Path parameters

alertConfigurationIdstringrequired

Header parameters

X-Api-Keystringrequired

Body

isActivebooleanrequired

alertTypestring · enumrequired

Options: SONAR, MONITOR, RASP

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations/{alertConfigurationId}/status' \
  --header 'X-Api-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{"isActive":true,"alertType":"SONAR"}'

200

{
  "alertId": "text",
  "alertName": "text",
  "alertSentCounter": 1,
  "transactionFilter": {
    "validationStatusConfiguration": {
      "alertOnSafe": true,
      "alertOnWarning": true,
      "alertOnUnsafe": true
    },
    "validationEnforcementConfiguration": {
      "alertOnPassed": true,
      "alertOnBlocked": true
    },
    "fromScore": 1,
    "toScore": 1,
    "fromTotalLoss": 1,
    "toTotalLoss": 1,
    "categories": [
      "fraud",
      "cyber",
      "compliance"
    ],
    "subCategories": [
      "maliciousInteraction",
      "mixerMaliciousContractInteraction",
      "reentrancy",
      "financialScamInteraction",
      "rugPullInteraction",
      "impersonationScamInteraction",
      "maliciousProtocolUpgrade",
      "addressPoisoning"
    ],
    "chainIds": [
      1,
      10,
      11155111,
      56,
      137,
      42161,
      43114,
      8453
    ]
  },
  "isActive": true,
  "alertType": "SONAR",
  "destinationIds": [
    "text"
  ]
}

Delete alert configuration

Delete alert configuration by provided alert configuration id

delete

/api/v2/management/alert-configurations/{alertConfigurationId}

Authorizations

Path parameters

alertConfigurationIdstringrequired

Header parameters

X-Api-Keystringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations/{alertConfigurationId}' \
  --header 'X-Api-Key: text'

200

{
  "configurationId": "text"
}

Get alert destinations

Get all alert destinations

get

/api/v2/management/alert-configurations/destinations

Authorizations

Header parameters

X-Api-Keystringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations' \
  --header 'X-Api-Key: text'

200

[
  {
    "id": "text",
    "name": "text",
    "webhookUrl": "text",
    "attributes": {
      "chatId": "text",
      "token": "text"
    },
    "errorMessage": "text",
    "createdAt": "2025-02-23T05:42:54.850Z",
    "channel": "SLACK",
    "state": "ACTIVE"
  }
]

Create alert destination

Create alert destination for specified product

post

/api/v2/management/alert-configurations/destinations

Authorizations

Header parameters

X-Api-Keystringrequired

Body

namestringrequired

webhookUrlstring

attributesobject

channelstring · enumrequired

Options: SLACK, DISCORD, TELEGRAM, WEBHOOK, EMAIL

statestring · enum

Options: ACTIVE, INACTIVE

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations' \
  --header 'X-Api-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","attributes":{},"channel":"SLACK","state":"ACTIVE"}'

200

{
  "id": "text",
  "name": "text",
  "webhookUrl": "text",
  "attributes": {
    "chatId": "text",
    "token": "text"
  },
  "active": true,
  "errorMessage": "text",
  "createdAt": "2025-02-23T05:42:54.850Z",
  "channel": "SLACK",
  "state": "ACTIVE"
}

Update alert destination

Update alert destination for specified channel

put

/api/v2/management/alert-configurations/destinations/{destinationId}

Authorizations

Path parameters

destinationIdstringrequired

Header parameters

X-Api-Keystringrequired

Body

namestringrequired

webhookUrlstring

attributesobject

channelstring · enumrequired

Options: SLACK, DISCORD, TELEGRAM, WEBHOOK, EMAIL

statestring · enum

Options: ACTIVE, INACTIVE

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations/{destinationId}' \
  --header 'X-Api-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","attributes":{},"channel":"SLACK","state":"ACTIVE"}'

200

{
  "id": "text",
  "name": "text",
  "webhookUrl": "text",
  "attributes": {
    "chatId": "text",
    "token": "text"
  },
  "errorMessage": "text",
  "createdAt": "2025-02-23T05:42:54.850Z",
  "channel": "SLACK",
  "state": "ACTIVE"
}

Test alert destination

Test alert destination with provided destination id

post

/api/v2/management/alert-configurations/integration/{alertIntegrationId}/test

Authorizations

Path parameters

alertIntegrationIdstringrequired

Header parameters

X-Api-Keystringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations/integration/{alertIntegrationId}/test' \
  --header 'X-Api-Key: text'

200

{
  "webhookUrl": "text",
  "errorMessage": "text",
  "timestamp": "2025-02-23T05:42:54.850Z",
  "state": "SENT",
  "alertChannel": "SLACK"
}

Delete alert destination

Delete alert destination with specified id

delete

/api/v2/management/alert-configurations/destinations/{id}

Authorizations

Path parameters

idstringrequired

Header parameters

X-Api-Keystringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations/{id}' \
  --header 'X-Api-Key: text'

200

{
  "destinationId": "text"
}