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.eyJ1c2VyX2lkIjoidWFhLWlkLTM3MCIsImVtYWlsIjoiZW1haWwtMjcxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MjB9.D_mrvD6gj4XJ97SwnrCvCt0-WJrFSWRfnhMOX4s5Zjs
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/security_groups" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3MCIsImVtYWlsIjoiZW1haWwtMjcxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MjB9.D_mrvD6gj4XJ97SwnrCvCt0-WJrFSWRfnhMOX4s5Zjs" \
	-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": "28448490-1f15-4265-aac2-a8d8afb6fe70",
        "url": "/v2/security_groups/28448490-1f15-4265-aac2-a8d8afb6fe70",
        "created_at": "2015-04-07T19:11:49Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy1",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/28448490-1f15-4265-aac2-a8d8afb6fe70/spaces"
      }
    },
    {
      "metadata": {
        "guid": "88a3402f-702c-440c-9b21-ab6c09c67f57",
        "url": "/v2/security_groups/88a3402f-702c-440c-9b21-ab6c09c67f57",
        "created_at": "2015-04-07T19:11:49Z",
        "updated_at": null
      },
      "entity": {
        "name": "dummy2",
        "rules": [

        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/88a3402f-702c-440c-9b21-ab6c09c67f57/spaces"
      }
    },
    {
      "metadata": {
        "guid": "11ca19ab-e75f-41d9-81bc-69ba1209b3c5",
        "url": "/v2/security_groups/11ca19ab-e75f-41d9-81bc-69ba1209b3c5",
        "created_at": "2015-04-07T19:12:00Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2042",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/11ca19ab-e75f-41d9-81bc-69ba1209b3c5/spaces"
      }
    },
    {
      "metadata": {
        "guid": "3ff89a51-acda-4f7c-a7ae-6129800f06a8",
        "url": "/v2/security_groups/3ff89a51-acda-4f7c-a7ae-6129800f06a8",
        "created_at": "2015-04-07T19:12:00Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2043",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/3ff89a51-acda-4f7c-a7ae-6129800f06a8/spaces"
      }
    },
    {
      "metadata": {
        "guid": "23f46bd9-5c34-46fe-962c-69e29b37f3f4",
        "url": "/v2/security_groups/23f46bd9-5c34-46fe-962c-69e29b37f3f4",
        "created_at": "2015-04-07T19:12:00Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2044",
        "rules": [
          {
            "protocol": "udp",
            "ports": "8080",
            "destination": "198.41.191.47/1"
          }
        ],
        "running_default": false,
        "staging_default": false,
        "spaces_url": "/v2/security_groups/23f46bd9-5c34-46fe-962c-69e29b37f3f4/spaces"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 9c99619d-62bf-46f8-872e-1746ac3d86b9
Content-Length: 2923
X-Content-Type-Options: nosniff