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.eyJ1c2VyX2lkIjoidWFhLWlkLTEzIiwiZW1haWwiOiJlbWFpbC0xM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDY2MDA4ODgyfQ.S1E3Ur6mdcyvWCJ5aloTD8Gik2x8zZrsPAGZgV3rt_8
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/security_groups" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzIiwiZW1haWwiOiJlbWFpbC0xM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDY2MDA4ODgyfQ.S1E3Ur6mdcyvWCJ5aloTD8Gik2x8zZrsPAGZgV3rt_8" \
	-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": "1452e164-0c3e-4a6c-b3c3-c40ad9fd0159",
        "url": "/v2/security_groups/1452e164-0c3e-4a6c-b3c3-c40ad9fd0159",
        "created_at": "2016-06-08T16:41:21Z",
        "updated_at": "2016-06-08T16:41:26Z"
      },
      "entity": {
        "name": "dummy1",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/1452e164-0c3e-4a6c-b3c3-c40ad9fd0159/spaces",
        "staging_spaces_url": "/v2/security_groups/1452e164-0c3e-4a6c-b3c3-c40ad9fd0159/staging_spaces"
      }
    },
    {
      "metadata": {
        "guid": "61a3df25-f372-4554-9b77-811aaa5374c1",
        "url": "/v2/security_groups/61a3df25-f372-4554-9b77-811aaa5374c1",
        "created_at": "2016-06-08T16:41:21Z",
        "updated_at": "2016-06-08T16:41:26Z"
      },
      "entity": {
        "name": "dummy2",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/61a3df25-f372-4554-9b77-811aaa5374c1/spaces",
        "staging_spaces_url": "/v2/security_groups/61a3df25-f372-4554-9b77-811aaa5374c1/staging_spaces"
      }
    },
    {
      "metadata": {
        "guid": "26bdad19-b077-4542-aac0-f7e4c53c344d",
        "url": "/v2/security_groups/26bdad19-b077-4542-aac0-f7e4c53c344d",
        "created_at": "2016-06-08T16:41:22Z",
        "updated_at": "2016-06-08T16:41:26Z"
      },
      "entity": {
        "name": "name-67",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/26bdad19-b077-4542-aac0-f7e4c53c344d/spaces",
        "staging_spaces_url": "/v2/security_groups/26bdad19-b077-4542-aac0-f7e4c53c344d/staging_spaces"
      }
    },
    {
      "metadata": {
        "guid": "0a2b8908-66f5-4bef-80f3-ca21ed86fbb3",
        "url": "/v2/security_groups/0a2b8908-66f5-4bef-80f3-ca21ed86fbb3",
        "created_at": "2016-06-08T16:41:22Z",
        "updated_at": "2016-06-08T16:41:26Z"
      },
      "entity": {
        "name": "name-68",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/0a2b8908-66f5-4bef-80f3-ca21ed86fbb3/spaces",
        "staging_spaces_url": "/v2/security_groups/0a2b8908-66f5-4bef-80f3-ca21ed86fbb3/staging_spaces"
      }
    },
    {
      "metadata": {
        "guid": "f5b93b76-cd25-4fed-bed6-0d9d0acff542",
        "url": "/v2/security_groups/f5b93b76-cd25-4fed-bed6-0d9d0acff542",
        "created_at": "2016-06-08T16:41:22Z",
        "updated_at": "2016-06-08T16:41:26Z"
      },
      "entity": {
        "name": "name-69",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/f5b93b76-cd25-4fed-bed6-0d9d0acff542/spaces",
        "staging_spaces_url": "/v2/security_groups/f5b93b76-cd25-4fed-bed6-0d9d0acff542/staging_spaces"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: dc41a5ad-5993-4030-bdfe-f054b351873f
Content-Length: 2917
X-Content-Type-Options: nosniff