Contact UsGet started

Virtual Private Cloud API, REST: SecurityGroup.Get

Written by
Updated at October 28, 2024

Returns the specified SecurityGroup resource.

To get the list of all available SecurityGroup resources, make a List request.

HTTP request

GET https://vpc.api.cloud.yandex.net/vpc/v1/securityGroups/{securityGroupId}

Path parameters

Field

Description

securityGroupId

string

Required field. ID of the Security Group resource to return.
To get the security group ID, use a [SecurityGroup.List] request.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "string",
  "networkId": "string",
  "status": "string",
  "rules": [
    {
      "id": "string",
      "description": "string",
      "labels": "string",
      "direction": "string",
      "ports": {
        "fromPort": "string",
        "toPort": "string"
      },
      "protocolName": "string",
      "protocolNumber": "string",
      // Includes only one of the fields `cidrBlocks`, `securityGroupId`, `predefinedTarget`
      "cidrBlocks": {
        "v4CidrBlocks": [
          "string"
        ],
        "v6CidrBlocks": [
          "string"
        ]
      },
      "securityGroupId": "string",
      "predefinedTarget": "string"
      // end of the list of possible fields
    }
  ],
  "defaultForNetwork": "boolean"
}

Field

Description

id

string

ID of the security group.

folderId

string

ID of the folder that the security group belongs to.

createdAt

string (date-time)

Creation timestamp in RFC3339 text format.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

name

string

Name of the security group.
The name must be unique within the folder.
Value must match the regular expression \\|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.

description

string

Description of the security group. 0-256 characters long.

labels

string

Resource labels as key:value pairs.
No more than 64 per resource.
The maximum string length in characters for each value is 63.
Each value must match the regular expression [-_./\\@0-9a-z]*.
The string length in characters for each key must be 1-63.
Each key must match the regular expression [a-z][-_./\\@0-9a-z]*.

networkId

string

ID of the network that the security group belongs to.

status

enum (Status)

Security group status.

  • STATUS_UNSPECIFIED
  • CREATING: Security group is being created.
  • ACTIVE: Security is active and it's rules are applied to the network interfaces.
  • UPDATING: Security group is updating. Updating is a long operation because we must update all instances in SG.
  • DELETING: Instance is being deleted.

rules[]

SecurityGroupRule

List of the security group rules.

defaultForNetwork

boolean

Flag that indicates that the security group is the default for the network.

SecurityGroupRule

Field

Description

id

string

ID of the rule.

description

string

Description of the rule. 0-256 characters long.

labels

string

Resource labels as key:value pairs. Maximum of 64 per resource.

direction

enum (Direction)

Required field. The direction of network traffic allowed by this rule.

  • DIRECTION_UNSPECIFIED
  • INGRESS: Allows ingress traffic.
  • EGRESS: Allows egress traffic.

ports

PortRange

The range of ports that allow traffic to pass through. Null value means any.

protocolName

string

Protocol name. Null value means any protocol.
Values from IANA.

protocolNumber

string (int64)

Protocol number from IANA protocol numbers.

cidrBlocks

CidrBlocks

CIDR blocks to allow to recieve or send traffic.

Includes only one of the fields cidrBlocks, securityGroupId, predefinedTarget.

securityGroupId

string

ID of the security group to add rule to.

Includes only one of the fields cidrBlocks, securityGroupId, predefinedTarget.

predefinedTarget

string

Predefined target. See security groups rules for more information.

Includes only one of the fields cidrBlocks, securityGroupId, predefinedTarget.

PortRange

Field

Description

fromPort

string (int64)

The lowest port in the range.

toPort

string (int64)

The highest port in the range.

CidrBlocks

Field

Description

v4CidrBlocks[]

string

IPv4 CIDR blocks to allow traffic to.

v6CidrBlocks[]

string

IPv6 CIDR blocks to allow traffic to.
Previous
Overview
Next
List