Alert API

How to Authenticate the APIs

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.

Get all alert configurations

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

GEThttps://validation-api.cube3.ai/api/v2/management/alert-configurations

Authorization

ManagementApiKeyAuth

Header parameters

Response

200

OK

Body

*/*

alertsarray of Alert (object)

Request

JavaScriptCurlPython

const response = await fetch('https://validation-api.cube3.ai/api/v2/management/alert-configurations', {
    method: 'GET',
    headers: {
      "X-Api-Key": "text"
    },
});
const data = await response.json();

Response

200

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

Update alert configuration

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

PUThttps://validation-api.cube3.ai/api/v2/management/alert-configurations

Authorization

ManagementApiKeyAuth

Header parameters

Body

application/json

alertId*string

alertType*enum

SONARMONITORRASP

alertName*string

isActive*boolean

destinationIdsarray of string

transactionFilterAlertTransactionFilter (object)

Response

200

OK

Body

*/*

alertIdstring

alertNamestring

alertTypeenum

SONARMONITORRASP

alertSentCounterinteger (int64)

destinationIdsarray of string

transactionFilterAlertTransactionFilter (object)

isActiveboolean

Request

JavaScriptCurlPython

const response = await fetch('https://validation-api.cube3.ai/api/v2/management/alert-configurations', {
    method: 'PUT',
    headers: {
      "X-Api-Key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "alertId": "text",
      "alertName": "text",
      "alertType": "SONAR",
      "isActive": false
    }),
});
const data = await response.json();

Response

200

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

Create new alert configuration

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

POSThttps://validation-api.cube3.ai/api/v2/management/alert-configurations

Authorization

ManagementApiKeyAuth

Header parameters

Body

application/json

alertName*string

alertType*enum

SONARMONITORRASP

destinationIdsarray of string

transactionFilterAlertTransactionFilter (object)

Response

200

OK

Body

*/*

alertIdstring

alertTypeenum

SONARMONITORRASP

alertNamestring

Request

JavaScriptCurlPython

const response = await fetch('https://validation-api.cube3.ai/api/v2/management/alert-configurations', {
    method: 'POST',
    headers: {
      "X-Api-Key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "alertName": "text",
      "alertType": "SONAR"
    }),
});
const data = await response.json();

Response

200

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

Change alert configuration status

Change alert configuration status from active to inactive or vice versa

PUThttps://validation-api.cube3.ai/api/v2/management/alert-configurations/{alertConfigurationId}/status

Authorization

ManagementApiKeyAuth

Path parameters

alertConfigurationId*string

Header parameters

Body

application/json

alertType*enum

SONARMONITORRASP

isActive*boolean

Response

200

OK

Body

*/*

alertIdstring

alertNamestring

alertTypeenum

SONARMONITORRASP

alertSentCounterinteger (int64)

destinationIdsarray of string

transactionFilterAlertTransactionFilter (object)

isActiveboolean

Request

JavaScriptCurlPython

const response = await fetch('https://validation-api.cube3.ai/api/v2/management/alert-configurations/{alertConfigurationId}/status', {
    method: 'PUT',
    headers: {
      "X-Api-Key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "alertType": "SONAR",
      "isActive": false
    }),
});
const data = await response.json();

Response

200

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

Delete alert configuration

Delete alert configuration by provided alert configuration id

DELETEhttps://validation-api.cube3.ai/api/v2/management/alert-configurations/{alertConfigurationId}

Authorization

ManagementApiKeyAuth

Path parameters

alertConfigurationId*string

Header parameters

Response

200

OK

Body

*/*

configurationIdstring

Request

JavaScriptCurlPython

const response = await fetch('https://validation-api.cube3.ai/api/v2/management/alert-configurations/{alertConfigurationId}', {
    method: 'DELETE',
    headers: {
      "X-Api-Key": "text"
    },
});
const data = await response.json();

Response

200

{
  "configurationId": "text"
}

Get alert destinations

Get all alert destinations

GEThttps://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations

Authorization

ManagementApiKeyAuth

Header parameters

Response

200

OK

Body

*/*

idstring

namestring

channelenum

