​

ves-io-schema-infraprotect-CustomAlertAPI-GetAlert

Published April 5, 2023 | Last modified October 28, 2026

Examples of performing infraprotect CustomAlertAPI GetAlert

Usecase:

Get a specific alert

Request:

Request using vesctl:

vesctl request rpc infraprotect.CustomAlertAPI.GetAlert -i request.yaml --uri /public/namespaces/system/infraprotect/alert/12345 --http-method GET

where file request.yaml has following contents:

alertId: "12345"
namespace: system

vesctl yaml response:

misuseTypes:
- bytes: "12345"
  packets: "123"
  type: UDP Flood
- bytes: "67890"
  packets: "456"
  type: TCP SYN Flood
ports:
- name: Dynamic
  number: 443
  protocol: https
- bytes: "1024000"
  name: HTTP
  number: 80
  packets: "2048"
  protocol: tcp
prefixes:
- cidr: 192.168.0.1/32
  destination: true
- cidr: 10.0.0.0/24
  numBytes: "512000"
  numPackets: "1024"
tcpFlags:
- bytes: "1024000"
  flags:
  - ALERT_TCP_FLAG_ACK
  packets: "2048"
- bytes: "512000"
  flags:
  - ALERT_TCP_FLAG_ACK
  - ALERT_TCP_FLAG_PSH
  packets: "1024"
- bytes: "256000"
  flags:
  - ALERT_TCP_FLAG_ACK
  - ALERT_TCP_FLAG_FIN
  packets: "512"
- bytes: "128000"
  flags:
  - ALERT_TCP_FLAG_SYN
  packets: "256"
- bytes: "64000"
  flags:
  - ALERT_TCP_FLAG_SYN
  - ALERT_TCP_FLAG_ACK
  packets: "128"

Request using curl:

curl -X 'GET' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build3348201650_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/infraprotect/namespaces/system/infraprotect/alert/12345?alert_id=12345&namespace=system'

curl response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 28 Sep 2026 04:25:26 GMT
Vary: Accept-Encoding


{
  "ports": [
    {
      "number": 443,
      "protocol": "https",
      "name": "Dynamic",
      "destination": false,
      "bytes": "0",
      "packets": "0"
    },
    {
      "number": 80,
      "protocol": "tcp",
      "name": "HTTP",
      "destination": false,
      "bytes": "1024000",
      "packets": "2048"
    }
  ],
  "prefixes": [
    {
      "cidr": "192.168.0.1/32",
      "destination": true,
      "num_bytes": "0",
      "num_packets": "0"
    },
    {
      "cidr": "10.0.0.0/24",
      "destination": false,
      "num_bytes": "512000",
      "num_packets": "1024"
    }
  ],
  "tcp_flags": [
    {
      "flags": [
        "ALERT_TCP_FLAG_ACK"
      ],
      "bytes": "1024000",
      "packets": "2048"
    },
    {
      "flags": [
        "ALERT_TCP_FLAG_ACK",
        "ALERT_TCP_FLAG_PSH"
      ],
      "bytes": "512000",
      "packets": "1024"
    },
    {
      "flags": [
        "ALERT_TCP_FLAG_ACK",
        "ALERT_TCP_FLAG_FIN"
      ],
      "bytes": "256000",
      "packets": "512"
    },
    {
      "flags": [
        "ALERT_TCP_FLAG_SYN"
      ],
      "bytes": "128000",
      "packets": "256"
    },
    {
      "flags": [
        "ALERT_TCP_FLAG_SYN",
        "ALERT_TCP_FLAG_ACK"
      ],
      "bytes": "64000",
      "packets": "128"
    }
  ],
  "misuse_types": [
    {
      "type": "UDP Flood",
      "bytes": "12345",
      "packets": "123"
    },
    {
      "type": "TCP SYN Flood",
      "bytes": "67890",
      "packets": "456"
    }
  ]
}
On this page: