Name | Description | Default | Valid Values | Example Values |
---|---|---|---|---|
guid | The guid of the service |
|
|
|
label | The name of the service |
|
|
|
description | A short blurb describing the service |
|
|
|
long_description | A longer description of the service |
|
|
|
info_url | A url that points to an info page for the service |
|
|
|
documentation_url | A url that points to a documentation page for the service |
|
|
|
timeout | A timeout used by the v1 service gateway client |
|
|
|
active | A boolean describing that the service can be provisioned by users | false |
|
|
bindable | A boolean describing that the service can be bound to applications | true |
|
|
extra | A JSON field with extra data pertaining to the service |
|
|
|
unique_id | A guid that identifies the service with the broker (not the same as the guid above) |
|
|
|
tags | A list of tags for the service | [] |
|
|
requires | A list of dependencies for services | [] |
|
|
provider | The name of the service provider (used only by v1 service gateways) |
|
|
|
version | The version of the service (used only by v1 service gateways) |
|
|
|
url | The url of ther service provider (used only by v1 service gateways) |
|
|
|
service_broker_guid | The guid of the v2 service broker associated with the service |
|
|
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: active, label, provider, service_broker_guid |
|
|
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.eyJ1c2VyX2lkIjoidWFhLWlkLTgwIiwiZW1haWwiOiJlbWFpbC03M0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE3NDYyMzU2fQ.P8fzoqx3t74kCsvAfbPBjhB3V-tl29gTEiIsq0GPXNc Host: example.org Cookie:
GET /v2/services
curl "https://api.[your-domain.com]/v2/services" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTgwIiwiZW1haWwiOiJlbWFpbC03M0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE3NDYyMzU2fQ.P8fzoqx3t74kCsvAfbPBjhB3V-tl29gTEiIsq0GPXNc" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: c08bba44-4f29-4b9e-ad6b-e3f1d2e0b8c0 Content-Length: 1040 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "0576fb9a-6061-4a91-8e99-46f3f60ed036", "url": "/v2/services/0576fb9a-6061-4a91-8e99-46f3f60ed036", "created_at": "2014-11-24T19:32:36+00:00", "updated_at": null }, "entity": { "label": "label-16", "provider": "provider-16", "url": "https://foo.com/url-25", "description": "desc-47", "long_description": null, "version": "version-16", "info_url": null, "active": true, "bindable": true, "unique_id": "e2424186-87a3-4d06-801d-d0593df3732d", "extra": null, "tags": [ ], "requires": [ ], "documentation_url": null, "service_broker_guid": "985611ef-b902-4c30-afda-5745d924ffeb", "plan_updateable": false, "service_plans_url": "/v2/services/0576fb9a-6061-4a91-8e99-46f3f60ed036/service_plans" } } ] }