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

Body

Name	Description	Default	Valid Values	Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwMiIsImVtYWlsIjoiZW1haWwtMTU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjYxODc3NDh9.yd0fRY6TVpvLPHXhxku9jkk7lZWEPDaTB_y60zH-J84
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/security_groups" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwMiIsImVtYWlsIjoiZW1haWwtMTU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjYxODc3NDh9.yd0fRY6TVpvLPHXhxku9jkk7lZWEPDaTB_y60zH-J84" \
	-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": "701d7401-cb24-4fd3-a5fc-ee6b659b576b",
        "url": "/v2/security_groups/701d7401-cb24-4fd3-a5fc-ee6b659b576b",
        "created_at": "2015-03-05T19:15:45Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy1",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/701d7401-cb24-4fd3-a5fc-ee6b659b576b/spaces"
      }
    },
    {
      "metadata": {
        "guid": "089ac2c6-855a-41c4-8298-22ae021729cd",
        "url": "/v2/security_groups/089ac2c6-855a-41c4-8298-22ae021729cd",
        "created_at": "2015-03-05T19:15:45Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy2",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/089ac2c6-855a-41c4-8298-22ae021729cd/spaces"
      }
    },
    {
      "metadata": {
        "guid": "e5365e0d-fc9f-4368-afdf-6e8e840747f6",
        "url": "/v2/security_groups/e5365e0d-fc9f-4368-afdf-6e8e840747f6",
        "created_at": "2015-03-05T19:15:47Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-629",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/e5365e0d-fc9f-4368-afdf-6e8e840747f6/spaces"
      }
    },
    {
      "metadata": {
        "guid": "ddd04e4e-20de-4fd9-a895-982cb77fd285",
        "url": "/v2/security_groups/ddd04e4e-20de-4fd9-a895-982cb77fd285",
        "created_at": "2015-03-05T19:15:47Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-630",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/ddd04e4e-20de-4fd9-a895-982cb77fd285/spaces"
      }
    },
    {
      "metadata": {
        "guid": "aa74b3b6-0156-4f71-8672-5487457fb2af",
        "url": "/v2/security_groups/aa74b3b6-0156-4f71-8672-5487457fb2af",
        "created_at": "2015-03-05T19:15:47Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-631",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/aa74b3b6-0156-4f71-8672-5487457fb2af/spaces"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 65573b4d-1771-4a2c-9860-89b743fac657
Content-Length: 2920
X-Content-Type-Options: nosniff