Version 3
Services API

Services API

Retrieve a Particular Service

GET /v2/services/:guid



GET /v2/services/b0fb7de3-e1f9-42b9-b42d-c28eff420ee4


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. Max characters: 2048 []
  • database
  • mysql
requires A list of dependencies for services. The presence of "syslog_drain" indicates that on binding an instance of the service to an application, logs for the app will be streamed to a url provided by the service. The presence of "route_forwarding" indicates that on binding an instance of the service to a route, requests for the route may be processed by the service before being forwarded to an application mapped to the route. []
  • syslog_drain
  • route_forwarding
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 the 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
plan_updateable A boolean describing that an instance of this service can be updated to a different plan false


Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM5NSIsImVtYWlsIjoiZW1haWwtMjkyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg1OTk0NTF9.t40p2SHtN9HkymU1YxH-KSil_M-I_Tfr_6JmrR9y3b4
Host: example.org


curl "https://api.[your-domain.com]/v2/services/b0fb7de3-e1f9-42b9-b42d-c28eff420ee4" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM5NSIsImVtYWlsIjoiZW1haWwtMjkyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg1OTk0NTF9.t40p2SHtN9HkymU1YxH-KSil_M-I_Tfr_6JmrR9y3b4" \
	-H "Host: example.org" \
	-H "Cookie: "



200 OK


  "metadata": {
    "guid": "b0fb7de3-e1f9-42b9-b42d-c28eff420ee4",
    "url": "/v2/services/b0fb7de3-e1f9-42b9-b42d-c28eff420ee4",
    "created_at": "2016-03-14T22:30:51Z",
    "updated_at": null
  "entity": {
    "label": "label-59",
    "provider": null,
    "url": null,
    "description": "desc-215",
    "long_description": null,
    "version": null,
    "info_url": null,
    "active": true,
    "bindable": true,
    "unique_id": "d15c8c55-dd2f-458a-9488-0b8e1062a369",
    "extra": null,
    "tags": [

    "requires": [

    "documentation_url": null,
    "service_broker_guid": "21ba9489-a8fb-43bd-b7d3-f37a9a3d73b1",
    "plan_updateable": false,
    "service_plans_url": "/v2/services/b0fb7de3-e1f9-42b9-b42d-c28eff420ee4/service_plans"


Content-Type: application/json;charset=utf-8
Content-Length: 776
X-Content-Type-Options: nosniff