Service Plans API

List all Service Plans

GET /v2/service_plans

Request

Route

GET /v2/service_plans

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: active, service_guid, service_instance_guid, service_broker_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
public	A boolean describing that the plan is visible to the all users	true

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMxNiIsImVtYWlsIjoiZW1haWwtMjE4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2Mzl9.3Jk6i25KrKSiqwpzgpHdIbPlSAkgLr9tB9IHPnIzQE8
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_plans" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMxNiIsImVtYWlsIjoiZW1haWwtMjE4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2Mzl9.3Jk6i25KrKSiqwpzgpHdIbPlSAkgLr9tB9IHPnIzQE8" \
	-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": "928bd52a-376c-44d9-80c9-03cffa8f1ab9",
        "url": "/v2/service_plans/928bd52a-376c-44d9-80c9-03cffa8f1ab9",
        "created_at": "2016-04-16T01:23:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1034",
        "free": false,
        "description": "desc-163",
        "service_guid": "02f5220f-607b-4b8c-a5d6-0af2d26dcda3",
        "extra": null,
        "unique_id": "c0939025-8bc0-45f2-abcb-134c0b967a29",
        "public": true,
        "active": true,
        "service_url": "/v2/services/02f5220f-607b-4b8c-a5d6-0af2d26dcda3",
        "service_instances_url": "/v2/service_plans/928bd52a-376c-44d9-80c9-03cffa8f1ab9/service_instances"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 715d1fe0-6225-47e7-aaf8-042bcf675387
Content-Length: 842
X-Content-Type-Options: nosniff