Service Plans API

Retrieve a Particular Service Plan

GET /v2/service_plans/:guid

Request

Route

GET /v2/service_plans/5d8f3b0f-6b5b-487f-8fed-4c2d9b812a72

Body

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxNiIsImVtYWlsIjoiZW1haWwtMTQ3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDk1MzE1MjR9.kmLxnDuz9s4NueVKjUWcHFcaCZpBLlJMq0qr_DWt3qs
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_plans/5d8f3b0f-6b5b-487f-8fed-4c2d9b812a72" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxNiIsImVtYWlsIjoiZW1haWwtMTQ3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDk1MzE1MjR9.kmLxnDuz9s4NueVKjUWcHFcaCZpBLlJMq0qr_DWt3qs" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "5d8f3b0f-6b5b-487f-8fed-4c2d9b812a72",
    "url": "/v2/service_plans/5d8f3b0f-6b5b-487f-8fed-4c2d9b812a72",
    "created_at": "2015-11-30T23:38:44Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-1787",
    "free": false,
    "description": "desc-146",
    "service_guid": "6a4abae6-93e0-438b-aaa2-5ae67f3a069d",
    "extra": null,
    "unique_id": "26ea9cc7-bf96-4ca6-9c27-d9146f9c75da",
    "public": true,
    "active": true,
    "service_url": "/v2/services/6a4abae6-93e0-438b-aaa2-5ae67f3a069d",
    "service_instances_url": "/v2/service_plans/5d8f3b0f-6b5b-487f-8fed-4c2d9b812a72/service_instances"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 655
X-Content-Type-Options: nosniff