Get Security Group

Get Security Group

Get security group with a given id

Request
URI
GET
https://{api_host}/iaas/api/security-groups/{id}
COPY
Path Parameters
string
id
Required

The ID of the security group.

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about

Responses
200

successful operation

Returns SecurityGroup of type(s) application/json 
{
    "owner": "[email protected]",
    "externalRegionId": "ap-northeast-2",
    "description": "my-description",
    "externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
    "orgId": "9e49",
    "egress": [
        {
            "protocol": "TCP, UDP",
            "access": "Allow",
            "ipRangeCidr": "66.170.99.2/32",
            "name": "5756f7e2",
            "ports": "443, 1-655535"
        }
    ],
    "organizationId": "deprecated",
    "createdAt": "2012-09-27",
    "ingress": [
        {
            "protocol": "TCP, UDP",
            "access": "Allow",
            "ipRangeCidr": "66.170.99.2/32",
            "name": "5756f7e2",
            "ports": "443, 1-655535"
        }
    ],
    "cloudAccountIds": [
        "string"
    ],
    "name": "my-name",
    "id": "9e49",
    "updatedAt": "2012-09-27"
}
string
owner
Optional

Email of the user that owns the entity.

object
_links
Required

HATEOAS of the entity

string
externalRegionId
Required

The external regionId of the security group.

string
description
Optional

A human-friendly description.

string
externalId
Optional

External entity Id on the provider side.

string
orgId
Optional

The id of the organization this entity belongs to.

array of Rule
egress
Required

List of egress security rules.

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 6801 and UTC.

array of Rule
ingress
Required

List of ingress security rules.

array of string
cloudAccountIds
Optional

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

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
updatedAt
Optional

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


403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page
Security Group Operations
GET
Get Security Group
GET
Get Security Groups