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. |
|
|
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 |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExMyIsImVtYWlsIjoiZW1haWwtNzVAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDQ3MTY5MH0.xahNydCg87HcJAcGPfOpqa5jAdmApN_ExuLoucblpzw Host: example.org Cookie:
GET /v2/security_groups
curl "https://api.[your-domain.com]/v2/security_groups" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExMyIsImVtYWlsIjoiZW1haWwtNzVAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDQ3MTY5MH0.xahNydCg87HcJAcGPfOpqa5jAdmApN_ExuLoucblpzw" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 30c085e9-a3ec-44fc-b565-e1b0cd6c21be Content-Length: 2920 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "6c2b3e58-20d9-4c14-9810-bebd95a7090a", "url": "/v2/security_groups/6c2b3e58-20d9-4c14-9810-bebd95a7090a", "created_at": "2015-02-13T22:34:45Z", "updated_at": null }, "entity": { "name": "dummy1", "rules": [ ], "running_default": false, "staging_default": false, "spaces_url": "/v2/security_groups/6c2b3e58-20d9-4c14-9810-bebd95a7090a/spaces" } }, { "metadata": { "guid": "b631d2c6-9309-47ef-b51e-600309f1f382", "url": "/v2/security_groups/b631d2c6-9309-47ef-b51e-600309f1f382", "created_at": "2015-02-13T22:34:45Z", "updated_at": null }, "entity": { "name": "dummy2", "rules": [ ], "running_default": false, "staging_default": false, "spaces_url": "/v2/security_groups/b631d2c6-9309-47ef-b51e-600309f1f382/spaces" } }, { "metadata": { "guid": "17876564-cd56-408e-849d-3b59bf4461c4", "url": "/v2/security_groups/17876564-cd56-408e-849d-3b59bf4461c4", "created_at": "2015-02-13T22:34:49Z", "updated_at": null }, "entity": { "name": "name-292", "rules": [ { "protocol": "udp", "ports": "8080", "destination": "198.41.191.47/1" } ], "running_default": false, "staging_default": false, "spaces_url": "/v2/security_groups/17876564-cd56-408e-849d-3b59bf4461c4/spaces" } }, { "metadata": { "guid": "68265f0e-4574-4d07-88d0-d002313bfc6f", "url": "/v2/security_groups/68265f0e-4574-4d07-88d0-d002313bfc6f", "created_at": "2015-02-13T22:34:49Z", "updated_at": null }, "entity": { "name": "name-293", "rules": [ { "protocol": "udp", "ports": "8080", "destination": "198.41.191.47/1" } ], "running_default": false, "staging_default": false, "spaces_url": "/v2/security_groups/68265f0e-4574-4d07-88d0-d002313bfc6f/spaces" } }, { "metadata": { "guid": "31899778-ecba-4739-b499-f20ac0d0dea6", "url": "/v2/security_groups/31899778-ecba-4739-b499-f20ac0d0dea6", "created_at": "2015-02-13T22:34:49Z", "updated_at": null }, "entity": { "name": "name-294", "rules": [ { "protocol": "udp", "ports": "8080", "destination": "198.41.191.47/1" } ], "running_default": false, "staging_default": false, "spaces_url": "/v2/security_groups/31899778-ecba-4739-b499-f20ac0d0dea6/spaces" } } ] }