List DDoS protection profiles

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

{
  "count": 1,
  "results": [
    {
      "fields": [
        {
          "base_field": 10,
          "default": null,
          "description": "ARK server ports. Valid port values are in range 1000-65535",
          "field_name": "ARK Ports",
          "field_type": null,
          "field_value": "<unknown>",
          "id": 123,
          "name": "<string>",
          "required": true,
          "validation_schema": "<unknown>",
          "value": null
        }
      ],
      "id": 123,
      "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": 123,
            "name": "<string>",
            "required": true,
            "validation_schema": "<unknown>"
          }
        ],
        "id": 123,
        "name": "<string>"
      },
      "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"
      }
    }
  ]
}

GET

cloud

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>'

{
  "count": 1,
  "results": [
    {
      "fields": [
        {
          "base_field": 10,
          "default": null,
          "description": "ARK server ports. Valid port values are in range 1000-65535",
          "field_name": "ARK Ports",
          "field_type": null,
          "field_value": "<unknown>",
          "id": 123,
          "name": "<string>",
          "required": true,
          "validation_schema": "<unknown>",
          "value": null
        }
      ],
      "id": 123,
      "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": 123,
            "name": "<string>",
            "required": true,
            "validation_schema": "<unknown>"
          }
        ],
        "id": 123,
        "name": "<string>"
      },
      "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

region_id

integer

required

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

Response

200 - application/json

count

integer

required

Number of objects

Required range: x >= 0

results

ClientProfileSerializer · object[]

required

Objects

Show child attributes

results.fields

ClientProfileFieldSerializer · object[]

required

List of configured field values for the protection profile

Show child attributes

results.fields.base_field

integer | null

required

ID of DDoS profile field

Example:

10

results.fields.default

string | null

required

Predefined default value for the field if not specified

Maximum string length: 100

Example:

null

results.fields.description

string | null

required

Detailed description explaining the field's purpose and usage guidelines

Maximum string length: 255

Example:

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

results.fields.field_name

string | null

required

Name of DDoS profile field

Example:

"ARK Ports"

results.fields.field_type

string | null

required

Data type classification of the field (e.g., string, integer, array)

Example:

null

results.fields.field_value

any

required

Complex value. Only one of 'value' or 'field_value' must be specified.

results.fields.id

integer

required

Unique identifier for the DDoS protection field

results.fields.name

string

required

Human-readable name of the protection field

Maximum string length: 30

results.fields.required

boolean | null

required

Indicates whether this field must be provided when creating a protection profile

Example:

true

results.fields.validation_schema

any

required

JSON schema defining validation rules and constraints for the field value

results.fields.value

string | null

required

Basic type value. Only one of 'value' or 'field_value' must be specified.

Example:

null

results.id

integer

required

Unique identifier for the DDoS protection profile

results.ip_address

required

IP address or network range (CIDR) that is protected by this DDoS profile

Example:

"203.0.113.1"

results.options

ProfileOptionsSerializer · object

required

Configuration options controlling profile activation and BGP routing

Show child attributes

results.options.active

boolean

required

Controls whether the DDoS protection profile is enabled and actively protecting the resource

results.options.bgp

boolean

required

Enables Border Gateway Protocol (BGP) routing for DDoS protection traffic

results.profile_template

ClientProfileTemplateSerializer · object

required

Complete template configuration data used for this profile

Show child attributes

results.profile_template.description

string | null

required

Detailed description explaining the template's purpose and use cases

Example:

"description"

results.profile_template.fields

ClientProfileTemplateFieldSerializer · object[]

required

List of configurable fields that define the template's protection parameters

Show child attributes

results.profile_template.fields.default

string | null

required

Predefined default value for the field if not specified

Maximum string length: 100

Example:

null

results.profile_template.fields.description

string | null

required

Detailed description explaining the field's purpose and usage guidelines

Maximum string length: 255

Example:

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

results.profile_template.fields.field_type

string | null

required

Data type classification of the field (e.g., string, integer, array)

Example:

null

results.profile_template.fields.id

integer

required

Unique identifier for the DDoS protection field

results.profile_template.fields.name

string

required

Human-readable name of the protection field

Maximum string length: 30

results.profile_template.fields.required

boolean | null

required

Indicates whether this field must be provided when creating a protection profile

Example:

true

results.profile_template.fields.validation_schema

any

required

JSON schema defining validation rules and constraints for the field value

results.profile_template.id

integer

required

Unique identifier for the DDoS protection template

results.profile_template.name

string

required

Human-readable name of the protection template

Maximum string length: 100

results.profile_template_description

string | null

required

Detailed description of the protection template used for this profile

Example:

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

results.protocols

ProtocolsOnPortSerializer · object[] | null

required

List of network protocols and ports configured for protection

Show child attributes

results.protocols.port

string

required

Network port number for which protocols are configured

results.protocols.protocols

string[]

required

List of network protocols enabled on the specified port

Example:

[
  {
    "port": "80",
    "protocols": ["TCP", "HTTP"]
  },
  { "port": "53", "protocols": ["UDP"] }
]

results.site

string | null

required

Geographic site identifier where the protection is deployed

Maximum string length: 50

Example:

"ED"

results.status

DdosProfileStatusSerializer · object

required

Current operational status and any error information for the profile

Show child attributes

results.status.error_description

string

required

Detailed error message describing any issues with the profile operation

results.status.status

string

required

Current operational status of the DDoS protection profile

Required string length: 3 - 30

Example:

{
  "error_description": "",
  "status": "Updated"
}

List DDoS protection profile templates Create DDoS protection profile

⌘I

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

List DDoS protection profiles

Authorizations

Path Parameters

Response