Security Groups API

List all Security Groups

GET /v2/security_groups

Request

Route

GET /v2/security_groups

Parameters

Name	Description	Valid Values	Example Values
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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NCIsImVtYWlsIjoiZW1haWwtMjc0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzg2NDE4MTN9.w8eV3PAu1UIQwjX5uYS3sR2KNO5rNx2fsLLn7tamFLE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/security_groups" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NCIsImVtYWlsIjoiZW1haWwtMjc0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzg2NDE4MTN9.w8eV3PAu1UIQwjX5uYS3sR2KNO5rNx2fsLLn7tamFLE" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 5,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "fc70a601-c15a-4c20-925e-aa9a2c37a216",
        "url": "/v2/security_groups/fc70a601-c15a-4c20-925e-aa9a2c37a216",
        "created_at": "2015-07-27T22:43:31Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy1",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/fc70a601-c15a-4c20-925e-aa9a2c37a216/spaces"
      }
    },
    {
      "metadata": {
        "guid": "ac7fc341-0102-4003-9fee-d8714e7198f8",
        "url": "/v2/security_groups/ac7fc341-0102-4003-9fee-d8714e7198f8",
        "created_at": "2015-07-27T22:43:31Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy2",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/ac7fc341-0102-4003-9fee-d8714e7198f8/spaces"
      }
    },
    {
      "metadata": {
        "guid": "d62f0c60-cda7-40fa-9dd9-c7f21c94224b",
        "url": "/v2/security_groups/d62f0c60-cda7-40fa-9dd9-c7f21c94224b",
        "created_at": "2015-07-27T22:43:33Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2292",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/d62f0c60-cda7-40fa-9dd9-c7f21c94224b/spaces"
      }
    },
    {
      "metadata": {
        "guid": "56f3cf44-3b87-46bb-8c73-2249e70ee552",
        "url": "/v2/security_groups/56f3cf44-3b87-46bb-8c73-2249e70ee552",
        "created_at": "2015-07-27T22:43:33Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2293",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/56f3cf44-3b87-46bb-8c73-2249e70ee552/spaces"
      }
    },
    {
      "metadata": {
        "guid": "9da71e46-efe2-4c7a-b157-5c68967226ee",
        "url": "/v2/security_groups/9da71e46-efe2-4c7a-b157-5c68967226ee",
        "created_at": "2015-07-27T22:43:33Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2294",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/9da71e46-efe2-4c7a-b157-5c68967226ee/spaces"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 19a23e40-5347-4ab5-a755-e6cd0a509dfa
Content-Length: 2923
X-Content-Type-Options: nosniff