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/aa32c5c3-379c-4eb8-b0b6-a090e86d7e0b

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.eyJ1c2VyX2lkIjoidWFhLWlkLTUxIiwiZW1haWwiOiJlbWFpbC01MUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyMzEzNjA2fQ.ROEBETxBT_aTXIRwRYnExETskAWVXxOIDSvBPZ5GHjQ
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_plans/aa32c5c3-379c-4eb8-b0b6-a090e86d7e0b" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTUxIiwiZW1haWwiOiJlbWFpbC01MUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyMzEzNjA2fQ.ROEBETxBT_aTXIRwRYnExETskAWVXxOIDSvBPZ5GHjQ" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "aa32c5c3-379c-4eb8-b0b6-a090e86d7e0b",
    "url": "/v2/service_plans/aa32c5c3-379c-4eb8-b0b6-a090e86d7e0b",
    "created_at": "2015-05-15T16:53:26Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-240",
    "free": false,
    "description": "desc-42",
    "service_guid": "5f001525-ccb7-4525-babd-e7f09734c954",
    "extra": null,
    "unique_id": "b46cacf6-3a75-4299-b594-df02a68d4141",
    "public": true,
    "active": true,
    "service_url": "/v2/services/5f001525-ccb7-4525-babd-e7f09734c954",
    "service_instances_url": "/v2/service_plans/aa32c5c3-379c-4eb8-b0b6-a090e86d7e0b/service_instances"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 149e4828-04d5-4a63-80bf-d6fd84fe10e8
Content-Length: 653
X-Content-Type-Options: nosniff