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.eyJ1c2VyX2lkIjoidWFhLWlkLTI0MiIsImVtYWlsIjoiZW1haWwtMTc0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE2OTl9.-DMSD1Hd3vnMG1uw6frtQESD9gzrAf3YpSMwGugvqa8
Host: example.org
Cookie: 

Route

GET /v2/service_plans/6b9c5a63-4811-4df4-9d06-4ada41738483

cURL

curl "https://api.[your-domain.com]/v2/service_plans/6b9c5a63-4811-4df4-9d06-4ada41738483" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0MiIsImVtYWlsIjoiZW1haWwtMTc0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE2OTl9.-DMSD1Hd3vnMG1uw6frtQESD9gzrAf3YpSMwGugvqa8" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 4ffc362b-a5b0-4f20-ae85-73ca30873695
Content-Length: 655
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "6b9c5a63-4811-4df4-9d06-4ada41738483",
    "url": "/v2/service_plans/6b9c5a63-4811-4df4-9d06-4ada41738483",
    "created_at": "2015-02-13T22:34:59Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-1422",
    "free": false,
    "description": "desc-112",
    "service_guid": "8528a90f-5715-42f2-bacf-4327f3a275e5",
    "extra": null,
    "unique_id": "52a0ad02-e5a1-4655-997b-ed77eb4eddb1",
    "public": true,
    "active": true,
    "service_url": "/v2/services/8528a90f-5715-42f2-bacf-4327f3a275e5",
    "service_instances_url": "/v2/service_plans/6b9c5a63-4811-4df4-9d06-4ada41738483/service_instances"
  }
}