GET
/
cloud
/
v1
/
ddos
/
profiles
/
{project_id}
/
{region_id}
List DDoS protection profiles
curl --request GET \
  --url https://api.gcore.com/cloud/v1/ddos/profiles/{project_id}/{region_id} \
  --header 'Authorization: <api-key>'
{
  "fields": [
    {
      "base_field": 10,
      "default": null,
      "description": "ARK server ports. Valid port values are in range 1000-65535",
      "field_type": null,
      "field_value": [
        45046,
        45047
      ],
      "id": 11,
      "name": "ARK Ports",
      "required": true,
      "validation_schema": {
        "items": {
          "maximum": 65535,
          "minimum": 1000,
          "type": "integer"
        },
        "minItems": 1,
        "type": "array"
      },
      "value": null
    }
  ],
  "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": {
          "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": "",
    "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

Project ID

​
region_id
integer
required

Region ID

Response

List of active profiles

​
id
integer
required

DDoS protection profile ID

Examples:

0

​
ip_address
required

Protected IP address or CIDR.

Examples:

"203.0.113.1"

"203.0.113.0/24"

​
profile_template
object | null
required

Template data

​
fields
ClientProfileFieldSerializer · object[]
Examples:
[
  {
    "base_field": 10,
    "default": null,
    "description": "ARK server ports. Valid port values are in range 1000-65535",
    "field_type": null,
    "field_value": [45046, 45047],
    "id": 11,
    "name": "ARK Ports",
    "required": true,
    "validation_schema": {
      "items": {
        "maximum": 65535,
        "minimum": 1000,
        "type": "integer"
      },
      "minItems": 1,
      "type": "array"
    },
    "value": null
  }
]
​
options
object | null
Examples:
{ "active": true, "bgp": true }
​
profile_template_description
string | null

DDoS profile template description

Examples:

"ARK server ports. Valid port values are in range 1000-65535"

​
protocols
ProtocolsOnPortSerializer · object[] | null

List of protocols

Examples:
[
  {
    "port": "80",
    "protocols": ["TCP", "HTTP"]
  },
  { "port": "53", "protocols": ["UDP"] }
]
​
site
string | null
Maximum length: 50
Examples:

"ED"

​
status
object | null
Examples:
{
  "error_description": "",
  "status": "Updated"
}