BLblockaid-official
Monitors

Create Monitor

Changed on

Create a monitor that tracks configured rules and triggers actions when incidents match.

post/v0/platform/monitors/

Request

Request body

namestring required

Display name for the new monitor.

tagsstring[]

Optional tags used to group and filter the monitor.

Example request

{
  "monitors": [
    {
      "params": {
        "limit_usdc": 1000000,
        "critical_usdc": 10000000
      }
    }
  ]
}

Response

idstring required

Unique identifier of the monitor.

is_enabledboolean required

Whether the monitor is enabled.

namestring required

Display name of the monitor.

created_bystring required

Actor that originally created the monitor.

updated_bystring required

Actor that last updated the monitor.

updated_atstring required

Timestamp when the monitor was last updated.

created_atstring required

Timestamp when the monitor was created.

tagsstring[]

Tags attached to the monitor for grouping and filtering.

Example response

{
  "monitors": [
    {
      "params": {
        "limit_usdc": 1000000,
        "critical_usdc": 10000000
      }
    }
  ]
}

Changes

  • 55aaf2f8b1ddRevision changes
    • info

      added the new optional request property ////

    • info

      added the optional property //// to the response with the status

  • 4a801879827eRevision changes
    • breaking

      removed subschema #18: Custom Logic Rules from the / request property oneOf list

    • breaking

      added subschema #18: Code-Based Monitor Rules to the / response property oneOf list for the response status

    • info

      added subschema #18: Code-Based Monitor Rules to the / request property oneOf list

    • info

      removed subschema #18: Custom Logic Rules from the / response property oneOf list for the response status