​

ves-io-schema-ip_prefix_set-API-Create

Published April 5, 2023 | Last modified November 14, 2025

Examples of creating ip_prefix_set

Usecase:

Create ddos-black-list list of known ip prefixes that have reputation of geerating ddos attacks

Request using vesctl:

vesctl configuration create ip_prefix_set -i ip_prefix_set.yaml

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

RequestJSON:

{
    "metadata": {
        "name": "ddos-black-list",
        "namespace": "system"
    },
    "spec": {
        "ipv4_prefixes": [
            {
                "ipv4_prefix": "198.252.138.0/24"
            },
            {
                "ipv4_prefix": "167.127.95.0/24"
            },
            {
                "ipv4_prefix": "167.127.191.0/24"
            }
        ]
    }
}
Copied!

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "ddos-black-list",
        "namespace": "system",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "59657e31-dd1a-4453-a9b6-a2b335d4e71c",
        "creation_timestamp": "2025-11-13T23:06:19.234255Z",
        "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": {
        "prefix": [],
        "ipv6_prefix": [],
        "ipv4_prefixes": [
            {
                "ipv4_prefix": "198.252.138.0/24",
                "description": ""
            },
            {
                "ipv4_prefix": "167.127.95.0/24",
                "description": ""
            },
            {
                "ipv4_prefix": "167.127.191.0/24",
                "description": ""
            }
        ],
        "ipv6_prefixes": []
    }
}
Copied!

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"ddos-black-list","namespace":"system"},"spec":{"ipv4_prefixes":[{"ipv4_prefix":"198.252.138.0/24"},{"ipv4_prefix":"167.127.95.0/24"},{"ipv4_prefix":"167.127.191.0/24"}]}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build4194363419_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/ip_prefix_sets'
Copied!

curl response:

HTTP/1.1 200 OK
Content-Length: 978
Content-Type: application/json
Date: Thu, 13 Nov 2025 23:06:19 GMT
Vary: Accept-Encoding
X-Volterra-Response-Fields-Deprecated: spec.ipv6_prefix.#,spec.prefix.#

{
  "metadata": {
    "name": "ddos-black-list",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "59657e31-dd1a-4453-a9b6-a2b335d4e71c",
    "creation_timestamp": "2025-11-13T23:06:19.234255Z",
    "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": {
    "prefix": [
    ],
    "ipv6_prefix": [
    ],
    "ipv4_prefixes": [
      {
        "ipv4_prefix": "198.252.138.0/24",
        "description": ""
      },
      {
        "ipv4_prefix": "167.127.95.0/24",
        "description": ""
      },
      {
        "ipv4_prefix": "167.127.191.0/24",
        "description": ""
      }
    ],
    "ipv6_prefixes": [
    ]
  }
}
Copied!
On this page: