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/1c3aba7b-e3e5-4ea5-a004-0961eb5f30a4

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.eyJ1c2VyX2lkIjoidWFhLWlkLTMzMSIsImVtYWlsIjoiZW1haWwtMjU4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2NDV9.e8LXmWYqu1x7TR5oGg6dOVRHW8fn-cyvCFRy2w_AQkw
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_plans/1c3aba7b-e3e5-4ea5-a004-0961eb5f30a4" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzMSIsImVtYWlsIjoiZW1haWwtMjU4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2NDV9.e8LXmWYqu1x7TR5oGg6dOVRHW8fn-cyvCFRy2w_AQkw" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "1c3aba7b-e3e5-4ea5-a004-0961eb5f30a4",
    "url": "/v2/service_plans/1c3aba7b-e3e5-4ea5-a004-0961eb5f30a4",
    "created_at": "2015-05-07T23:37:25Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-2019",
    "free": false,
    "description": "desc-207",
    "service_guid": "574aaaf8-c1c4-488b-b11b-207b25e2ce8f",
    "extra": null,
    "unique_id": "a84ebb0e-befa-4689-8afc-cb2b459e1266",
    "public": true,
    "active": true,
    "service_url": "/v2/services/574aaaf8-c1c4-488b-b11b-207b25e2ce8f",
    "service_instances_url": "/v2/service_plans/1c3aba7b-e3e5-4ea5-a004-0961eb5f30a4/service_instances"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 5a48b5c8-b294-44f8-81cb-779baba5cae2
Content-Length: 655
X-Content-Type-Options: nosniff