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/f298c80b-0e68-4b33-8040-c30cd649efc2

Parameters

Name Description Valid Values Example Values
guid The guid of the Service Plan

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.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NyIsImVtYWlsIjoiZW1haWwtMjg5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2ODB9.l8uJjRWa6CfoUeJLObu1sYgRK-EVbhDqMI9c1UBjiYs
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_plans/f298c80b-0e68-4b33-8040-c30cd649efc2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NyIsImVtYWlsIjoiZW1haWwtMjg5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2ODB9.l8uJjRWa6CfoUeJLObu1sYgRK-EVbhDqMI9c1UBjiYs" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "f298c80b-0e68-4b33-8040-c30cd649efc2",
    "url": "/v2/service_plans/f298c80b-0e68-4b33-8040-c30cd649efc2",
    "created_at": "2015-03-03T00:51:20Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-2089",
    "free": false,
    "description": "desc-192",
    "service_guid": "c00d8c1a-2754-43f3-99c8-6fe239cc92bf",
    "extra": null,
    "unique_id": "a26e2126-0f77-4c2d-94c6-9b0c12f71171",
    "public": true,
    "active": true,
    "service_url": "/v2/services/c00d8c1a-2754-43f3-99c8-6fe239cc92bf",
    "service_instances_url": "/v2/service_plans/f298c80b-0e68-4b33-8040-c30cd649efc2/service_instances"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 05bf0e93-0169-423f-8908-ef53dc82f054
Content-Length: 655
X-Content-Type-Options: nosniff