Skip to main content
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>'
{
  "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",
      "managed_by": "system",
      "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

Example:

1

​
region_id
integer
required

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

Example:

1

Query Parameters

​
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