Home
Version 3
Services API

Services API

Retrieve a Particular Service

GET /v2/services/:guid

Request

Route

GET /v2/services/25cbebb0-ef6a-4f3f-ade9-d20a894a2715

Parameters

Name Description Valid Values Example Values
guid The guid of the Service

Body

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
plan_updateable A boolean describing that an instance of this service can be updated to a different plan false

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3MSIsImVtYWlsIjoiZW1haWwtMjczQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjYxODc3NjV9.AAyNXMfPy_u4Cw6KNshmA4Ncgx0JpPsCirxaeqbA4sg
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/services/25cbebb0-ef6a-4f3f-ade9-d20a894a2715" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3MSIsImVtYWlsIjoiZW1haWwtMjczQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjYxODc3NjV9.AAyNXMfPy_u4Cw6KNshmA4Ncgx0JpPsCirxaeqbA4sg" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "25cbebb0-ef6a-4f3f-ade9-d20a894a2715",
    "url": "/v2/services/25cbebb0-ef6a-4f3f-ade9-d20a894a2715",
    "created_at": "2015-03-05T19:16:05Z",
    "updated_at": null
  },
  "entity": {
    "label": "label-79",
    "provider": "provider-49",
    "url": "https://foo.com/url-100",
    "description": "desc-187",
    "long_description": null,
    "version": "version-33",
    "info_url": null,
    "active": true,
    "bindable": true,
    "unique_id": "18fa6e87-10ca-4520-a161-7934d35bf3ab",
    "extra": null,
    "tags": [

    ],
    "requires": [

    ],
    "documentation_url": null,
    "service_broker_guid": "f66bbc09-9eed-49bf-899a-b2f4c7345916",
    "plan_updateable": false,
    "service_plans_url": "/v2/services/25cbebb0-ef6a-4f3f-ade9-d20a894a2715/service_plans"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 537f27da-4dcb-4a9b-b244-9a10fbbdfb49
Content-Length: 814
X-Content-Type-Options: nosniff