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/c54998fb-9dfe-4795-9a6e-3b6824afbbbd

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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ3IiwiZW1haWwiOiJlbWFpbC00NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM1MTAyODQ3fQ.EKToVhSANbfADls15F5HY3ne6_15VBpUssza74k9kL0
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_plans/c54998fb-9dfe-4795-9a6e-3b6824afbbbd" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ3IiwiZW1haWwiOiJlbWFpbC00NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM1MTAyODQ3fQ.EKToVhSANbfADls15F5HY3ne6_15VBpUssza74k9kL0" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "c54998fb-9dfe-4795-9a6e-3b6824afbbbd",
    "url": "/v2/service_plans/c54998fb-9dfe-4795-9a6e-3b6824afbbbd",
    "created_at": "2015-06-16T23:40:47Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-348",
    "free": false,
    "description": "desc-74",
    "service_guid": "199042ec-4662-4c50-a4c5-cca5790449e2",
    "extra": null,
    "unique_id": "c085939c-1d4c-4795-9584-5f8ac289dc1d",
    "public": true,
    "active": true,
    "service_url": "/v2/services/199042ec-4662-4c50-a4c5-cca5790449e2",
    "service_instances_url": "/v2/service_plans/c54998fb-9dfe-4795-9a6e-3b6824afbbbd/service_instances"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 8e2a21dd-e836-49d4-b3a6-c00213d018e7
Content-Length: 653
X-Content-Type-Options: nosniff