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/061eefb9-9001-4381-973e-b460b950d5ed/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
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ4IiwiZW1haWwiOiJlbWFpbC00N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM1MTAyODQ3fQ.Y5xdUNUkWh3feH3S92J-AepNQIP4h249JOslJSmwTc0
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_plans/061eefb9-9001-4381-973e-b460b950d5ed/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ4IiwiZW1haWwiOiJlbWFpbC00N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM1MTAyODQ3fQ.Y5xdUNUkWh3feH3S92J-AepNQIP4h249JOslJSmwTc0" \
	-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": "5e5b86c2-deac-4396-8917-8083d8a3ff6d",
        "url": "/v2/service_instances/5e5b86c2-deac-4396-8917-8083d8a3ff6d",
        "created_at": "2015-06-16T23:40:47Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-351",
        "credentials": {
          "creds-key-103": "creds-val-103"
        },
        "service_plan_guid": "061eefb9-9001-4381-973e-b460b950d5ed",
        "space_guid": "949d566f-83eb-41c1-a68e-2e1554ee027d",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": null,
        "tags": [

        ],
        "space_url": "/v2/spaces/949d566f-83eb-41c1-a68e-2e1554ee027d",
        "service_plan_url": "/v2/service_plans/061eefb9-9001-4381-973e-b460b950d5ed",
        "service_bindings_url": "/v2/service_instances/5e5b86c2-deac-4396-8917-8083d8a3ff6d/service_bindings",
        "service_keys_url": "/v2/service_instances/5e5b86c2-deac-4396-8917-8083d8a3ff6d/service_keys"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 2b3a7a67-6568-4925-b7c5-fa4106a3c8a1
Content-Length: 1155
X-Content-Type-Options: nosniff