Service Plans API

Retrieve a Particular Service Plan

GET /v2/service_plans/:guid

Request

Route

GET /v2/service_plans/d4c61b95-c5bd-46c4-acc9-9cfcebf3dfe9

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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OCIsImVtYWlsIjoiZW1haWwtMTk0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDl9.4qNxpVqUiLK88Dbk-C9aFktc00zeOr7Nyf5dpN8ern4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_plans/d4c61b95-c5bd-46c4-acc9-9cfcebf3dfe9" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OCIsImVtYWlsIjoiZW1haWwtMTk0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDl9.4qNxpVqUiLK88Dbk-C9aFktc00zeOr7Nyf5dpN8ern4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "d4c61b95-c5bd-46c4-acc9-9cfcebf3dfe9",
    "url": "/v2/service_plans/d4c61b95-c5bd-46c4-acc9-9cfcebf3dfe9",
    "created_at": "2015-08-31T21:50:09Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-1035",
    "free": false,
    "description": "desc-150",
    "service_guid": "313157ed-4e2c-454b-a9a2-b14d3e7e9147",
    "extra": null,
    "unique_id": "6366b5e6-bfdd-4a0d-b47e-91b145c4c181",
    "public": true,
    "active": true,
    "service_url": "/v2/services/313157ed-4e2c-454b-a9a2-b14d3e7e9147",
    "service_instances_url": "/v2/service_plans/d4c61b95-c5bd-46c4-acc9-9cfcebf3dfe9/service_instances"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 3141e9ca-039d-489e-9940-afa97188684f
Content-Length: 655
X-Content-Type-Options: nosniff