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.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MyIsImVtYWlsIjoiZW1haWwtMjYzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTY0NTIyNDN9.614DW7xHGiGbQHLtoYe4PjGjY6eNYhb52py4SI2ouA8
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/security_groups" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MyIsImVtYWlsIjoiZW1haWwtMjYzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTY0NTIyNDN9.614DW7xHGiGbQHLtoYe4PjGjY6eNYhb52py4SI2ouA8" \
	-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": "8b5d04f3-798c-45d6-98d1-a79300b02370",
        "url": "/v2/security_groups/8b5d04f3-798c-45d6-98d1-a79300b02370",
        "created_at": "2016-02-19T02:03:49Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy1",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/8b5d04f3-798c-45d6-98d1-a79300b02370/spaces"
      }
    },
    {
      "metadata": {
        "guid": "c3347222-96fa-4290-a64e-d61ceb18ea09",
        "url": "/v2/security_groups/c3347222-96fa-4290-a64e-d61ceb18ea09",
        "created_at": "2016-02-19T02:03:49Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy2",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/c3347222-96fa-4290-a64e-d61ceb18ea09/spaces"
      }
    },
    {
      "metadata": {
        "guid": "b20545fc-cb46-4245-94aa-8d65de91d366",
        "url": "/v2/security_groups/b20545fc-cb46-4245-94aa-8d65de91d366",
        "created_at": "2016-02-19T02:04:03Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2402",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/b20545fc-cb46-4245-94aa-8d65de91d366/spaces"
      }
    },
    {
      "metadata": {
        "guid": "7707077d-e93e-4130-a4ac-8a8df86c2d25",
        "url": "/v2/security_groups/7707077d-e93e-4130-a4ac-8a8df86c2d25",
        "created_at": "2016-02-19T02:04:03Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2403",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/7707077d-e93e-4130-a4ac-8a8df86c2d25/spaces"
      }
    },
    {
      "metadata": {
        "guid": "5e7668b2-cf9d-420e-a8ae-3217a3e994c6",
        "url": "/v2/security_groups/5e7668b2-cf9d-420e-a8ae-3217a3e994c6",
        "created_at": "2016-02-19T02:04:03Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2404",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/5e7668b2-cf9d-420e-a8ae-3217a3e994c6/spaces"
      }
    }
  ]
}

Headers

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