Home
Version 3
Security Groups API

Security Groups API

Creating a Security Group

POST /v2/security_groups/

Request

Route

POST /v2/security_groups

Body

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). This field is limited to 16MB. []
  • [
      {
        "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. []
{
  "name": "my_super_sec_group",
  "rules": [
    {
      "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"
    }
  ]
}

Headers

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

cURL

curl "https://api.[your-domain.com]/v2/security_groups" -d '{
  "name": "my_super_sec_group",
  "rules": [
    {
      "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"
    }
  ]
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzOSIsImVtYWlsIjoiZW1haWwtMjQxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2NDF9.XFbwZH4fuVd4DphbtoyS3zzZKdcNVhzERI3Eb1RatH4" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "c901bc2a-006f-4f18-89c0-3464434c93af",
    "url": "/v2/security_groups/c901bc2a-006f-4f18-89c0-3464434c93af",
    "created_at": "2016-04-16T01:24:01Z",
    "updated_at": null
  },
  "entity": {
    "name": "my_super_sec_group",
    "rules": [
      {
        "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"
      }
    ],
    "running_default": false,
    "staging_default": false,
    "spaces_url": "/v2/security_groups/c901bc2a-006f-4f18-89c0-3464434c93af/spaces"
  }
}

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/security_groups/c901bc2a-006f-4f18-89c0-3464434c93af
X-VCAP-Request-ID: ea3b6c0e-9d15-465f-9919-ac039cb09bf4
Content-Length: 864
X-Content-Type-Options: nosniff