Get security group

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 = client.cloud.security_groups.get(
    group_id="group_id",
    project_id=0,
    region_id=0,
)
print(security_group.id)

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "project_id": 123,
  "region": "<string>",
  "region_id": 123,
  "revision_number": 123,
  "tags_v2": [
    {
      "key": "<string>",
      "read_only": true,
      "value": "<string>"
    }
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "Some description",
  "security_group_rules": [
    {
      "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"
    }
  ]
}

GET

cloud

securitygroups

{project_id}

{region_id}

{group_id}

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 = client.cloud.security_groups.get(
    group_id="group_id",
    project_id=0,
    region_id=0,
)
print(security_group.id)

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "project_id": 123,
  "region": "<string>",
  "region_id": 123,
  "revision_number": 123,
  "tags_v2": [
    {
      "key": "<string>",
      "read_only": true,
      "value": "<string>"
    }
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "Some description",
  "security_group_rules": [
    {
      "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

Response

200 - application/json

Security group details

created_at

string<date-time>

required

Datetime when the security group was created

string<uuid4>

required

Security group ID

name

string

required

Security group name

project_id

integer

required

Project ID

region

string

required

Region name

region_id

integer

required

Region ID

revision_number

integer

required

The number of revisions

tags_v2

TagSerializer · object[]

required

List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.

Show child attributes

tags_v2.key

string

required

Tag key. The maximum size for a key is 255 characters.

tags_v2.read_only

boolean

required

If true, the tag is read-only and cannot be modified by the user

tags_v2.value

string

required

Tag value. The maximum size for a value is 255 characters.

updated_at

string<date-time>

required

Datetime when the security group was last updated

description

string | null

Security group description

Example:

"Some description"

security_group_rules

SecurityGroupRuleSerializer · object[]

Security group rules

Show child attributes

security_group_rules.created_at

string<date-time>

required

Datetime when the rule was created

security_group_rules.direction

enum<string>

required

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

Available options:

egress,

ingress

security_group_rules.id

string<uuid4>

required

The ID of the security group rule

security_group_rules.revision_number

integer

required

The revision number of the resource

security_group_rules.security_group_id

string<uuid4>

required

The security group ID to associate with this security group rule

security_group_rules.updated_at

string<date-time>

required

Datetime when the rule was last updated

security_group_rules.description

string | null

default:""

Rule description

Example:

"Some description"

security_group_rules.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"

security_group_rules.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

security_group_rules.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

security_group_rules.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"

security_group_rules.remote_group_id

string<uuid4> | null

The remote group UUID to associate with this security group rule

security_group_rules.remote_ip_prefix

string<ipvanynetwork> | null

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

Example:

"10.0.0.0/8"

Create security group Delete security group

⌘I

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

Authorizations

Path Parameters

Response