Home
Version 3
Service Plans API

Service Plans API

List all Service Instances for the Service Plan

GET /v2/service_plans/:guid/service_instances

Request

Route

GET /v2/service_plans/510b2375-4038-4085-b1e9-5a23545cdf59/service_instances

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: name, space_guid, service_plan_guid, service_binding_guid, gateway_name, organization_guid, service_key_guid
(Note that filtering on service_plan_guid will return an empty list if you specify anything other than the guid included in the path.)
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTExOSIsImVtYWlsIjoiZW1haWwtODdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1NDQ1MTYxNH0.arWLw_MuqN_iZD9ZcP9aFqptwEKQPE2jIXUJ69jpoUg
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_plans/510b2375-4038-4085-b1e9-5a23545cdf59/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExOSIsImVtYWlsIjoiZW1haWwtODdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1NDQ1MTYxNH0.arWLw_MuqN_iZD9ZcP9aFqptwEKQPE2jIXUJ69jpoUg" \
	-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": "78272518-b952-4bf3-b481-adf8dad6b049",
        "url": "/v2/service_instances/78272518-b952-4bf3-b481-adf8dad6b049",
        "created_at": "2016-01-26T22:20:14Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-532",
        "credentials": {
          "creds-key-19": "creds-val-19"
        },
        "service_plan_guid": "510b2375-4038-4085-b1e9-5a23545cdf59",
        "space_guid": "fab16aeb-4b28-45c4-8e35-0772b4ea8a13",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": null,
        "tags": [

        ],
        "space_url": "/v2/spaces/fab16aeb-4b28-45c4-8e35-0772b4ea8a13",
        "service_plan_url": "/v2/service_plans/510b2375-4038-4085-b1e9-5a23545cdf59",
        "service_bindings_url": "/v2/service_instances/78272518-b952-4bf3-b481-adf8dad6b049/service_bindings",
        "service_keys_url": "/v2/service_instances/78272518-b952-4bf3-b481-adf8dad6b049/service_keys",
        "routes_url": "/v2/service_instances/78272518-b952-4bf3-b481-adf8dad6b049/routes"
      }
    }
  ]
}

Headers

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