Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
DDoS Protection

List DDoS protection profiles

This endpoint returns a comprehensive list of all DDoS protection profiles associated with the specified project and region. Each profile contains detailed information about the protection configuration including IP addresses, profile templates, field values, activation status, and current operational state.

get/cloud/v1/ddos/profiles/{project_id}/{region_id}

Path parameters

project_idinteger required

Unique identifier of the cloud project that owns the DDoS protection resources

Example:1

Unique identifier of the cloud project that owns the DDoS protection resources

region_idinteger required

Unique identifier of the cloud region where DDoS protection operations will be performed

Example:1

Unique identifier of the cloud region where DDoS protection operations will be performed

Query parameters

limitinteger

Limit of items on a single page

Example:1000

Limit of items on a single page

managed_byDdosManagedBy[]

Specifies the entity responsible for managing the resource.

  • user: The profile is created and maintained directly by the user.
  • system: The profile is created and maintained automatically by the system.

Specifies the entity responsible for managing the resource.

  • user: The profile is created and maintained directly by the user.
  • system: The profile is created and maintained automatically by the system.
offsetinteger

Offset in results list

Offset in results list

order_by'id.asc' | 'id.desc' | 'ip_address.asc' | 'ip_address.desc' | 'managed_by.asc' | 'managed_by.desc' | 'site.asc' | 'site.desc' | 'status.asc' | 'status.desc'

Sort results by field and direction

Response

OK

countinteger required

Number of objects

Example response

{
  "count": 1,
  "results": [
    {
      "fields": [
        {
          "base_field": 10,
          "description": "ARK server ports. Valid port values are in range 1000-65535",
          "field_value": 45046,
          "id": 11,
          "name": "ARK Ports",
          "required": true,
          "validation_schema": {
            "items": {
              "maximum": 65535,
              "minimum": 1000,
              "type": "integer"
            },
            "minItems": 1,
            "type": "array"
          }
        }
      ],
      "options": {
        "active": true,
        "bgp": true
      },
      "profile_template": {
        "description": "description",
        "fields": [
          {
            "description": "ARK server ports. Valid port values are in range 1000-65535",
            "id": 11,
            "name": "ARK Ports",
            "required": true,
            "validation_schema": {
              "items": {
                "maximum": 65535,
                "minimum": 1000,
                "type": "integer"
              },
              "minItems": 1,
              "type": "array"
            }
          }
        ],
        "id": 123,
        "name": "ICMP port"
      },
      "profile_template_description": "ARK server ports. Valid port values are in range 1000-65535",
      "protocols": [
        {
          "port": "80",
          "protocols": [
            "TCP",
            "HTTP"
          ]
        },
        {
          "port": "53",
          "protocols": [
            "UDP"
          ]
        }
      ],
      "site": "ED",
      "status": {
        "error_description": "An error occured while deleting profile",
        "status": "Error Deleting"
      }
    }
  ]
}