Home
Version 3
Service Plans API

Service Plans API

Creating a Service Plan (deprecated)

POST /v2/service_plans

Request

Route

POST /v2/service_plans

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
 
{
  "name": "100mb",
  "free": true,
  "description": "Let's you put data in your database!",
  "service_guid": "7501e58e-266e-4e43-88e0-fdf19618fd0e"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2NiIsImVtYWlsIjoiZW1haWwtMjY4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjY2MzM5MjF9._K41MU9Ab8GI6-cDedT3cN9cbJrikyMguy_eWf6IQNA
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie:

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": "7501e58e-266e-4e43-88e0-fdf19618fd0e"
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2NiIsImVtYWlsIjoiZW1haWwtMjY4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjY2MzM5MjF9._K41MU9Ab8GI6-cDedT3cN9cbJrikyMguy_eWf6IQNA" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "d8ca5e05-6612-46e2-ba3a-b5c4be5c9621",
    "url": "/v2/service_plans/d8ca5e05-6612-46e2-ba3a-b5c4be5c9621",
    "created_at": "2015-03-10T23:12:01Z",
    "updated_at": null
  },
  "entity": {
    "name": "100mb",
    "free": true,
    "description": "Let's you put data in your database!",
    "service_guid": "7501e58e-266e-4e43-88e0-fdf19618fd0e",
    "extra": null,
    "unique_id": "40a9806a-a25f-4d49-a4d1-6250fe127527",
    "public": true,
    "active": true,
    "service_url": "/v2/services/7501e58e-266e-4e43-88e0-fdf19618fd0e",
    "service_instances_url": "/v2/service_plans/d8ca5e05-6612-46e2-ba3a-b5c4be5c9621/service_instances"
  }
}

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/service_plans/d8ca5e05-6612-46e2-ba3a-b5c4be5c9621
X-VCAP-Request-ID: e34e6110-1ebf-47d6-b671-554b750378c4
Content-Length: 678
X-Content-Type-Options: nosniff