Home
Version 3
Service Plans API

Service Plans API

Creating a Service Plan (deprecated)

POST /v2/service_plans

Fields

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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExOCIsImVtYWlsIjoiZW1haWwtODhAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjk5MDg3MX0.AGqWCRtTaif2L1wrsNadfQI0eMyi92hkh7LI5RV_GIg
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

Route

POST /v2/service_plans

Body

{
  "name": "100mb",
  "free": true,
  "description": "Let's you put data in your database!",
  "service_guid": "df143fd3-5297-416f-85ca-d74e4b194dda"
}

cURL

curl "https://api.[your-domain.com]/v2/service_plans" -d '{
  "name": "100mb",
  "free": true,
  "description": "Let\u0027s you put data in your database!",
  "service_guid": "df143fd3-5297-416f-85ca-d74e4b194dda"
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExOCIsImVtYWlsIjoiZW1haWwtODhAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjk5MDg3MX0.AGqWCRtTaif2L1wrsNadfQI0eMyi92hkh7LI5RV_GIg" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/service_plans/b7ecbd86-e6cb-4cbd-b8f3-9121345fc1ca
X-VCAP-Request-ID: ffd99060-79e0-4ba1-b8e4-ea64f12e26e1
Content-Length: 678
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "b7ecbd86-e6cb-4cbd-b8f3-9121345fc1ca",
    "url": "/v2/service_plans/b7ecbd86-e6cb-4cbd-b8f3-9121345fc1ca",
    "created_at": "2015-01-27T19:14:31Z",
    "updated_at": null
  },
  "entity": {
    "name": "100mb",
    "free": true,
    "description": "Let's you put data in your database!",
    "service_guid": "df143fd3-5297-416f-85ca-d74e4b194dda",
    "extra": null,
    "unique_id": "2bdc4784-5533-4a15-b46f-7ad6ef594bc1",
    "public": true,
    "active": true,
    "service_url": "/v2/services/df143fd3-5297-416f-85ca-d74e4b194dda",
    "service_instances_url": "/v2/service_plans/b7ecbd86-e6cb-4cbd-b8f3-9121345fc1ca/service_instances"
  }
}