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.eyJ1c2VyX2lkIjoidWFhLWlkLTI3MyIsImVtYWlsIjoiZW1haWwtMjA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NjN9.th_n95HQI3vs-zzRaC5COcy9xPpbRujQqwgfQGRaJCw
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/security_groups" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3MyIsImVtYWlsIjoiZW1haWwtMjA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NjN9.th_n95HQI3vs-zzRaC5COcy9xPpbRujQqwgfQGRaJCw" \
	-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": "886af93c-7983-47a4-8d18-4b60ac7f85c1",
        "url": "/v2/security_groups/886af93c-7983-47a4-8d18-4b60ac7f85c1",
        "created_at": "2015-03-20T18:27:42Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy1",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/886af93c-7983-47a4-8d18-4b60ac7f85c1/spaces"
      }
    },
    {
      "metadata": {
        "guid": "470d9ce8-2823-4d79-a2ef-8d8a8c1ba1e0",
        "url": "/v2/security_groups/470d9ce8-2823-4d79-a2ef-8d8a8c1ba1e0",
        "created_at": "2015-03-20T18:27:42Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy2",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/470d9ce8-2823-4d79-a2ef-8d8a8c1ba1e0/spaces"
      }
    },
    {
      "metadata": {
        "guid": "115461b5-7619-4ee1-8b56-63c01d9eef3b",
        "url": "/v2/security_groups/115461b5-7619-4ee1-8b56-63c01d9eef3b",
        "created_at": "2015-03-20T18:27:43Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1708",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/115461b5-7619-4ee1-8b56-63c01d9eef3b/spaces"
      }
    },
    {
      "metadata": {
        "guid": "877f4fc3-8686-4f24-b2cb-adea47132fc0",
        "url": "/v2/security_groups/877f4fc3-8686-4f24-b2cb-adea47132fc0",
        "created_at": "2015-03-20T18:27:43Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1709",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/877f4fc3-8686-4f24-b2cb-adea47132fc0/spaces"
      }
    },
    {
      "metadata": {
        "guid": "dcd3c3c7-b2a1-459e-b05a-e048d0870e2b",
        "url": "/v2/security_groups/dcd3c3c7-b2a1-459e-b05a-e048d0870e2b",
        "created_at": "2015-03-20T18:27:43Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1710",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/dcd3c3c7-b2a1-459e-b05a-e048d0870e2b/spaces"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f3636f09-b174-4ad3-933e-3c4e9e7f98fa
Content-Length: 2923
X-Content-Type-Options: nosniff