Security Groups API

Updating a Security Group

PUT /v2/security_groups/:guid

Fields

Name	Description	Example Values
name	The name of the security group.	my_super_sec_group
rules	The egress rules for apps that belong to this security group. A rule consists of a protocol (tcp,icmp,udp,all), destination CIDR or destination range, port or port range (tcp,udp,all), type (control signal for icmp), code (control signal for icmp), log (enables logging for the egress rule)	[ { "protocol": "icmp", "destination": "0.0.0.0/0", "type": 0, "code": 1 }, { "protocol": "tcp", "destination": "0.0.0.0/0", "ports": "2048-3000", "log": true }, { "protocol": "udp", "destination": "0.0.0.0/0", "ports": "53, 5353" }, { "protocol": "all", "destination": "0.0.0.0/0" } ]
space_guids	The list of associated spaces.

Parameters

Name	Description	Valid Values	Example Values
guid	The guid of the Security Group

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMyIsImVtYWlsIjoiZW1haWwtMTU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzV9.w5rEv2XeuANMKJRgghWg9tBGIy0zx2_sHIXsH_rxB_4
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie:

Route

PUT /v2/security_groups/32b8532a-ec24-434a-9ea9-3e5a6db66327

Body

{
  "name": "new_name",
  "rules": [

  ]
}

cURL

curl "https://api.[your-domain.com]/v2/security_groups/32b8532a-ec24-434a-9ea9-3e5a6db66327" -d '{
  "name": "new_name",
  "rules": [

  ]
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMyIsImVtYWlsIjoiZW1haWwtMTU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzV9.w5rEv2XeuANMKJRgghWg9tBGIy0zx2_sHIXsH_rxB_4" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 103e7124-668c-4da3-8f58-2ef0b785c056
Content-Length: 439
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "32b8532a-ec24-434a-9ea9-3e5a6db66327",
    "url": "/v2/security_groups/32b8532a-ec24-434a-9ea9-3e5a6db66327",
    "created_at": "2015-01-27T19:14:28Z",
    "updated_at": "2015-01-27T19:14:35Z"
  },
  "entity": {
    "name": "new_name",
    "rules": [

    ],
    "running_default": false,
    "staging_default": false,
    "spaces_url": "/v2/security_groups/32b8532a-ec24-434a-9ea9-3e5a6db66327/spaces"
  }
}