Service Plans API

List all Service Instances for the Service Plan

GET /v2/service_plans/:guid/service_instances

Request

Route

GET /v2/service_plans/5b223b40-5bc9-4100-9f23-f75c99e9a411/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_plan_guid, service_binding_guid, gateway_name, organization_guid, 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.eyJ1c2VyX2lkIjoidWFhLWlkLTE1MCIsImVtYWlsIjoiZW1haWwtODhAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MTQxMzY4M30.Clqi2KLj9G4PqRwuHel2FojD2R4UD130RjHtzng0cn8
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/service_plans/5b223b40-5bc9-4100-9f23-f75c99e9a411/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1MCIsImVtYWlsIjoiZW1haWwtODhAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MTQxMzY4M30.Clqi2KLj9G4PqRwuHel2FojD2R4UD130RjHtzng0cn8" \
	-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": "2f742032-35eb-4e1e-8430-955ceff4497d",
        "url": "/v2/service_instances/2f742032-35eb-4e1e-8430-955ceff4497d",
        "created_at": "2015-12-22T18:28:02Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-487",
        "credentials": {
          "creds-key-189": "creds-val-189"
        },
        "service_plan_guid": "5b223b40-5bc9-4100-9f23-f75c99e9a411",
        "space_guid": "27d609b7-40a8-47e7-9a97-ff93796b4c02",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": null,
        "tags": [

        ],
        "space_url": "/v2/spaces/27d609b7-40a8-47e7-9a97-ff93796b4c02",
        "service_plan_url": "/v2/service_plans/5b223b40-5bc9-4100-9f23-f75c99e9a411",
        "service_bindings_url": "/v2/service_instances/2f742032-35eb-4e1e-8430-955ceff4497d/service_bindings",
        "service_keys_url": "/v2/service_instances/2f742032-35eb-4e1e-8430-955ceff4497d/service_keys",
        "routes_url": "/v2/service_instances/2f742032-35eb-4e1e-8430-955ceff4497d/routes"
      }
    }
  ]
}

Headers

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