Documentation | Firewalls › Security Groups › Add New Rule To Security Group

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

Parameters

project_id: number

region_id: number

pk: string

Response fields

id: string

(format: uuid4)

The ID of the security group rule

created_at: string

(format: date-time)

Datetime when the rule was created

direction: "egress" | "ingress"

Ingress or egress, which is the direction in which the security group rule is applied

revision_number: number

The revision number of the resource

security_group_id: string

(format: uuid4)

The security group ID to associate with this security group rule

updated_at: string

(format: date-time)

Datetime when the rule was last updated

description: string

Optional

Rule description

ethertype: "IPv4" | "IPv6"

Optional

Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules.

port_range_max: number

Optional

(maximum: 65535, minimum: 0)

The maximum port number in the range that is matched by the security group rule

port_range_min: number

Optional

(maximum: 65535, minimum: 0)

The minimum port number in the range that is matched by the security group rule

protocol: "ah" | "any" | "dccp" | 21 more...

Optional

Protocol

remote_group_id: string

Optional

(format: uuid4)

The remote group UUID to associate with this security group rule

remote_ip_prefix: string

Optional

(format: ipvanynetwork)

The remote IP prefix that is matched by this security group rule

Request example

curl https://api.gcore.com/cloud/v1/securitygroups/$PROJECT_ID/$REGION_ID/$PK/rules \
    -H 'Content-Type: application/json' \
    -H "APIKey: $CLOUD_API_API_KEY"

200Example

{
  "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"
}

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

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