Home
Version 3
Service Instances API

Service Instances API

List all Service Bindings for the Service Instance

GET /v2/service_instances/:guid/service_bindings

Request

Route

GET /v2/service_instances/2a03b287-928e-4b64-917c-7d125511f6d8/service_bindings

Parameters

Name Description Valid Values Example Values
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: app_guid, service_instance_guid
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
page Page of results to fetch
results-per-page Number of results per page
order-direction Order of the results: asc (default) or desc
inline-relations-depth 0 - don't inline any relations and return URLs. Otherwise, inline to depth N.
orphan-relations 0 - de-duplicate object entries in response
exclude-relations comma-delimited list of relations to drop from response
include-relations comma-delimited list of the only relations to include in response

Body

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyIiwiZW1haWwiOiJlbWFpbC0yMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ3MTE2ODI2fQ.eQJiYK4-KglvxZc8Wqyo69I73817-DMaUVrjxfY5sJY
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/2a03b287-928e-4b64-917c-7d125511f6d8/service_bindings" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyIiwiZW1haWwiOiJlbWFpbC0yMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ3MTE2ODI2fQ.eQJiYK4-KglvxZc8Wqyo69I73817-DMaUVrjxfY5sJY" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "826447d3-90be-4deb-9927-188e7f6aef0f",
        "url": "/v2/service_bindings/826447d3-90be-4deb-9927-188e7f6aef0f",
        "created_at": "2015-11-03T00:53:46Z",
        "updated_at": null
      },
      "entity": {
        "app_guid": "096f929d-9296-4d70-896a-a29a84cbe3ef",
        "service_instance_guid": "2a03b287-928e-4b64-917c-7d125511f6d8",
        "credentials": {
          "creds-key-54": "creds-val-54"
        },
        "binding_options": {

        },
        "gateway_data": null,
        "gateway_name": "",
        "syslog_drain_url": null,
        "app_url": "/v2/apps/096f929d-9296-4d70-896a-a29a84cbe3ef",
        "service_instance_url": "/v2/service_instances/2a03b287-928e-4b64-917c-7d125511f6d8"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7f00f351-7859-4b7f-8af9-0dd602fbb5d1
Content-Length: 882
X-Content-Type-Options: nosniff