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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQxOSIsImVtYWlsIjoiZW1haWwtMjg4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2ODl9.DXh3Mq4Bp0D4SJH-MKbc2p4bTdUyigz3H8Ct-tsKQZU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/security_groups" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQxOSIsImVtYWlsIjoiZW1haWwtMjg4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2ODl9.DXh3Mq4Bp0D4SJH-MKbc2p4bTdUyigz3H8Ct-tsKQZU" \
	-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": "875fa37e-4512-4e3b-ac35-1c842c925069",
        "url": "/v2/security_groups/875fa37e-4512-4e3b-ac35-1c842c925069",
        "created_at": "2016-03-17T21:41:20Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy1",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/875fa37e-4512-4e3b-ac35-1c842c925069/spaces"
      }
    },
    {
      "metadata": {
        "guid": "e8e65aa9-59ce-4134-9e3a-69a0749e3481",
        "url": "/v2/security_groups/e8e65aa9-59ce-4134-9e3a-69a0749e3481",
        "created_at": "2016-03-17T21:41:20Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy2",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/e8e65aa9-59ce-4134-9e3a-69a0749e3481/spaces"
      }
    },
    {
      "metadata": {
        "guid": "92a12ef2-fb51-482f-9089-f653abd5bda2",
        "url": "/v2/security_groups/92a12ef2-fb51-482f-9089-f653abd5bda2",
        "created_at": "2016-03-17T21:41:29Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2353",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/92a12ef2-fb51-482f-9089-f653abd5bda2/spaces"
      }
    },
    {
      "metadata": {
        "guid": "29cb3b82-9083-4d36-986e-358a7ca50ac2",
        "url": "/v2/security_groups/29cb3b82-9083-4d36-986e-358a7ca50ac2",
        "created_at": "2016-03-17T21:41:29Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2354",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/29cb3b82-9083-4d36-986e-358a7ca50ac2/spaces"
      }
    },
    {
      "metadata": {
        "guid": "1db02978-07e5-4ead-a1c1-802fc73f9782",
        "url": "/v2/security_groups/1db02978-07e5-4ead-a1c1-802fc73f9782",
        "created_at": "2016-03-17T21:41:29Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2355",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/1db02978-07e5-4ead-a1c1-802fc73f9782/spaces"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 2923
X-Content-Type-Options: nosniff