Home
Version 3
Service Instances API

Service Instances API

Retrieve a Particular Service Instance

GET /v2/service_instances/:guid

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
guid The guid of the Service Instance

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwOCIsImVtYWlsIjoiZW1haWwtNzlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjk5MDg3MH0.lJR_wZq5Q5ayW76XCRQFmIid4bbqM9YChXLJZAG1YfQ
Host: example.org
Cookie: 

Route

GET /v2/service_instances/1887f081-bba4-4891-8840-d1b084301948

cURL

curl "https://api.[your-domain.com]/v2/service_instances/1887f081-bba4-4891-8840-d1b084301948" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwOCIsImVtYWlsIjoiZW1haWwtNzlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjk5MDg3MH0.lJR_wZq5Q5ayW76XCRQFmIid4bbqM9YChXLJZAG1YfQ" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 284a9982-d140-4fe1-9cc9-42479e9f89df
Content-Length: 880
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "1887f081-bba4-4891-8840-d1b084301948",
    "url": "/v2/service_instances/1887f081-bba4-4891-8840-d1b084301948",
    "created_at": "2015-01-27T19:14:30Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-1114",
    "credentials": {
      "creds-key-181": "creds-val-181"
    },
    "service_plan_guid": "4e149525-0b91-4100-ab9e-29d8606c4f34",
    "space_guid": "d47f4dbb-a2f9-4215-a9b0-8eb0f4f98428",
    "gateway_data": null,
    "dashboard_url": null,
    "type": "managed_service_instance",
    "state": "in progress",
    "state_description": "state_description goes here",
    "space_url": "/v2/spaces/d47f4dbb-a2f9-4215-a9b0-8eb0f4f98428",
    "service_plan_url": "/v2/service_plans/4e149525-0b91-4100-ab9e-29d8606c4f34",
    "service_bindings_url": "/v2/service_instances/1887f081-bba4-4891-8840-d1b084301948/service_bindings"
  }
}