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}

List DDoS protection profiles

cURL

curl --request GET \
  --url https://api.gcore.com/cloud/v1/ddos/profiles/{project_id}/{region_id} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.gcore.com/cloud/v1/ddos/profiles/{project_id}/{region_id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/cloud/v1/ddos/profiles/{project_id}/{region_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/cloud/v1/ddos/profiles/{project_id}/{region_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/cloud/v1/ddos/profiles/{project_id}/{region_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/cloud/v1/ddos/profiles/{project_id}/{region_id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v1/ddos/profiles/{project_id}/{region_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "count": 1,
  "results": [
    {
      "fields": [
        {
          "base_field": 10,
          "default": null,
          "description": "ARK server ports. Valid port values are in range 1000-65535",
          "field_type": null,
          "field_value": "<unknown>",
          "id": 11,
          "name": "ARK Ports",
          "required": true,
          "validation_schema": "<unknown>"
        }
      ],
      "id": 0,
      "ip_address": "203.0.113.1",
      "options": {
        "active": true,
        "bgp": true
      },
      "profile_template": {
        "description": "description",
        "fields": [
          {
            "default": null,
            "description": "ARK server ports. Valid port values are in range 1000-65535",
            "field_type": null,
            "id": 11,
            "name": "ARK Ports",
            "required": true,
            "validation_schema": "<unknown>"
          }
        ],
        "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": "",
        "status": "Updated"
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id · integer · required

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

Example:

1

region_id · integer · required

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

Example:

1

Query Parameters

ip_address · string<ipv4> string<ipv6> string<ipv4network> string<ipv6network>

Filter DDoS profiles by this IP address

Example:

"203.0.113.1"

limit · integer · default: 1000

Limit of items on a single page

Required range: x <= 1000

Example:

1000

managed_by · enum<string>[]

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.

Available options: system, user

Example:

"user"

offset · integer · default: 0

Offset in results list

Required range: x >= 0

Example:

0

order_by · enum<string> · default: id.asc

Sort results by field and direction

Available options: id.asc, id.desc, ip_address.asc, ip_address.desc, managed_by.asc, managed_by.desc, site.asc, site.desc, status.asc, status.desc

Example:

"id.asc"

Response

200 - application/json

OK

count · integer · required

Number of objects

Required range: x >= 0

Example:

1

results · ClientProfileSerializer · object[] · required

Objects

Show child attributes