Home
Version 3
Service Plans API

Service Plans API

Retrieve a Particular Service Plan

GET /v2/service_plans/:guid

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
guid The guid of the Service Plan

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5OSIsImVtYWlsIjoiZW1haWwtMTcyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjN9.FEkGMDvDBDz5Pp7vv-M5S-jwcot_tQWb8-tIE76qcNk
Host: example.org
Cookie: 

Route

GET /v2/service_plans/fe486a87-c76b-4f53-a28d-d468bbf69fb6

cURL

curl "https://api.[your-domain.com]/v2/service_plans/fe486a87-c76b-4f53-a28d-d468bbf69fb6" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5OSIsImVtYWlsIjoiZW1haWwtMTcyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjN9.FEkGMDvDBDz5Pp7vv-M5S-jwcot_tQWb8-tIE76qcNk" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: e13aa3a9-24e2-4ab0-96a7-927a5bf37fa8
Content-Length: 658
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "fe486a87-c76b-4f53-a28d-d468bbf69fb6",
    "url": "/v2/service_plans/fe486a87-c76b-4f53-a28d-d468bbf69fb6",
    "created_at": "2014-11-24T19:32:43+00:00",
    "updated_at": null
  },
  "entity": {
    "name": "name-754",
    "free": false,
    "description": "desc-97",
    "service_guid": "092991c9-3341-40d2-8bb2-685a2b82e9cd",
    "extra": null,
    "unique_id": "a07c06ef-0d28-4de4-828e-d95968f0eaca",
    "public": true,
    "active": true,
    "service_url": "/v2/services/092991c9-3341-40d2-8bb2-685a2b82e9cd",
    "service_instances_url": "/v2/service_plans/fe486a87-c76b-4f53-a28d-d468bbf69fb6/service_instances"
  }
}