Home
Version 3
Service Plans API

Service Plans API

Updating a Service Plan (deprecated)

PUT /v2/service_plans

Request

Route

PUT /v2/service_plans/226bb36c-141c-4c67-9609-af71b5d3c598

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": "ff0a7cac-86b2-478d-8dd5-12b48f3cdd6b"
}

Headers

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

cURL

curl "https://api.[your-domain.com]/v2/service_plans/226bb36c-141c-4c67-9609-af71b5d3c598" -d '{
  "name": "100mb",
  "free": true,
  "description": "Let\u0027s you put data in your database!",
  "service_guid": "ff0a7cac-86b2-478d-8dd5-12b48f3cdd6b"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzMCIsImVtYWlsIjoiZW1haWwtMTM0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NDZ9.KFFXHW9GF2rrG2Cl7GglniCy0zVJl9qtFRZHcIrPfp8" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "226bb36c-141c-4c67-9609-af71b5d3c598",
    "url": "/v2/service_plans/226bb36c-141c-4c67-9609-af71b5d3c598",
    "created_at": "2015-10-15T23:52:26Z",
    "updated_at": "2015-10-15T23:52:26Z"
  },
  "entity": {
    "name": "100mb",
    "free": true,
    "description": "Let's you put data in your database!",
    "service_guid": "ff0a7cac-86b2-478d-8dd5-12b48f3cdd6b",
    "extra": null,
    "unique_id": "6a21b7a3-5d42-4861-b316-766a39b1e229",
    "public": true,
    "active": true,
    "service_url": "/v2/services/ff0a7cac-86b2-478d-8dd5-12b48f3cdd6b",
    "service_instances_url": "/v2/service_plans/226bb36c-141c-4c67-9609-af71b5d3c598/service_instances"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: cf14111d-fafc-49f3-8906-f311241ab380
Content-Length: 696
X-Content-Type-Options: nosniff