Skip to main content
GET
/
cloud
/
v1
/
ddos
/
profiles
/
{project_id}
/
{region_id}
List active client DDoS protection profiles
curl --request GET \
  --url https://api.gcore.com/cloud/v1/ddos/profiles/{project_id}/{region_id} \
  --header 'Authorization: <api-key>'
{
  "id": 123,
  "ip_address": "203.0.113.1",
  "profile_template": {
    "id": 123,
    "name": "<string>",
    "description": "description",
    "fields": [
      {
        "id": 123,
        "name": "<string>",
        "default": "<string>",
        "description": "description",
        "field_type": "int",
        "required": "false",
        "validation_schema": "<unknown>"
      }
    ]
  },
  "fields": [
    {
      "default": "<unknown>",
      "description": "<string>",
      "field_value": "<unknown>",
      "id": 123,
      "name": "<string>",
      "base_field": 123,
      "field_name": "<string>",
      "field_type": "<string>",
      "required": true,
      "validation_schema": "<unknown>",
      "value": "<string>"
    }
  ],
  "options": {
    "active": true,
    "bgp": true
  },
  "profile_template_description": "ARK server ports. Valid port values are in range 1000-65535",
  "protocols": [
    {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "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

Example:

0

​
ip_address
required

Protected IP address or CIDR.

Example:

"203.0.113.1"

​
profile_template
ClientProfileTemplateSerializer · object
required

Template data

​
fields
ClientProfileFieldSerializer · object[]
Example:
[
  {
    "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
ProfileOptionsSerializer · object
Example:
{ "active": true, "bgp": true }
​
profile_template_description
string | null

DDoS profile template description

Example:

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

​
protocols
ProtocolsOnPortSerializer · object[] | null

List of protocols

Example:
[
  {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
]
​
site
string | null
Maximum string length: 50
Example:

"ED"

​
status
DdosProfileStatusSerializer · object
Example:
{
  "error_description": "",
  "status": "Updated"
}