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.eyJ1c2VyX2lkIjoidWFhLWlkLTQiLCJlbWFpbCI6ImVtYWlsLTRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDEzNzM2Mn0.3ntTv6rdwATOiB93S_X3iNHd2MimDKcDeW4E_4W0Eko Host: example.org Cookie:
GET /v2/security_groups
curl "https://api.[your-domain.com]/v2/security_groups" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQiLCJlbWFpbCI6ImVtYWlsLTRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDEzNzM2Mn0.3ntTv6rdwATOiB93S_X3iNHd2MimDKcDeW4E_4W0Eko" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 39337e01-9a52-4ffb-9f8e-99d1c80f4311 Content-Length: 2917 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 5, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "138030d6-5b21-4a72-a3ab-5d9fa6d96224", "url": "/v2/security_groups/138030d6-5b21-4a72-a3ab-5d9fa6d96224", "created_at": "2015-02-10T01:42:41Z", "updated_at": null }, "entity": { "name": "dummy1", "rules": [ ], "running_default": false, "staging_default": false, "spaces_url": "/v2/security_groups/138030d6-5b21-4a72-a3ab-5d9fa6d96224/spaces" } }, { "metadata": { "guid": "fbf2bf18-37e0-4dcf-a371-00eef14d2c00", "url": "/v2/security_groups/fbf2bf18-37e0-4dcf-a371-00eef14d2c00", "created_at": "2015-02-10T01:42:41Z", "updated_at": null }, "entity": { "name": "dummy2", "rules": [ ], "running_default": false, "staging_default": false, "spaces_url": "/v2/security_groups/fbf2bf18-37e0-4dcf-a371-00eef14d2c00/spaces" } }, { "metadata": { "guid": "f69b8f82-9bd9-4b6d-9dab-f5c274b4834d", "url": "/v2/security_groups/f69b8f82-9bd9-4b6d-9dab-f5c274b4834d", "created_at": "2015-02-10T01:42:42Z", "updated_at": null }, "entity": { "name": "name-10", "rules": [ { "protocol": "udp", "ports": "8080", "destination": "198.41.191.47/1" } ], "running_default": false, "staging_default": false, "spaces_url": "/v2/security_groups/f69b8f82-9bd9-4b6d-9dab-f5c274b4834d/spaces" } }, { "metadata": { "guid": "0ce46f4b-28fc-428d-b660-afa5c53e4487", "url": "/v2/security_groups/0ce46f4b-28fc-428d-b660-afa5c53e4487", "created_at": "2015-02-10T01:42:42Z", "updated_at": null }, "entity": { "name": "name-11", "rules": [ { "protocol": "udp", "ports": "8080", "destination": "198.41.191.47/1" } ], "running_default": false, "staging_default": false, "spaces_url": "/v2/security_groups/0ce46f4b-28fc-428d-b660-afa5c53e4487/spaces" } }, { "metadata": { "guid": "f9906947-f652-4dfa-93e2-73d1dc372043", "url": "/v2/security_groups/f9906947-f652-4dfa-93e2-73d1dc372043", "created_at": "2015-02-10T01:42:42Z", "updated_at": null }, "entity": { "name": "name-12", "rules": [ { "protocol": "udp", "ports": "8080", "destination": "198.41.191.47/1" } ], "running_default": false, "staging_default": false, "spaces_url": "/v2/security_groups/f9906947-f652-4dfa-93e2-73d1dc372043/spaces" } } ] }