Cloud Management API 1.5

SecurityGroups

Security Groups represent network security profiles that contain lists of firewall rules for different ports and source IP addresses, as well as trust relationships amongst different security groups.

Actions

index

Lists Security Groups.

URLs
GET /api/clouds/:cloud_id/security_groups
HTTP response code
200 OK
Content-type
application/vnd.rightscale.security_group;type=collection

Required roles

Parameters

name required type values regexp blank? description
filter no Array * * no See below for valid filter parameters.
view no String default, tiny * no Specifies how many attributes and/or expanded nested relationships to include.

Filters

name partial_match? description
deployment_href no Deployment href to filter on.
name yes Name of the Security Group to filter on.
network_href no Network to filter on.
resource_uid no Resource Unique IDentifier for the Security Group to filter on.

Example Responses

Click on a format below to see an example response for the 'default' view:

JSON XML
[{
  "resource_uid": "RESOURCE_2967653888",
  "name": "NAME_2319211872",
  "description": null,
  "links": [
    {"rel":"self","href":"/api/clouds/888/security_groups/ABC2357816264DEF"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"security_group_rules","href":"/api/clouds/888/security_groups/ABC2357816264DEF/security_group_rules"}
  ],
  "actions": [

  ]
}]
<?xml version="1.0" encoding="UTF-8"?>
<security_groups>
  <security_group>
    <resource_uid>RESOURCE_2967653888</resource_uid>
    <name>NAME_2319211872</name>
    <description/>
    <links>
      <link rel="self" href="/api/clouds/888/security_groups/ABC2357816264DEF"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="security_group_rules" href="/api/clouds/888/security_groups/ABC2357816264DEF/security_group_rules"/>
    </links>
    <actions/>
  </security_group>
</security_groups>

Click on a format below to see an example response for the 'tiny' view:

JSON XML
[{
  "href": "/api/clouds/888/security_groups/ABC2357816264DEF"
}]
<?xml version="1.0" encoding="UTF-8"?>
<security_groups>
  <security_group href="/api/clouds/888/security_groups/ABC2357816264DEF"/>
</security_groups>

show

Displays information about a single Security Group.

URLs
GET /api/clouds/:cloud_id/security_groups/:id
HTTP response code
200 OK
Content-type
application/vnd.rightscale.security_group

Required roles

Parameters

name required type values regexp blank? description
view no String default, tiny * no Specifies how many attributes and/or expanded nested relationships to include.

Example Responses

Click on a format below to see an example response for the 'default' view:

JSON XML
{
  "resource_uid": "RESOURCE_2967653888",
  "name": "NAME_2319211872",
  "description": null,
  "links": [
    {"rel":"self","href":"/api/clouds/888/security_groups/ABC2357816264DEF"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"security_group_rules","href":"/api/clouds/888/security_groups/ABC2357816264DEF/security_group_rules"}
  ],
  "actions": [

  ]
}
<?xml version="1.0" encoding="UTF-8"?>
<security_group>
  <resource_uid>RESOURCE_2967653888</resource_uid>
  <name>NAME_2319211872</name>
  <description/>
  <links>
    <link rel="self" href="/api/clouds/888/security_groups/ABC2357816264DEF"/>
    <link rel="cloud" href="/api/clouds/888"/>
    <link rel="security_group_rules" href="/api/clouds/888/security_groups/ABC2357816264DEF/security_group_rules"/>
  </links>
  <actions/>
</security_group>

Click on a format below to see an example response for the 'tiny' view:

JSON XML
{
  "href": "/api/clouds/888/security_groups/ABC2357816264DEF"
}
<?xml version="1.0" encoding="UTF-8"?>
<security_group href="/api/clouds/888/security_groups/ABC2357816264DEF"/>

create

Create a security group.

URLs
POST /api/clouds/:cloud_id/security_groups
HTTP response code
201 Created

Required roles

Parameters

name required type values regexp blank? description
security_group yes Hash * * no
security_group[deployment_href] no String * * no The href of the Deployment that owns this SecurityGroup.
security_group[description] no String * * no
security_group[name] yes String * * no
security_group[network_href] no String * * no

destroy

Delete security group(s)

URLs
DELETE /api/clouds/:cloud_id/security_groups/:id
HTTP response code
204 No Content

Required roles