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.eyJ1c2VyX2lkIjoidWFhLWlkLTk4IiwiZW1haWwiOiJlbWFpbC02OUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDUzODM3MjU5fQ.T2OxI-ESF6vY9hW3XOWeVMjEyPF2LLVTp_MTSnZ3964
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/security_groups" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTk4IiwiZW1haWwiOiJlbWFpbC02OUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDUzODM3MjU5fQ.T2OxI-ESF6vY9hW3XOWeVMjEyPF2LLVTp_MTSnZ3964" \
	-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": "085a9568-6d3b-4f27-9306-633f1443ba45",
        "url": "/v2/security_groups/085a9568-6d3b-4f27-9306-633f1443ba45",
        "created_at": "2016-01-19T19:40:58Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy1",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/085a9568-6d3b-4f27-9306-633f1443ba45/spaces"
      }
    },
    {
      "metadata": {
        "guid": "b3e62253-8843-4049-b465-5ce154892546",
        "url": "/v2/security_groups/b3e62253-8843-4049-b465-5ce154892546",
        "created_at": "2016-01-19T19:40:58Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy2",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/b3e62253-8843-4049-b465-5ce154892546/spaces"
      }
    },
    {
      "metadata": {
        "guid": "c0062f37-f766-4da0-a09c-eebd306849ab",
        "url": "/v2/security_groups/c0062f37-f766-4da0-a09c-eebd306849ab",
        "created_at": "2016-01-19T19:40:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-319",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/c0062f37-f766-4da0-a09c-eebd306849ab/spaces"
      }
    },
    {
      "metadata": {
        "guid": "47bf30f1-bdb0-4dd6-ab3a-4a493d5a11e6",
        "url": "/v2/security_groups/47bf30f1-bdb0-4dd6-ab3a-4a493d5a11e6",
        "created_at": "2016-01-19T19:40:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-320",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/47bf30f1-bdb0-4dd6-ab3a-4a493d5a11e6/spaces"
      }
    },
    {
      "metadata": {
        "guid": "2e6c4ada-924b-49bb-9a9a-ca744f5a97b7",
        "url": "/v2/security_groups/2e6c4ada-924b-49bb-9a9a-ca744f5a97b7",
        "created_at": "2016-01-19T19:40:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-321",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/2e6c4ada-924b-49bb-9a9a-ca744f5a97b7/spaces"
      }
    }
  ]
}

Headers

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