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.eyJ1c2VyX2lkIjoidWFhLWlkLTExIiwiZW1haWwiOiJlbWFpbC0xMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI1OTQ4NjU3fQ.0p1yMJbnVFG-15rs04nF4BPsIL97BZinURu4kbJX2Yo
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/security_groups" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExIiwiZW1haWwiOiJlbWFpbC0xMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI1OTQ4NjU3fQ.0p1yMJbnVFG-15rs04nF4BPsIL97BZinURu4kbJX2Yo" \
	-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": "596f6670-c139-4529-9d6a-d8f790929c6e",
        "url": "/v2/security_groups/596f6670-c139-4529-9d6a-d8f790929c6e",
        "created_at": "2015-03-03T00:50:56Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy1",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/596f6670-c139-4529-9d6a-d8f790929c6e/spaces"
      }
    },
    {
      "metadata": {
        "guid": "cad71f26-58a4-4558-a37c-524132337abe",
        "url": "/v2/security_groups/cad71f26-58a4-4558-a37c-524132337abe",
        "created_at": "2015-03-03T00:50:56Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy2",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/cad71f26-58a4-4558-a37c-524132337abe/spaces"
      }
    },
    {
      "metadata": {
        "guid": "62d674e0-0bf5-4848-8ab5-12bd6f952f9d",
        "url": "/v2/security_groups/62d674e0-0bf5-4848-8ab5-12bd6f952f9d",
        "created_at": "2015-03-03T00:50:57Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-28",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/62d674e0-0bf5-4848-8ab5-12bd6f952f9d/spaces"
      }
    },
    {
      "metadata": {
        "guid": "f2afee22-5d39-47a7-ae33-5db736b7bbff",
        "url": "/v2/security_groups/f2afee22-5d39-47a7-ae33-5db736b7bbff",
        "created_at": "2015-03-03T00:50:57Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-29",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/f2afee22-5d39-47a7-ae33-5db736b7bbff/spaces"
      }
    },
    {
      "metadata": {
        "guid": "b7b91ceb-e622-4511-bf3d-33002ed87178",
        "url": "/v2/security_groups/b7b91ceb-e622-4511-bf3d-33002ed87178",
        "created_at": "2015-03-03T00:50:57Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-30",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/b7b91ceb-e622-4511-bf3d-33002ed87178/spaces"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 2aad8bc4-4504-4ec2-ba13-bd3fb8e9de67
Content-Length: 2917
X-Content-Type-Options: nosniff