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.
|
|
|
|
|
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), description (optional description of the 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",
"description": "This rule allows access to all ips and protocols"
}
]
|
|
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",
"description": "This rule allows access to all ips and protocols"
}
]
}
Headers
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",
"description": "This rule allows access to all ips and protocols"
}
]
}' -X POST \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyIiwiZW1haWwiOiJlbWFpbC0xMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDY2MDA4ODgyfQ.uHks09UfsuMMvSHWeSpsZ02dO-5CNcsBm5S6hCx5mgM" \
-H "Host: example.org" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Cookie: "
Response
Status
201 Created
Body
{
"metadata": {
"guid": "b4bdfa5a-83b0-423d-b979-4b51218d0ca8",
"url": "/v2/security_groups/b4bdfa5a-83b0-423d-b979-4b51218d0ca8",
"created_at": "2016-06-08T16:41:22Z",
"updated_at": "2016-06-08T16:41:26Z"
},
"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",
"description": "This rule allows access to all ips and protocols"
}
],
"running_default": false,
"staging_default": false,
"spaces_url": "/v2/security_groups/b4bdfa5a-83b0-423d-b979-4b51218d0ca8/spaces",
"staging_spaces_url": "/v2/security_groups/b4bdfa5a-83b0-423d-b979-4b51218d0ca8/staging_spaces"
}
}
Headers