Name | Description | Default | Valid Values | Example Values |
---|
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 |
|
|
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. |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1MiIsImVtYWlsIjoiZW1haWwtMTc3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDN9.dRpzQ_On9AqKwMnsBZ3wd91qK3XsW16ScDHE-_GJn4Q Host: example.org Cookie:
GET /v2/security_groups
curl "https://api.[your-domain.com]/v2/security_groups" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1MiIsImVtYWlsIjoiZW1haWwtMTc3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDN9.dRpzQ_On9AqKwMnsBZ3wd91qK3XsW16ScDHE-_GJn4Q" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 051f195a-6025-4826-b525-e0f4a6f7d2ea Content-Length: 2945 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "5e9d4c04-a516-441c-bf41-115d044128cf", "url": "/v2/security_groups/5e9d4c04-a516-441c-bf41-115d044128cf", "created_at": "2014-11-05T01:02:07+00:00", "updated_at": null }, "entity": { "name": "dummy1", "rules": [ ], "running_default": false, "staging_default": false, "spaces_url": "/v2/security_groups/5e9d4c04-a516-441c-bf41-115d044128cf/spaces" } }, { "metadata": { "guid": "d2536166-9e35-47e2-93a8-c36ba010f0e5", "url": "/v2/security_groups/d2536166-9e35-47e2-93a8-c36ba010f0e5", "created_at": "2014-11-05T01:02:07+00:00", "updated_at": null }, "entity": { "name": "dummy2", "rules": [ ], "running_default": false, "staging_default": false, "spaces_url": "/v2/security_groups/d2536166-9e35-47e2-93a8-c36ba010f0e5/spaces" } }, { "metadata": { "guid": "87640650-fcdd-4a7d-aeda-1f3a50900307", "url": "/v2/security_groups/87640650-fcdd-4a7d-aeda-1f3a50900307", "created_at": "2014-11-05T01:02:23+00:00", "updated_at": null }, "entity": { "name": "name-827", "rules": [ { "protocol": "udp", "ports": "8080", "destination": "198.41.191.47/1" } ], "running_default": false, "staging_default": false, "spaces_url": "/v2/security_groups/87640650-fcdd-4a7d-aeda-1f3a50900307/spaces" } }, { "metadata": { "guid": "f650325e-d687-4eaf-9aae-37345a46a1fc", "url": "/v2/security_groups/f650325e-d687-4eaf-9aae-37345a46a1fc", "created_at": "2014-11-05T01:02:23+00:00", "updated_at": null }, "entity": { "name": "name-828", "rules": [ { "protocol": "udp", "ports": "8080", "destination": "198.41.191.47/1" } ], "running_default": false, "staging_default": false, "spaces_url": "/v2/security_groups/f650325e-d687-4eaf-9aae-37345a46a1fc/spaces" } }, { "metadata": { "guid": "d1530b29-bfde-4bb3-84f7-dfcec2497459", "url": "/v2/security_groups/d1530b29-bfde-4bb3-84f7-dfcec2497459", "created_at": "2014-11-05T01:02:23+00:00", "updated_at": null }, "entity": { "name": "name-829", "rules": [ { "protocol": "udp", "ports": "8080", "destination": "198.41.191.47/1" } ], "running_default": false, "staging_default": false, "spaces_url": "/v2/security_groups/d1530b29-bfde-4bb3-84f7-dfcec2497459/spaces" } } ] }