Skip to main content
POST
/
cloud
/
v1
/
securitygroups
/
{project_id}
/
{region_id}
/
{group_id}
/
rules
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
)
security_group_rule = client.cloud.security_groups.rules.create(
    group_id="group_id",
    project_id=0,
    region_id=0,
)
print(security_group_rule.id)
{
  "created_at": "2023-11-07T05:31:56Z",
  "direction": "egress",
  "id": "<string>",
  "revision_number": 123,
  "security_group_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "Some description",
  "ethertype": "IPv4",
  "port_range_max": 80,
  "port_range_min": 80,
  "protocol": "tcp",
  "remote_group_id": "<string>",
  "remote_ip_prefix": "10.0.0.0/8"
}

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

​
group_id
string
required

Security group ID

Body

application/json
​
description
string

Rule description

Maximum string length: 255
​
direction
enum<string>

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

Available options:
egress,
ingress
​
ethertype
enum<string>

Ether type

Available options:
IPv4,
IPv6
​
port_range_max
integer | null

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

Required range: 0 <= x <= 65535
Example:

80

​
port_range_min
integer | null

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

Required range: 0 <= x <= 65535
Example:

80

​
protocol
enum<string>

Protocol

Available options:
ah,
any,
dccp,
egp,
esp,
gre,
icmp,
igmp,
ipencap,
ipip,
ipv6-encap,
ipv6-frag,
ipv6-icmp,
ipv6-nonxt,
ipv6-opts,
ipv6-route,
ospf,
pgm,
rsvp,
sctp,
tcp,
udp,
udplite,
vrrp
​
remote_group_id
string<uuid4>

The remote group UUID to associate with this security group

​
remote_ip_prefix
string<ipvanynetwork> | null

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

Example:

"10.0.0.0/8"

Response

200 - application/json

Created rule details

​
created_at
string<date-time>
required

Datetime when the rule was created

​
direction
enum<string>
required

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

Available options:
egress,
ingress
​
id
string<uuid4>
required

The ID of the security group rule

​
revision_number
integer
required

The revision number of the resource

​
security_group_id
string<uuid4>
required

The security group ID to associate with this security group rule

​
updated_at
string<date-time>
required

Datetime when the rule was last updated

​
description
string | null
default:""

Rule description

Example:

"Some description"

​
ethertype
enum<string> | null

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

Available options:
IPv4,
IPv6
Example:

"IPv4"

​
port_range_max
integer | null

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

Required range: 0 <= x <= 65535
Example:

80

​
port_range_min
integer | null

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

Required range: 0 <= x <= 65535
Example:

80

​
protocol
enum<string> | null

Protocol

Available options:
ah,
any,
dccp,
egp,
esp,
gre,
icmp,
igmp,
ipencap,
ipip,
ipv6-encap,
ipv6-frag,
ipv6-icmp,
ipv6-nonxt,
ipv6-opts,
ipv6-route,
ospf,
pgm,
rsvp,
sctp,
tcp,
udp,
udplite,
vrrp
Example:

"tcp"

​
remote_group_id
string<uuid4> | null

The remote group UUID to associate with this security group rule

​
remote_ip_prefix
string<ipvanynetwork> | null

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

Example:

"10.0.0.0/8"