​

ves-io-schema-shape-brmalerts-alert_gen_policy-API-Create

Published April 5, 2023 | Last modified March 20, 2025

Examples of creating alert_gen_policy

Usecase:

Create alert configuration

Request using vesctl:

vesctl configuration create alert_gen_policy -i alert_gen_policy.yaml

where file alert_gen_policy.yaml has following contents (alert_gen_policy.CreateRequest):

RequestJSON:

{
    "metadata": {
        "name": "analysis",
        "namespace": "system"
    },
    "spec": {
        "details": {
            "severity": "MAJOR",
            "alert_name": "Traffic Alert",
            "alert_message": "Traffic Alert Message",
            "alert_message_details": "Traffic Alert Message details"
        }
    }
}
Copied!

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "analysis",
        "namespace": "system",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "bbf565c4-1f85-4dfa-8994-b2fa7db4c920",
        "creation_timestamp": "2025-03-11T00:56:45.008447Z",
        "deletion_timestamp": null,
        "modification_timestamp": null,
        "initializers": null,
        "finalizers": [],
        "tenant": "acmecorp",
        "creator_class": "examplesvc",
        "creator_id": "examplesvc",
        "object_index": 0,
        "owner_view": null,
        "labels": {}
    },
    "spec": {
        "alert_status": "ALERT_ACTIVE",
        "details": {
            "severity": "MAJOR",
            "alert_name": "Traffic Alert",
            "alert_message": "Traffic Alert Message",
            "alert_message_details": "Traffic Alert Message details"
        }
    }
}
Copied!

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"analysis","namespace":"system"},"spec":{"details":{"severity":"MAJOR","alert_name":"Traffic Alert","alert_message":"Traffic Alert Message","alert_message_details":"Traffic Alert Message details"}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build436303540_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/shape/alerts/namespaces/system/alert_gen_policys'
Copied!

curl response:

HTTP/1.1 200 OK
Content-Length: 839
Content-Type: application/json
Date: Tue, 11 Mar 2025 00:56:45 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "analysis",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "bbf565c4-1f85-4dfa-8994-b2fa7db4c920",
    "creation_timestamp": "2025-03-11T00:56:45.008447Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null,
    "labels": {
    }
  },
  "spec": {
    "alert_status": "ALERT_ACTIVE",
    "details": {
      "severity": "MAJOR",
      "alert_name": "Traffic Alert",
      "alert_message": "Traffic Alert Message",
      "alert_message_details": "Traffic Alert Message details"
    }
  }
}
Copied!
On this page: