Home
Version 3
Security Groups API

Security Groups API

List all Spaces for the Security Group

GET /v2/security_groups/:guid/spaces

Request

Route

GET /v2/security_groups/bb301b19-9fad-4522-b94c-2e26832f5681/spaces

Parameters

Name Description Valid Values Example Values
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, organization_guid, developer_guid, app_guid
  • 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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5NCIsImVtYWlsIjoiZW1haWwtMjExQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTR9.6_19BGl4qsni2MqHCFSk1JMK8IUcBXu3re6iw_m9Xrw
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/security_groups/bb301b19-9fad-4522-b94c-2e26832f5681/spaces" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5NCIsImVtYWlsIjoiZW1haWwtMjExQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTR9.6_19BGl4qsni2MqHCFSk1JMK8IUcBXu3re6iw_m9Xrw" \
	-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": "1a9f1547-4c4d-4690-806a-2eb0b89a57c2",
        "url": "/v2/spaces/1a9f1547-4c4d-4690-806a-2eb0b89a57c2",
        "created_at": "2015-06-04T00:05:14Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1769",
        "organization_guid": "c0b13035-6b5d-4337-a0a6-0bdf7195c47d",
        "space_quota_definition_guid": null,
        "allow_ssh": true,
        "organization_url": "/v2/organizations/c0b13035-6b5d-4337-a0a6-0bdf7195c47d",
        "developers_url": "/v2/spaces/1a9f1547-4c4d-4690-806a-2eb0b89a57c2/developers",
        "managers_url": "/v2/spaces/1a9f1547-4c4d-4690-806a-2eb0b89a57c2/managers",
        "auditors_url": "/v2/spaces/1a9f1547-4c4d-4690-806a-2eb0b89a57c2/auditors",
        "apps_url": "/v2/spaces/1a9f1547-4c4d-4690-806a-2eb0b89a57c2/apps",
        "routes_url": "/v2/spaces/1a9f1547-4c4d-4690-806a-2eb0b89a57c2/routes",
        "domains_url": "/v2/spaces/1a9f1547-4c4d-4690-806a-2eb0b89a57c2/domains",
        "service_instances_url": "/v2/spaces/1a9f1547-4c4d-4690-806a-2eb0b89a57c2/service_instances",
        "app_events_url": "/v2/spaces/1a9f1547-4c4d-4690-806a-2eb0b89a57c2/app_events",
        "events_url": "/v2/spaces/1a9f1547-4c4d-4690-806a-2eb0b89a57c2/events",
        "security_groups_url": "/v2/spaces/1a9f1547-4c4d-4690-806a-2eb0b89a57c2/security_groups"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 9f83b38e-1280-40d6-8ee6-08b3446140f4
Content-Length: 1485
X-Content-Type-Options: nosniff