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
|
|
|
|
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
|
[]
|
|
|
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
|
|
|
|
Parameters
Name |
Description |
Valid Values |
Example Values |
guid
|
The guid of the Service
|
|
|
Request
Headers
Route
GET /v2/services/b1fb723d-f69f-4f26-b54e-fb2287b9236f
cURL
curl "https://api.[your-domain.com]/v2/services/b1fb723d-f69f-4f26-b54e-fb2287b9236f" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwMiIsImVtYWlsIjoiZW1haWwtNzNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDMxMDEyNH0.B7TGeck15LrnnqZDFp_RyRLo2KxjcvrbB8m7ZVtAgUc" \
-H "Host: example.org" \
-H "Cookie: "
Response
Headers
Status
200 OK
Body
{
"metadata": {
"guid": "b1fb723d-f69f-4f26-b54e-fb2287b9236f",
"url": "/v2/services/b1fb723d-f69f-4f26-b54e-fb2287b9236f",
"created_at": "2015-02-12T01:42:04Z",
"updated_at": null
},
"entity": {
"label": "label-22",
"provider": "provider-13",
"url": "https://foo.com/url-26",
"description": "desc-56",
"long_description": null,
"version": "version-13",
"info_url": null,
"active": true,
"bindable": true,
"unique_id": "cddb1c9b-7ae5-4b2b-9b70-9f414c7284de",
"extra": null,
"tags": [
],
"requires": [
],
"documentation_url": null,
"service_broker_guid": "688561c1-0db1-47b7-a101-09640184ef30",
"plan_updateable": false,
"service_plans_url": "/v2/services/b1fb723d-f69f-4f26-b54e-fb2287b9236f/service_plans"
}
}