Home
Version 3
Spaces API

Spaces API

List all Security Groups for the Space

GET /v2/spaces/:guid/security_groups

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
guid The guid of the Space
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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyNyIsImVtYWlsIjoiZW1haWwtMjQ4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4ODR9.QtR8OrHLTqXiszXAWTsWzrNWAlF9eS8Hn5OtEcrg20A
Host: example.org
Cookie: 

Route

GET /v2/spaces/27cc4b6d-4b21-41c2-817a-04eb2d5ef704/security_groups

cURL

curl "https://api.[your-domain.com]/v2/spaces/27cc4b6d-4b21-41c2-817a-04eb2d5ef704/security_groups" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyNyIsImVtYWlsIjoiZW1haWwtMjQ4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4ODR9.QtR8OrHLTqXiszXAWTsWzrNWAlF9eS8Hn5OtEcrg20A" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: be5bdc42-b6d3-4196-b3b5-37a20a7d21da
Content-Length: 721
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "b80b2cad-fe7e-4b50-8f4f-dd6b7c785845",
        "url": "/v2/security_groups/b80b2cad-fe7e-4b50-8f4f-dd6b7c785845",
        "created_at": "2015-01-27T19:14:44Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1927",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/b80b2cad-fe7e-4b50-8f4f-dd6b7c785845/spaces"
      }
    }
  ]
}