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)
|
[]
|
|
[
{
"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
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.eyJ1c2VyX2lkIjoidWFhLWlkLTM4OCIsImVtYWlsIjoiZW1haWwtMjU2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQyNjA2NTV9.wg41qHSSPllDC7R4GX6qAPUFxdNit91qg_rPbVVDj2M" \
-H "Host: example.org" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Cookie: "
Response
Status
201 Created
Body
{
"metadata": {
"guid": "6f9df327-1146-4143-995d-ac3034d1743a",
"url": "/v2/security_groups/6f9df327-1146-4143-995d-ac3034d1743a",
"created_at": "2015-09-30T23:30:55Z",
"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/6f9df327-1146-4143-995d-ac3034d1743a/spaces"
}
}
Headers