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.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MSIsImVtYWlsIjoiZW1haWwtMjI0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NTF9.zXssrSOj26UMBw9Eaf6T6JeMK0niZUmP_-YMQJoPe9s
Host: example.org
Cookie: 

Route

GET /v2/spaces/6f40a4f1-d634-4347-be27-1dc71056ffcd/security_groups

cURL

curl "https://api.[your-domain.com]/v2/spaces/6f40a4f1-d634-4347-be27-1dc71056ffcd/security_groups" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MSIsImVtYWlsIjoiZW1haWwtMjI0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NTF9.zXssrSOj26UMBw9Eaf6T6JeMK0niZUmP_-YMQJoPe9s" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c1b70a64-009f-4821-a424-bb0ef23f41ce
Content-Length: 726
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "b9651eb6-cbd7-426c-96e1-f43bd6ce73ad",
        "url": "/v2/security_groups/b9651eb6-cbd7-426c-96e1-f43bd6ce73ad",
        "created_at": "2015-01-20T01:52:31+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-1857",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/b9651eb6-cbd7-426c-96e1-f43bd6ce73ad/spaces"
      }
    }
  ]
}