SLACKDISCORDTELEGRAMWEBHOOKEMAIL

webhookUrlstring

stateenum

ACTIVEINACTIVE

attributesAttributes (object)

errorMessagestring

createdAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations', {
    method: 'GET',
    headers: {
      "X-Api-Key": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "name": "text",
    "channel": "SLACK",
    "webhookUrl": "text",
    "state": "ACTIVE",
    "attributes": {
      "chatId": "text",
      "token": "text"
    },
    "errorMessage": "text",
    "createdAt": "2024-12-21T17:48:42.991Z"
  }
]

Create alert destination

Create alert destination for specified product

POSThttps://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations

Authorization

ManagementApiKeyAuth

Header parameters

Body

application/json

name*string

webhookUrlstring

channel*enum

SLACKDISCORDTELEGRAMWEBHOOKEMAIL

stateenum

ACTIVEINACTIVE

attributesDestinationAttributes (object)

Response

200

OK

Body

*/*

idstring

name*string

channel*enum

SLACKDISCORDTELEGRAMWEBHOOKEMAIL

webhookUrlstring

stateenum

ACTIVEINACTIVE

attributesAttributes (object)

activeboolean

errorMessagestring

createdAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations', {
    method: 'POST',
    headers: {
      "X-Api-Key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "channel": "SLACK",
      "name": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "channel": "SLACK",
  "webhookUrl": "text",
  "state": "ACTIVE",
  "attributes": {
    "chatId": "text",
    "token": "text"
  },
  "active": false,
  "errorMessage": "text",
  "createdAt": "2024-12-21T17:48:42.991Z"
}

Update alert destination

Update alert destination for specified channel

PUThttps://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations/{destinationId}

Authorization

ManagementApiKeyAuth

Path parameters

destinationId*string

Header parameters

Body

application/json

name*string

webhookUrlstring

channel*enum

SLACKDISCORDTELEGRAMWEBHOOKEMAIL

stateenum

ACTIVEINACTIVE

attributesDestinationAttributes (object)

Response

200

OK

Body

*/*

idstring

namestring

channelenum

SLACKDISCORDTELEGRAMWEBHOOKEMAIL

webhookUrlstring

stateenum

ACTIVEINACTIVE

attributesAttributes (object)

errorMessagestring

createdAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations/{destinationId}', {
    method: 'PUT',
    headers: {
      "X-Api-Key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "channel": "SLACK",
      "name": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "channel": "SLACK",
  "webhookUrl": "text",
  "state": "ACTIVE",
  "attributes": {
    "chatId": "text",
    "token": "text"
  },
  "errorMessage": "text",
  "createdAt": "2024-12-21T17:48:42.991Z"
}

Test alert destination

Test alert destination with provided destination id

POSThttps://validation-api.cube3.ai/api/v2/management/alert-configurations/integration/{alertIntegrationId}/test

Authorization

ManagementApiKeyAuth

Path parameters

alertIntegrationId*string

Header parameters

Response

200

OK

Body

*/*

webhookUrlstring

stateenum

SENTFAILED

alertChannelenum

SLACKDISCORDTELEGRAMWEBHOOKEMAIL

errorMessagestring

timestampstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://validation-api.cube3.ai/api/v2/management/alert-configurations/integration/{alertIntegrationId}/test', {
    method: 'POST',
    headers: {
      "X-Api-Key": "text"
    },
});
const data = await response.json();

Response

200

{
  "webhookUrl": "text",
  "state": "SENT",
  "alertChannel": "SLACK",
  "errorMessage": "text",
  "timestamp": "2024-12-21T17:48:42.991Z"
}

Delete alert destination

Delete alert destination with specified id

DELETEhttps://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations/{id}

Authorization

ManagementApiKeyAuth

Path parameters

id*string

Header parameters

Response

200

OK

Body

*/*

destinationIdstring

Request

JavaScriptCurlPython

const response = await fetch('https://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations/{id}', {
    method: 'DELETE',
    headers: {
      "X-Api-Key": "text"
    },
});
const data = await response.json();

Response

200

{
  "destinationId": "text"
}