Retrieve a Particular Service Instance
GET /v2/service_instances/:guid
Request
Route
GET /v2/service_instances/2ff9661e-5fc1-4408-87dd-9b16e7864f4f
Headers
cURL
curl "https://api.[your-domain.com]/v2/service_instances/2ff9661e-5fc1-4408-87dd-9b16e7864f4f" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNyIsImVtYWlsIjoiZW1haWwtOTZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MDUwNjY0M30.F-twakzNGxFtJMN-Sk6BOdoTBrnS9mSnLXU-UERH6JI" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
| Name |
Description |
Valid Values |
Example 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": "2ff9661e-5fc1-4408-87dd-9b16e7864f4f",
"url": "/v2/service_instances/2ff9661e-5fc1-4408-87dd-9b16e7864f4f",
"created_at": "2016-04-06T00:17:22Z",
"updated_at": null
},
"entity": {
"name": "name-363",
"credentials": {
"creds-key-11": "creds-val-11"
},
"service_plan_guid": "022de7a6-95e1-4ad9-893e-1513f559124b",
"space_guid": "55a0fd1d-189c-412b-9169-cb23fd8579c6",
"gateway_data": null,
"dashboard_url": null,
"type": "managed_service_instance",
"last_operation": {
"type": "create",
"state": "succeeded",
"description": "service broker-provided description",
"updated_at": "2016-04-06T00:17:22Z",
"created_at": "2016-04-06T00:17:22Z"
},
"tags": [
"accounting",
"mongodb"
],
"space_url": "/v2/spaces/55a0fd1d-189c-412b-9169-cb23fd8579c6",
"service_plan_url": "/v2/service_plans/022de7a6-95e1-4ad9-893e-1513f559124b",
"service_bindings_url": "/v2/service_instances/2ff9661e-5fc1-4408-87dd-9b16e7864f4f/service_bindings",
"service_keys_url": "/v2/service_instances/2ff9661e-5fc1-4408-87dd-9b16e7864f4f/service_keys",
"routes_url": "/v2/service_instances/2ff9661e-5fc1-4408-87dd-9b16e7864f4f/routes"
}
}
Headers