Retrieve a Particular Service
GET /v2/services/:guid
Request
Route
GET /v2/services/53f52780-e93c-4af7-a96c-6958311c40e5
Body
| 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. Max characters: 2048
|
[]
|
|
|
|
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)
|
|
|
|
|
version
|
The version of the service (used only by v1 service gateways)
|
|
|
|
|
url
|
The url of the service provider (used only by v1 service gateways)
|
|
|
|
|
service_broker_guid
|
The guid of the v2 service broker associated with the service
|
|
|
|
|
service_broker_name
|
The name 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
|
|
|
|
instances_retrievable
|
A boolean describing that the service may support fetching configuration parameters for service instances
|
false
|
|
|
|
bindings_retrievable
|
A boolean describing that the service may support fetching configuration parameters for service bindings
|
false
|
|
|
Headers
cURL
curl "https://api.[your-domain.com]/v2/services/53f52780-e93c-4af7-a96c-6958311c40e5" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4MSIsImVtYWlsIjoiZW1haWwtMTM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTJ9.Az1OoZ-6t631XQxWQJatcsd2kkP7twEf4_vLd0SsYes" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{
"metadata": {
"guid": "53f52780-e93c-4af7-a96c-6958311c40e5",
"url": "/v2/services/53f52780-e93c-4af7-a96c-6958311c40e5",
"created_at": "2016-06-08T16:41:32Z",
"updated_at": "2016-06-08T16:41:26Z"
},
"entity": {
"label": "label-58",
"provider": null,
"url": null,
"description": "desc-135",
"long_description": null,
"version": null,
"info_url": null,
"active": true,
"bindable": true,
"unique_id": "c181996b-f233-43d1-8901-3a43eafcaacf",
"extra": null,
"tags": [
],
"requires": [
],
"documentation_url": null,
"service_broker_guid": "0e7250aa-364f-42c2-8fd2-808b0224376f",
"service_broker_name": "name-1700",
"plan_updateable": false,
"instances_retrievable": false,
"bindings_retrievable": false,
"service_plans_url": "/v2/services/53f52780-e93c-4af7-a96c-6958311c40e5/service_plans"
}
}
Headers