Home
Version 3
Services API

Services API

List all Services

GET /v2/services

Fields

Name Description Default Valid Values Example Values
guid The guid of the service
label The name of the service
  • SomeMysqlService
description A short blurb describing the service
  • Mysql stores things for you
long_description A longer description of the service
  • Mysql is a database. It stores things. Use it in your apps...
info_url A url that points to an info page for the service
  • http://info.somemysqlservice.com
documentation_url A url that points to a documentation page for the service
  • http://docs.somemysqlservice.com
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
  • {"providerDisplayName": "MyServiceProvider"}
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 []
  • database
  • mysql
requires A list of dependencies for services []
  • syslog_drain
provider The name of the service provider (used only by v1 service gateways)
  • MySql Provider
version The version of the service (used only by v1 service gateways)
  • 2.0
url The url of ther service provider (used only by v1 service gateways)
  • http://myql.provider.com
service_broker_guid The guid of the v2 service broker associated with the service

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: active, label, provider, service_broker_guid
  • 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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzMCIsImVtYWlsIjoiZW1haWwtMTcxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzZ9.QNors0fijk_uAO39dypFVnl3PPpn_Yn4rKVMCpOKD68
Host: example.org
Cookie:

Route

GET /v2/services

cURL

curl "https://api.[your-domain.com]/v2/services" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzMCIsImVtYWlsIjoiZW1haWwtMTcxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzZ9.QNors0fijk_uAO39dypFVnl3PPpn_Yn4rKVMCpOKD68" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: b0a5969c-07cc-4732-9df4-4f67bf94f5de
Content-Length: 1036
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "47a0f490-ca0b-4164-8b28-09f39f469b49",
        "url": "/v2/services/47a0f490-ca0b-4164-8b28-09f39f469b49",
        "created_at": "2015-01-27T19:14:36Z",
        "updated_at": null
      },
      "entity": {
        "label": "label-57",
        "provider": "provider-57",
        "url": "https://foo.com/url-81",
        "description": "desc-108",
        "long_description": null,
        "version": "version-41",
        "info_url": null,
        "active": true,
        "bindable": true,
        "unique_id": "723a11b1-8c7b-474e-845f-ccdc3858b11a",
        "extra": null,
        "tags": [

        ],
        "requires": [

        ],
        "documentation_url": null,
        "service_broker_guid": "f7873edb-0922-4d07-9337-a5e92aa9955b",
        "plan_updateable": false,
        "service_plans_url": "/v2/services/47a0f490-ca0b-4164-8b28-09f39f469b49/service_plans"
      }
    }
  ]
}