Service Plans API

Retrieve a Particular Service Plan

GET /v2/service_plans/:guid

Request

Route

GET /v2/service_plans/fa808a1d-35c2-4e49-b8da-10a7d139fd8a

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.eyJ1c2VyX2lkIjoidWFhLWlkLTE1MyIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MTQxMzY4M30.qAqeZetZIJhyIc1nZIWaU0iReH3o5Akyyd4g4lwB98U
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_plans/fa808a1d-35c2-4e49-b8da-10a7d139fd8a" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1MyIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MTQxMzY4M30.qAqeZetZIJhyIc1nZIWaU0iReH3o5Akyyd4g4lwB98U" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "fa808a1d-35c2-4e49-b8da-10a7d139fd8a",
    "url": "/v2/service_plans/fa808a1d-35c2-4e49-b8da-10a7d139fd8a",
    "created_at": "2015-12-22T18:28:03Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-496",
    "free": false,
    "description": "desc-39",
    "service_guid": "c2c9de44-f744-42c1-b798-5729be339610",
    "extra": null,
    "unique_id": "3a27a8f7-61e6-4ecd-b78f-4e904f85811f",
    "public": true,
    "active": true,
    "service_url": "/v2/services/c2c9de44-f744-42c1-b798-5729be339610",
    "service_instances_url": "/v2/service_plans/fa808a1d-35c2-4e49-b8da-10a7d139fd8a/service_instances"
  }
}

Headers

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