Home
Version 3
Service Plans API

Service Plans API

List all Service Instances for the Service Plan

GET /v2/service_plans/:guid/service_instances

Fields

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

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
  • 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.

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0OCIsImVtYWlsIjoiZW1haWwtMTExQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxMzd9.B-ZWZByNz2S7kCohd8fvqwGGnyHcCYWdVIcs-j09n0Q
Host: example.org
Cookie: 

Route

GET /v2/service_plans/713f67f2-3b3a-4d08-ae3f-f9b88667108e/service_instances

cURL

curl "https://api.[your-domain.com]/v2/service_plans/713f67f2-3b3a-4d08-ae3f-f9b88667108e/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0OCIsImVtYWlsIjoiZW1haWwtMTExQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxMzd9.B-ZWZByNz2S7kCohd8fvqwGGnyHcCYWdVIcs-j09n0Q" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 302b6ae7-80d8-4583-b4e8-ef249a5365c6
Content-Length: 995
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "4859e98c-05e1-4f85-bca7-fdf9248a6181",
        "url": "/v2/service_instances/4859e98c-05e1-4f85-bca7-fdf9248a6181",
        "created_at": "2014-11-05T01:02:17+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-668",
        "credentials": {
          "creds-key-245": "creds-val-245"
        },
        "service_plan_guid": "713f67f2-3b3a-4d08-ae3f-f9b88667108e",
        "space_guid": "7c79f6d4-246b-46ba-bfa0-800ca46fcb4a",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "space_url": "/v2/spaces/7c79f6d4-246b-46ba-bfa0-800ca46fcb4a",
        "service_plan_url": "/v2/service_plans/713f67f2-3b3a-4d08-ae3f-f9b88667108e",
        "service_bindings_url": "/v2/service_instances/4859e98c-05e1-4f85-bca7-fdf9248a6181/service_bindings"
      }
    }
  ]
}