Home
Version 3
Service Plans API

Service Plans API

Retrieve a Particular Service Plan

GET /v2/service_plans/:guid

Request

Route

GET /v2/service_plans/393caca8-6480-4f37-beb2-3e1f166fc589

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.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNiIsImVtYWlsIjoiZW1haWwtMTA0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4MzZ9.qyPLnphrgWkzOfwX3kyV9MAOeGIL5njc98cWKKFaMG8
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_plans/393caca8-6480-4f37-beb2-3e1f166fc589" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNiIsImVtYWlsIjoiZW1haWwtMTA0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4MzZ9.qyPLnphrgWkzOfwX3kyV9MAOeGIL5njc98cWKKFaMG8" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "393caca8-6480-4f37-beb2-3e1f166fc589",
    "url": "/v2/service_plans/393caca8-6480-4f37-beb2-3e1f166fc589",
    "created_at": "2015-11-03T00:53:56Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-750",
    "free": false,
    "description": "desc-155",
    "service_guid": "d9af7fe5-2f98-45f7-b616-f7d542f454d0",
    "extra": null,
    "unique_id": "1d2a29dd-25ff-488b-a576-f50f95cb3209",
    "public": true,
    "active": true,
    "service_url": "/v2/services/d9af7fe5-2f98-45f7-b616-f7d542f454d0",
    "service_instances_url": "/v2/service_plans/393caca8-6480-4f37-beb2-3e1f166fc589/service_instances"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: aa65648e-5ca2-4631-b7d6-f7b3f9a7d7e6
Content-Length: 654
X-Content-Type-Options: nosniff