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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0MiIsImVtYWlsIjoiZW1haWwtMzEzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5OTV9.xIycQj5wdiYWasxZMpeLcra8LB0kgHhnyFfEpjEZ-AI
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/security_groups" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0MiIsImVtYWlsIjoiZW1haWwtMzEzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5OTV9.xIycQj5wdiYWasxZMpeLcra8LB0kgHhnyFfEpjEZ-AI" \
	-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": "5697b8ff-c2e9-48e3-a3ae-8b57805fd65c",
        "url": "/v2/security_groups/5697b8ff-c2e9-48e3-a3ae-8b57805fd65c",
        "created_at": "2016-01-13T17:29:54Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy1",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/5697b8ff-c2e9-48e3-a3ae-8b57805fd65c/spaces"
      }
    },
    {
      "metadata": {
        "guid": "f18b8180-ff49-41d4-8b51-827126505ffb",
        "url": "/v2/security_groups/f18b8180-ff49-41d4-8b51-827126505ffb",
        "created_at": "2016-01-13T17:29:54Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy2",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/f18b8180-ff49-41d4-8b51-827126505ffb/spaces"
      }
    },
    {
      "metadata": {
        "guid": "dbd67624-a3e9-4c4c-9275-a5f10566cacf",
        "url": "/v2/security_groups/dbd67624-a3e9-4c4c-9275-a5f10566cacf",
        "created_at": "2016-01-13T17:29:55Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2309",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/dbd67624-a3e9-4c4c-9275-a5f10566cacf/spaces"
      }
    },
    {
      "metadata": {
        "guid": "288cb319-a7e4-4279-8c3e-00cbcd47964b",
        "url": "/v2/security_groups/288cb319-a7e4-4279-8c3e-00cbcd47964b",
        "created_at": "2016-01-13T17:29:55Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2310",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/288cb319-a7e4-4279-8c3e-00cbcd47964b/spaces"
      }
    },
    {
      "metadata": {
        "guid": "40852ed9-3b4f-42d5-a566-e4410811613e",
        "url": "/v2/security_groups/40852ed9-3b4f-42d5-a566-e4410811613e",
        "created_at": "2016-01-13T17:29:55Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2311",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/40852ed9-3b4f-42d5-a566-e4410811613e/spaces"
      }
    }
  ]
}

Headers

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