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