Home
Version 3
Services API

Services API

Retrieve a Particular Service

GET /v2/services/:guid

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
guid The guid of the Service

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NCIsImVtYWlsIjoiZW1haWwtMjg2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczODF9.fpActI2rbP_RpzFzBI2ocQB3e4tGBFa4BNcSnTxcqMk
Host: example.org
Cookie:

Route

GET /v2/services/653adedf-45fc-4ac1-914c-596a084fc994

cURL

curl "https://api.[your-domain.com]/v2/services/653adedf-45fc-4ac1-914c-596a084fc994" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NCIsImVtYWlsIjoiZW1haWwtMjg2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczODF9.fpActI2rbP_RpzFzBI2ocQB3e4tGBFa4BNcSnTxcqMk" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 9ca909a2-c1c4-4ad9-97ef-1884555c35e1
Content-Length: 814
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "653adedf-45fc-4ac1-914c-596a084fc994",
    "url": "/v2/services/653adedf-45fc-4ac1-914c-596a084fc994",
    "created_at": "2015-02-10T01:43:01Z",
    "updated_at": null
  },
  "entity": {
    "label": "label-84",
    "provider": "provider-49",
    "url": "https://foo.com/url-104",
    "description": "desc-197",
    "long_description": null,
    "version": "version-33",
    "info_url": null,
    "active": true,
    "bindable": true,
    "unique_id": "2d69c91a-bf06-4287-86f2-e4ce92e13944",
    "extra": null,
    "tags": [

    ],
    "requires": [

    ],
    "documentation_url": null,
    "service_broker_guid": "e349da97-f73b-49a0-802c-ea2b37cf6249",
    "plan_updateable": false,
    "service_plans_url": "/v2/services/653adedf-45fc-4ac1-914c-596a084fc994/service_plans"
  }
}