Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Yandex Virtual Private Cloud
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Cloud network
      • Creating a cloud network
      • Deleting a cloud network
      • Updating a cloud network
    • Subnet
      • Creating a subnet
      • Deleting a subnet
      • Updating a subnet
    • IP address
      • Reserving a static public IP address
      • Making a dynamic public IP address static
      • Making a static public IP address dynamic
      • Deleting a static public IP address
    • Static routes
      • Creating a static route
      • Enabling NAT to the internet
    • Security groups
      • Create a security group
      • Update a security group and rules
      • Delete a security group
    • DDoS Protection
      • Enable protection from DDoS attacks
  • Use cases
    • Architecture and protection of a basic internet service
  • Concepts
    • Relationship between service resources
    • Cloud networks and subnets
    • Cloud resource addresses
    • Static routes
    • Security groups
    • MTU and MSS
    • DHCP settings
    • Quotas and limits
  • DDoS Protection
  • Cloud Interconnect
  • Access management
  • Pricing policy
    • Current policy
    • Archive
      • Policy before January 1, 2019
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • AddressService
      • NetworkService
      • RouteTableService
      • SecurityGroupService
      • SubnetService
      • OperationService
    • REST
      • Overview
      • Address
        • Overview
        • create
        • delete
        • get
        • getByValue
        • list
        • listOperations
        • update
      • Network
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • listSubnets
        • move
        • update
      • RouteTable
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • move
        • update
      • SecurityGroup
        • Overview
      • Subnet
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • move
        • update
      • Operation
        • Overview
        • get
  • Questions and answers
  1. API reference
  2. REST
  3. SecurityGroup
  4. Overview

SecurityGroup

  • JSON Representation
  • Methods

JSON Representation

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "networkId": "string",
  "status": "string",
  "rules": [
    {
      "id": "string",
      "description": "string",
      "labels": "object",
      "direction": "string",
      "ports": {
        "fromPort": "string",
        "toPort": "string"
      },
      "protocolName": "string",
      "protocolNumber": "string",

      // `rules[]` 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`rules[]`

    }
  ],
  "defaultForNetwork": true
}
Field Description
id string
folderId string
createdAt string (date-time)

String in RFC3339 text format.

name string
description string
labels object
networkId string
status string
  • UPDATING: updating is a long operation because we must update all instances in SG
rules[] object
rules[].
id
string
rules[].
description
string
rules[].
labels
object
rules[].
direction
string
Required.
rules[].
ports
object
rules[].
ports.
fromPort
string (int64)

Acceptable values are 0 to 65535, inclusive.

rules[].
ports.
toPort
string (int64)

Acceptable values are 0 to 65535, inclusive.

rules[].
protocolName
string

null value means any protocol values from https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml

rules[].
protocolNumber
string (int64)
rules[].
cidrBlocks
object
rules[] includes only one of the fields cidrBlocks, securityGroupId, predefinedTarget

rules[].
cidrBlocks.
v4CidrBlocks[]
string
rules[].
cidrBlocks.
v6CidrBlocks[]
string
rules[].
securityGroupId
string
rules[] includes only one of the fields cidrBlocks, securityGroupId, predefinedTarget

rules[].
predefinedTarget
string
rules[] includes only one of the fields cidrBlocks, securityGroupId, predefinedTarget

defaultForNetwork boolean (boolean)

Methods

Method Description
In this article:
  • JSON Representation
  • Methods
Language
Careers
Privacy policy
Terms of use
© 2021 Yandex.Cloud LLC