Retrieve a Particular Service Instance
GET /v2/service_instances/:guid
Request
Route
GET /v2/service_instances/df52420f-d5b9-4b86-a7d3-6d7005d1ce96
Headers
cURL
curl "https://api.[your-domain.com]/v2/service_instances/df52420f-d5b9-4b86-a7d3-6d7005d1ce96" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ3MCIsImVtYWlsIjoiZW1haWwtMzM3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDk1MzE1NDF9.akjNZRwVyY1eWwjWdSowrZ0MhA2b9TPISzVp9fOcqRs" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
| Name |
Description |
Valid Values |
|
name
|
The human-readable name of the service instance.
|
|
|
credentials
|
The service broker-provided credentials to use this service.
|
|
|
service_plan_guid
|
The service plan GUID that this service instance is utilizing.
|
|
|
space_guid
|
The space GUID that this service instance belongs to.
|
|
|
gateway_data
|
|
|
|
dashboard_url
|
The service broker-provided URL to access administrative features of the service instance. May be null.
|
|
|
type
|
The type of service instance.
|
- managed_service_instance
- user_provided_service_instance
|
|
last_operation
|
The status of the last operation requested on the service instance. May be null.
|
|
|
last_operation.type
|
The type of operation that was last performed or currently being performed on the service instance
|
|
|
last_operation.state
|
The status of the last operation or current operation being performed on the service instance.
|
- in progress
- succeeded
- failed
|
|
last_operation.description
|
The service broker-provided description of the operation. May be null.
|
|
|
last_operation.updated_at
|
The timestamp that the Cloud Controller last checked the service instance state from the broker.
|
|
|
space_url
|
The relative path to the space resource that this service instance belongs to.
|
|
|
service_plan_url
|
The relative path to the service plan resource that this service instance belongs to.
|
|
|
service_binding_url
|
The relative path to the service bindings that this service instance is bound to.
|
|
|
routes_url
|
Routes bound to the service instance. Requests to these routes will be forwarded to the service instance.
|
|
|
tags
|
A list of tags for the service instance
|
|
{
"metadata": {
"guid": "df52420f-d5b9-4b86-a7d3-6d7005d1ce96",
"url": "/v2/service_instances/df52420f-d5b9-4b86-a7d3-6d7005d1ce96",
"created_at": "2015-11-30T23:39:01Z",
"updated_at": null
},
"entity": {
"name": "name-2583",
"credentials": {
"creds-key-749": "creds-val-749"
},
"service_plan_guid": "65740f84-214a-46cf-b8e3-2233d580f293",
"space_guid": "e3138257-8035-4c03-8aba-ab5d35eec0f9",
"gateway_data": null,
"dashboard_url": null,
"type": "managed_service_instance",
"last_operation": {
"type": "create",
"state": "succeeded",
"description": "service broker-provided description",
"updated_at": "2015-11-30T23:39:01Z",
"created_at": "2015-11-30T23:39:01Z"
},
"tags": [
"accounting",
"mongodb"
],
"space_url": "/v2/spaces/e3138257-8035-4c03-8aba-ab5d35eec0f9",
"service_plan_url": "/v2/service_plans/65740f84-214a-46cf-b8e3-2233d580f293",
"service_bindings_url": "/v2/service_instances/df52420f-d5b9-4b86-a7d3-6d7005d1ce96/service_bindings",
"service_keys_url": "/v2/service_instances/df52420f-d5b9-4b86-a7d3-6d7005d1ce96/service_keys",
"routes_url": "/v2/service_instances/df52420f-d5b9-4b86-a7d3-6d7005d1ce96/routes"
}
}
Headers