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/1bfb812e-9abf-4943-86a8-e8718aa45929

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNSIsImVtYWlsIjoiZW1haWwtNzZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzNjgyOTc3OH0.nXY7eUsVaozXV56jwFfpRxJuea_f2d3aqr_-mIBZwYA
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/1bfb812e-9abf-4943-86a8-e8718aa45929" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNSIsImVtYWlsIjoiZW1haWwtNzZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzNjgyOTc3OH0.nXY7eUsVaozXV56jwFfpRxJuea_f2d3aqr_-mIBZwYA" \
	-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": "1bfb812e-9abf-4943-86a8-e8718aa45929",
    "url": "/v2/service_instances/1bfb812e-9abf-4943-86a8-e8718aa45929",
    "created_at": "2015-07-06T23:22:58Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-349",
    "credentials": {
      "creds-key-161": "creds-val-161"
    },
    "service_plan_guid": "f1a710a0-eae1-4663-8cf5-6e21e39d784f",
    "space_guid": "c1fa3e12-7333-4018-91ea-07ce28a96c77",
    "gateway_data": null,
    "dashboard_url": null,
    "type": "managed_service_instance",
    "last_operation": {
      "type": "create",
      "state": "succeeded",
      "description": "service broker-provided description",
      "updated_at": "2015-07-06T23:22:58Z",
      "created_at": "2015-07-06T23:22:58Z"
    },
    "tags": [
      "accounting",
      "mongodb"
    ],
    "space_url": "/v2/spaces/c1fa3e12-7333-4018-91ea-07ce28a96c77",
    "service_plan_url": "/v2/service_plans/f1a710a0-eae1-4663-8cf5-6e21e39d784f",
    "service_bindings_url": "/v2/service_instances/1bfb812e-9abf-4943-86a8-e8718aa45929/service_bindings",
    "service_keys_url": "/v2/service_instances/1bfb812e-9abf-4943-86a8-e8718aa45929/service_keys"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: ca3bc4b4-2f18-4c02-8998-b983b3299900
Content-Length: 1181
X-Content-Type-Options: nosniff