Home
Version 3
Security Groups API

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.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MiIsImVtYWlsIjoiZW1haWwtMjA5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTR9.uhiN9haB1DAiisfR9SeNwdObgONMhKkgzqDsmED8CsI
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/security_groups" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MiIsImVtYWlsIjoiZW1haWwtMjA5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTR9.uhiN9haB1DAiisfR9SeNwdObgONMhKkgzqDsmED8CsI" \
	-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": "bb301b19-9fad-4522-b94c-2e26832f5681",
        "url": "/v2/security_groups/bb301b19-9fad-4522-b94c-2e26832f5681",
        "created_at": "2015-06-04T00:05:05Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy1",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/bb301b19-9fad-4522-b94c-2e26832f5681/spaces"
      }
    },
    {
      "metadata": {
        "guid": "f0d11aff-4f31-4f6c-95b4-eae56a775c50",
        "url": "/v2/security_groups/f0d11aff-4f31-4f6c-95b4-eae56a775c50",
        "created_at": "2015-06-04T00:05:05Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy2",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/f0d11aff-4f31-4f6c-95b4-eae56a775c50/spaces"
      }
    },
    {
      "metadata": {
        "guid": "31b3aeb8-82c5-47be-b702-96a797fd7504",
        "url": "/v2/security_groups/31b3aeb8-82c5-47be-b702-96a797fd7504",
        "created_at": "2015-06-04T00:05:14Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1760",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/31b3aeb8-82c5-47be-b702-96a797fd7504/spaces"
      }
    },
    {
      "metadata": {
        "guid": "f1902b0d-ae2e-415e-a699-4f8eef270012",
        "url": "/v2/security_groups/f1902b0d-ae2e-415e-a699-4f8eef270012",
        "created_at": "2015-06-04T00:05:14Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1761",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/f1902b0d-ae2e-415e-a699-4f8eef270012/spaces"
      }
    },
    {
      "metadata": {
        "guid": "fffbf3f0-ae38-4732-a8d8-b199027d22b3",
        "url": "/v2/security_groups/fffbf3f0-ae38-4732-a8d8-b199027d22b3",
        "created_at": "2015-06-04T00:05:14Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1762",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/fffbf3f0-ae38-4732-a8d8-b199027d22b3/spaces"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 14c5f79e-bef3-4cfe-9caf-8f62ebe4a1c6
Content-Length: 2923
X-Content-Type-Options: nosniff