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/bea59ac1-bbb0-47f4-acf3-f0a71e39afcd

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyNyIsImVtYWlsIjoiZW1haWwtMTc2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzUxMDI4NTV9.TqAP9gCkuk2tLFtHiI9EBSMrfgysCZilobCm-7XofYM
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/bea59ac1-bbb0-47f4-acf3-f0a71e39afcd" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyNyIsImVtYWlsIjoiZW1haWwtMTc2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzUxMDI4NTV9.TqAP9gCkuk2tLFtHiI9EBSMrfgysCZilobCm-7XofYM" \
	-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.
tags A list of tags for the service instance
{
  "metadata": {
    "guid": "bea59ac1-bbb0-47f4-acf3-f0a71e39afcd",
    "url": "/v2/service_instances/bea59ac1-bbb0-47f4-acf3-f0a71e39afcd",
    "created_at": "2015-06-16T23:40:55Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-884",
    "credentials": {
      "creds-key-372": "creds-val-372"
    },
    "service_plan_guid": "06c2ee73-59ce-440b-90aa-ed88ff7da73e",
    "space_guid": "0e07f33e-abbf-4033-951e-8d3b2611a6fa",
    "gateway_data": null,
    "dashboard_url": null,
    "type": "managed_service_instance",
    "last_operation": {
      "type": "create",
      "state": "succeeded",
      "description": "service broker-provided description",
      "updated_at": "2015-06-16T23:40:55Z",
      "created_at": "2015-06-16T23:40:55Z"
    },
    "tags": [
      "accounting",
      "mongodb"
    ],
    "space_url": "/v2/spaces/0e07f33e-abbf-4033-951e-8d3b2611a6fa",
    "service_plan_url": "/v2/service_plans/06c2ee73-59ce-440b-90aa-ed88ff7da73e",
    "service_bindings_url": "/v2/service_instances/bea59ac1-bbb0-47f4-acf3-f0a71e39afcd/service_bindings",
    "service_keys_url": "/v2/service_instances/bea59ac1-bbb0-47f4-acf3-f0a71e39afcd/service_keys"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c05aa8e5-6c5b-4a58-b13e-c0f8bf08402f
Content-Length: 1181
X-Content-Type-Options: nosniff