Home
Version 3
Spaces API

Spaces API

List all Security Groups for the Space

GET /v2/spaces/:guid/security_groups

Request

Route

GET /v2/spaces/9834d408-280c-474d-920a-bb8b3a4c1109/security_groups?security_group_guid=fc4820bc-0c8a-48fa-87d6-5fb13583ee63

Parameters

Name Description Valid Values Example Values
guid The guid of the Space
security_group_guid The guid of the security group
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: name
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
page Page of results to fetch
results-per-page Number of results per page
order-direction Order of the results: asc (default) or desc
inline-relations-depth 0 - don't inline any relations and return URLs. Otherwise, inline to depth N.
orphan-relations 0 - de-duplicate object entries in response
exclude-relations comma-delimited list of relations to drop from response
include-relations comma-delimited list of the only relations to include in response 
security_group_guid: fc4820bc-0c8a-48fa-87d6-5fb13583ee63

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyOCIsImVtYWlsIjoiZW1haWwtMTYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDZ9.ryA3b0VbGzrHVXyl9dRbqOjKHJWdDdjdpQi_MF09sQg
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/spaces/9834d408-280c-474d-920a-bb8b3a4c1109/security_groups?security_group_guid=fc4820bc-0c8a-48fa-87d6-5fb13583ee63" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyOCIsImVtYWlsIjoiZW1haWwtMTYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDZ9.ryA3b0VbGzrHVXyl9dRbqOjKHJWdDdjdpQi_MF09sQg" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "aa5874e7-39de-4bba-bca4-e5e327873be2",
        "url": "/v2/security_groups/aa5874e7-39de-4bba-bca4-e5e327873be2",
        "created_at": "2015-08-31T21:50:06Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-838",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/aa5874e7-39de-4bba-bca4-e5e327873be2/spaces"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 16b77c19-9ea4-418e-a08f-d9119520a6aa
Content-Length: 720
X-Content-Type-Options: nosniff