Documentation | Firewalls › Security Groups

Firewalls

firewalls

Firewalls

Security Groups

firewalls.security_groups

Methods

Add New Rule To Security Group -> { id, created_at, direction, 10 more... }

post/v1/securitygroups/{project_id}/{region_id}/{pk}/rules

Add new rule to security group

Create A Deep Copy Of Security Group ->

post/v1/securitygroups/{project_id}/{region_id}/{pk}/copy

Create a deep copy of security group

Create Security Group ->

SecurityGroup

post/v1/securitygroups/{project_id}/{region_id}

Create security group

Delete Security Group ->

delete/v1/securitygroups/{project_id}/{region_id}/{pk}

Delete security group

Get Security Groups -> OffsetPage<

SecurityGroup

get/v1/securitygroups/{project_id}/{region_id}

Get security groups

Parameters

project_id: number

region_id: number

limit: number

Optional

Limit the number of returned limit request entities.

metadata_k: string

Optional

Filter by metadata keys. Must be a valid JSON string. curl -G --data-urlencode "metadata_k=["value", "sense"]" --url "http://localhost:1111/v1/securitygroups/1/1"

metadata_kv: string

Optional

Filter by metadata key-value pairs. Must be a valid JSON string. curl -G --data-urlencode "metadata_kv={"key": "value"}" --url "http://localhost:1111/v1/securitygroups/1/1"

offset: number

Optional

Offset value is used to exclude the first set of records from the result.

Response fields

count: number

(minimum: 0)

Number of objects

results: Array<

SecurityGroup

Objects

Request example

curl https://api.gcore.com/cloud/v1/securitygroups/$PROJECT_ID/$REGION_ID \
    -H "APIKey: $CLOUD_API_API_KEY"

200Example

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

Get Security Group ->

SecurityGroup

get/v1/securitygroups/{project_id}/{region_id}/{pk}

Get security group

Revert Security Group ->

SecurityGroup

post/v1/securitygroups/{project_id}/{region_id}/{pk}/revert

Revert security group

Change Security Group ->

SecurityGroup

patch/v1/securitygroups/{project_id}/{region_id}/{pk}

Change security group

Domain types

SecurityGroup = { id, created_at, name, 9 more... }

Firewalls Security Groups

Instances

firewalls.security_groups.instances

Methods

Filter Instances By Security Group -> { count, results }

get/v1/securitygroups/{project_id}/{region_id}/{secgroup_id}/instances

Retrieve the instances list (filter by security group)

Firewalls Security Groups

Metadata

firewalls.security_groups.metadata

Methods

Create Or Update Security Group Metadata ->

post/v1/securitygroups/{project_id}/{region_id}/{security_group_id}/metadata

Create or update one or more metadata items for a security group. If an item does not exist, it gets created. If an item already exists, it's value is overwritten

List Security Group Metadata -> { count, results }

get/v1/securitygroups/{project_id}/{region_id}/{security_group_id}/metadata

Lists all metadata for a security group

Replace Security Group Metadata ->

put/v1/securitygroups/{project_id}/{region_id}/{security_group_id}/metadata

All existing metadata is deleted and replaced with the metadata from the request.

Firewalls Security Groups

Metadata Item

firewalls.security_groups.metadata_item

Methods

Delete Security Group Metadata Item By Key ->

delete/v1/securitygroups/{project_id}/{region_id}/{pk}/metadata_item

Delete security group metadata item by key

Get Security Group Metadata Item By Key -> { key, read_only, value }

get/v1/securitygroups/{project_id}/{region_id}/{pk}/metadata_item

Get network metadata item by key

Firewalls Security Groups

Rules

firewalls.security_groups.rules

Methods

Delete Security Group Rule ->

delete/v1/securitygrouprules/{project_id}/{region_id}/{pk}

Delete security group rule

Change Security Group Rule -> { id, created_at, direction, 10 more... }

put/v1/securitygrouprules/{project_id}/{region_id}/{pk}

Edit the security group rule: delete old and create new rule