Home
Version 3
Service Plans API

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.eyJ1c2VyX2lkIjoidWFhLWlkLTc2IiwiZW1haWwiOiJlbWFpbC00NUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYxOTU4MzkzfQ.mjrowoin6B7tEHkuPQx_OFtH3WtGn6mkuyscZL0eiyc
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/service_plans" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTc2IiwiZW1haWwiOiJlbWFpbC00NUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYxOTU4MzkzfQ.mjrowoin6B7tEHkuPQx_OFtH3WtGn6mkuyscZL0eiyc" \
	-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": "a008f0c4-2c26-47f9-b677-409c11958b37",
        "url": "/v2/service_plans/a008f0c4-2c26-47f9-b677-409c11958b37",
        "created_at": "2016-04-22T19:33:13Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-146",
        "free": false,
        "description": "desc-6",
        "service_guid": "0dcc349f-080a-48ca-8f4b-b13eb7c1e8f8",
        "extra": null,
        "unique_id": "abe74e06-b55f-4e14-a81f-d67218f3d604",
        "public": true,
        "active": true,
        "service_url": "/v2/services/0dcc349f-080a-48ca-8f4b-b13eb7c1e8f8",
        "service_instances_url": "/v2/service_plans/a008f0c4-2c26-47f9-b677-409c11958b37/service_instances"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: b92452cd-d221-4668-aac4-6841cc32afa4
Content-Length: 839
X-Content-Type-Options: nosniff