List security groups

List all security groups in the specified project and region.

GET /cloud/v1/securitygroups/{project_id}/{region_id}

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
page = client.cloud.security_groups.list(
    project_id=1,
    region_id=1,
)
page = page.results[0]
print(page.id)

200

{
  "count": 1,
  "results": [
    {
      "created_at": "2019-06-18T11:56:16+0000",
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "my_security_group",
      "project_id": 1337,
      "region": "Luxembourg 1",
      "region_id": 7,
      "revision_number": 1,
      "tags_v2": [
        {
          "key": "my-tag",
          "read_only": false,
          "value": "my-tag-value"
        }
      ],
      "updated_at": "2019-06-18T11:57:00+0000",
      "description": "Some description",
      "security_group_rules": [
        {
          "created_at": "2019-06-18T11:56:16+0000",
          "description": "Some description",
          "ethertype": "IPv4",
          "id": "00000000-0000-4000-8000-000000000000",
          "port_range_max": 80,
          "port_range_min": 80,
          "protocol": "tcp",
          "remote_group_id": [
            "00000000-0000-4000-8000-000000000000"
          ],
          "remote_ip_prefix": "10.0.0.0/8",
          "revision_number": 0,
          "security_group_id": "00000000-0000-4000-8000-000000000000",
          "updated_at": "2019-06-18T11:57:00+0000"
        }
      ]
    }
  ]
}

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

Example:

1

region_id · integer · required

Region ID

Example:

1

Query Parameters

limit · integer · default: 10

Limit of items on a single page

Required range: x <= 1000

Example:

10

name · string

Optional. Filter by name. Must be specified a full name of the security group.

Example:

"my_security_group"

offset · integer · default: 0

Offset in results list

Required range: x >= 0

Example:

0

tag_key · string[]

Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

Required string length: 1 - 255

Pattern: ^[^\s=]+$

Example:

["key1", "key2"]

tag_key_value · string

Optional. Filter by tag key-value pairs.

Example:

{ "key": "value" }

Response

200 - application/json

OK

count · integer · required

Number of objects

Required range: x >= 0

Example:

1

results · SecurityGroupSerializer · object[] · required

Objects

Show child attributes