Service Plans API

List all Service Instances for the Service Plan

GET /v2/service_plans/:guid/service_instances

Request

Route

GET /v2/service_plans/2eddc041-8e12-436a-8d9c-0e39cd6a7efb/service_instances

Parameters

Name	Description	Example Values
q	Parameters used to filter the result set. Format queries as <filter><op><value> Valid ops: : >= <= < > IN Valid filters: name, space_guid, service_binding_guid, gateway_name, service_key_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 Plan.

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMCIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1ODU5OTQzMH0.E2i3eeJkyxnuOp0yLeTCcJYkEZ4JJXZ0CuxlUqViQ20
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/service_plans/2eddc041-8e12-436a-8d9c-0e39cd6a7efb/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMCIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1ODU5OTQzMH0.E2i3eeJkyxnuOp0yLeTCcJYkEZ4JJXZ0CuxlUqViQ20" \
	-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": "0a35b324-186b-4a17-8c4a-49a40e816686",
        "url": "/v2/service_instances/0a35b324-186b-4a17-8c4a-49a40e816686",
        "created_at": "2016-03-14T22:30:30Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1366",
        "credentials": {
          "creds-key-36": "creds-val-36"
        },
        "service_plan_guid": "2eddc041-8e12-436a-8d9c-0e39cd6a7efb",
        "space_guid": "444374b0-f97f-445a-85b5-42f8b4fdab0b",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": null,
        "tags": [

        ],
        "space_url": "/v2/spaces/444374b0-f97f-445a-85b5-42f8b4fdab0b",
        "service_plan_url": "/v2/service_plans/2eddc041-8e12-436a-8d9c-0e39cd6a7efb",
        "service_bindings_url": "/v2/service_instances/0a35b324-186b-4a17-8c4a-49a40e816686/service_bindings",
        "service_keys_url": "/v2/service_instances/0a35b324-186b-4a17-8c4a-49a40e816686/service_keys",
        "routes_url": "/v2/service_instances/0a35b324-186b-4a17-8c4a-49a40e816686/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 1245
X-Content-Type-Options: nosniff