SecurityGroup

SecurityGroup
SecurityGroup

State object representing a security group.
HATEOAS links:
cloud-accounts - array[CloudAccount] - List of cloud accounts where this security group exists.
self - SecurityGroup - Self link to this security group

JSON Example
{
    "owner": "[email protected]",
    "externalZoneId": "us-east-1a",
    "externalRegionId": "us-east-1",
    "description": "my-description",
    "externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
    "rules": [
        {
            "protocol": "ANY, TCP, UDP",
            "access": "Allow",
            "service": "HTTPS, SSH",
            "ipRangeCidr": "66.170.99.2/32",
            "name": "5756f7e2",
            "ports": "443, 1-655535",
            "direction": "Outbound"
        }
    ],
    "orgId": "9e49",
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "organizationId": "deprecated",
    "createdAt": "2012-09-27",
    "cloudAccountIds": [
        "string"
    ],
    "deploymentId": "123e4567-e89b-12d3-a456-426655440000",
    "name": "my-name",
    "id": "9e49",
    "projectId": "9e49",
    "updatedAt": "2012-09-27"
}
string
owner
Optional

Email of the user that owns the entity.

object
_links
Required

HATEOAS of the entity

string
externalZoneId
Required

The external zoneId of the resource.

string
externalRegionId
Required

The external regionId of the resource.

string
description
Optional

A human-friendly description.

string
externalId
Optional

External entity Id on the provider side.

array of Rule
rules
Required

List of security rules.

string
orgId
Optional

The id of the organization this entity belongs to.

array of Tag
tags
Optional

A set of tag keys and optional values that were set on this resource.

string
organizationId
Optional

This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 and UTC.

array of string
cloudAccountIds
Optional

Set of ids of the cloud accounts this resource belongs to.

object
customProperties
Optional

Additional properties that may be used to extend the base resource.

string
deploymentId
Optional

Deployment id that is associated with this resource.

string
name
Optional

A human-friendly name used as an identifier in APIs that support this option.

string
id
Required

The id of this resource instance

string
projectId
Optional

The id of the project this resource belongs to.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

Property Of
Returned By