Home
Version 3
Service Plans API

Service Plans API

List all Service Plans

GET /v2/service_plans

Fields

Name Description Default Valid Values Example Values
guid The guid of the service plan
name The name of the service plan
  • 100mb
free A boolean describing if the service plan is free
  • true
  • false
description A description of the service plan
  • Let's you put data in your database!
extra A JSON string with additional data about the plan
  • {"cost": "$2.00"}
unique_id A guid for the service plan in the service broker (not the same as the cloud controller guid)
public A boolean describing that the plan is visible to the all users true
service_guid The guid of the related service
  • deadbeef
active A boolean that determines whether plans can be used to create new instances.
  • true
  • false

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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5NyIsImVtYWlsIjoiZW1haWwtMTcwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjN9.yLc5voYGOq2Eh3GkPpOfFEbrGbMkFKQLDuMrD8coujk
Host: example.org
Cookie:

Route

GET /v2/service_plans

cURL

curl "https://api.[your-domain.com]/v2/service_plans" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5NyIsImVtYWlsIjoiZW1haWwtMTcwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjN9.yLc5voYGOq2Eh3GkPpOfFEbrGbMkFKQLDuMrD8coujk" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f23328c6-a460-4409-8681-3ab573369734
Content-Length: 845
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "2023e50b-8448-467a-9030-306d43b308bf",
        "url": "/v2/service_plans/2023e50b-8448-467a-9030-306d43b308bf",
        "created_at": "2014-11-24T19:32:43+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-752",
        "free": false,
        "description": "desc-93",
        "service_guid": "f91f86eb-530b-4ebc-917b-fe39423fb6f6",
        "extra": null,
        "unique_id": "a0c5d770-8422-451d-be0d-209b8792d486",
        "public": true,
        "active": true,
        "service_url": "/v2/services/f91f86eb-530b-4ebc-917b-fe39423fb6f6",
        "service_instances_url": "/v2/service_plans/2023e50b-8448-467a-9030-306d43b308bf/service_instances"
      }
    }
  ]
}