Home
Version 3
Service Instances API

Service Instances API

Retrieve a Particular Service Instance

GET /v2/service_instances/:guid

Request

Route

GET /v2/service_instances/bc9a6847-421e-413e-98d6-6e13212a1307

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MSIsImVtYWlsIjoiZW1haWwtMjU4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1NDd9.wl8zHbs7B3PezOII8EijXvl00PNe0VtWcLBgjnWys4o
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/bc9a6847-421e-413e-98d6-6e13212a1307" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MSIsImVtYWlsIjoiZW1haWwtMjU4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1NDd9.wl8zHbs7B3PezOII8EijXvl00PNe0VtWcLBgjnWys4o" \
	-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
  • create
  • update
  • delete
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": "bc9a6847-421e-413e-98d6-6e13212a1307",
    "url": "/v2/service_instances/bc9a6847-421e-413e-98d6-6e13212a1307",
    "created_at": "2015-09-11T18:39:07Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-2084",
    "credentials": {
      "creds-key-593": "creds-val-593"
    },
    "service_plan_guid": "20b53485-d2a1-47d8-98e5-70a179decbba",
    "space_guid": "c2f34d7c-7853-4b2c-ab77-019b53b56af4",
    "gateway_data": null,
    "dashboard_url": null,
    "type": "managed_service_instance",
    "last_operation": {
      "type": "create",
      "state": "succeeded",
      "description": "service broker-provided description",
      "updated_at": "2015-09-11T18:39:07Z",
      "created_at": "2015-09-11T18:39:07Z"
    },
    "tags": [
      "accounting",
      "mongodb"
    ],
    "space_url": "/v2/spaces/c2f34d7c-7853-4b2c-ab77-019b53b56af4",
    "service_plan_url": "/v2/service_plans/20b53485-d2a1-47d8-98e5-70a179decbba",
    "service_bindings_url": "/v2/service_instances/bc9a6847-421e-413e-98d6-6e13212a1307/service_bindings",
    "service_keys_url": "/v2/service_instances/bc9a6847-421e-413e-98d6-6e13212a1307/service_keys",
    "routes_url": "/v2/service_instances/bc9a6847-421e-413e-98d6-6e13212a1307/routes"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 85e3271f-7f57-4bab-852d-03835fa28d55
Content-Length: 1269
X-Content-Type-Options: nosniff