Home
Version 3
Security Groups API

Security Groups API

Updating a Security Group

PUT /v2/security_groups/:guid

Fields

Name Description Default Valid Values 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.eyJ1c2VyX2lkIjoidWFhLWlkLTY1IiwiZW1haWwiOiJlbWFpbC01OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk5fQ.PPRceu5fZq3TrjdRNifqOyMrEq_gdPcyF3Vwj3jmZP0
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

Route

PUT /v2/security_groups/3a35e0ac-8f4b-4988-8355-9a2eb4566dd7

Body

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

  ]
}

cURL

curl "https://api.[your-domain.com]/v2/security_groups/3a35e0ac-8f4b-4988-8355-9a2eb4566dd7" -d '{
  "name": "new_name",
  "rules": [

  ]
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY1IiwiZW1haWwiOiJlbWFpbC01OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk5fQ.PPRceu5fZq3TrjdRNifqOyMrEq_gdPcyF3Vwj3jmZP0" \
	-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: f15d406d-66af-4fcf-bcfa-d2b5ee420121
Content-Length: 449
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "3a35e0ac-8f4b-4988-8355-9a2eb4566dd7",
    "url": "/v2/security_groups/3a35e0ac-8f4b-4988-8355-9a2eb4566dd7",
    "created_at": "2014-11-13T23:38:13+00:00",
    "updated_at": "2014-11-13T23:38:19+00:00"
  },
  "entity": {
    "name": "new_name",
    "rules": [

    ],
    "running_default": false,
    "staging_default": false,
    "spaces_url": "/v2/security_groups/3a35e0ac-8f4b-4988-8355-9a2eb4566dd7/spaces"
  }
}