Retrieve a Particular Service Instance
GET /v2/service_instances/:guid
Request
Route
GET /v2/service_instances/0d632575-bb06-4ea5-bb19-a451a9644d92
Headers
cURL
curl "https://api.[your-domain.com]/v2/service_instances/0d632575-bb06-4ea5-bb19-a451a9644d92" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1MCIsImVtYWlsIjoiZW1haWwtMTA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4ODl9.eyvSz10WWSQt0pFotoQI2Lm5XdH22-50O_R8rxy7n4k" \
-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.
|
|
|
| shared_from_url
|
Source information for a shared service instance. Users of a shared service instance can find out its space and org information.
|
|
|
| shared_to_url
|
Information about where the service instance instance has been shared to.
|
|
|
| service_instance_parameters_url
|
The relative path to discover the current configuration parameters of the service instance
|
|
|
| tags
|
A list of tags for the service instance
|
|
|
|
maintenance_info
|
A maintenance information associated with the service instance. May be an empty object.
|
|
- {"version":"2.1.0", "description": "OS image update.\nExpect downtime."}
|
{
"metadata": {
"guid": "0d632575-bb06-4ea5-bb19-a451a9644d92",
"url": "/v2/service_instances/0d632575-bb06-4ea5-bb19-a451a9644d92",
"created_at": "2016-06-08T16:41:29Z",
"updated_at": "2016-06-08T16:41:26Z"
},
"entity": {
"name": "name-1508",
"credentials": {
"creds-key-38": "creds-val-38"
},
"service_guid": "a14baddf-1ccc-5299-0152-ab9s49de4422",
"service_plan_guid": "779d2df0-9cdd-48e8-9781-ea05301cedb1",
"space_guid": "38511660-89d9-4a6e-a889-c32c7e94f139",
"gateway_data": null,
"dashboard_url": null,
"type": "managed_service_instance",
"last_operation": {
"type": "create",
"state": "succeeded",
"description": "service broker-provided description",
"updated_at": "2016-06-08T16:41:29Z",
"created_at": "2016-06-08T16:41:29Z"
},
"tags": [
"accounting",
"mongodb"
],
"maintenance_info": {
"version": "2.1.1",
"description": "OS image update.\nExpect downtime."
},
"space_url": "/v2/spaces/38511660-89d9-4a6e-a889-c32c7e94f139",
"service_url": "/v2/services/a14baddf-1ccc-5299-0152-ab9s49de4422",
"service_plan_url": "/v2/service_plans/779d2df0-9cdd-48e8-9781-ea05301cedb1",
"service_bindings_url": "/v2/service_instances/0d632575-bb06-4ea5-bb19-a451a9644d92/service_bindings",
"service_keys_url": "/v2/service_instances/0d632575-bb06-4ea5-bb19-a451a9644d92/service_keys",
"routes_url": "/v2/service_instances/0d632575-bb06-4ea5-bb19-a451a9644d92/routes",
"shared_from_url": "/v2/service_instances/0d632575-bb06-4ea5-bb19-a451a9644d92/shared_from",
"shared_to_url": "/v2/service_instances/0d632575-bb06-4ea5-bb19-a451a9644d92/shared_to",
"service_instance_parameters_url": "/v2/service_instances/0d632575-bb06-4ea5-bb19-a451a9644d92/parameters"
}
}
Headers