GET /v2/service_plans
Name | Description | Valid Values | Example Values |
---|---|---|---|
q |
Parameters used to filter the result set. Format queries as <filter><op><value> Valid ops: : >= <= < > IN Valid filters: active, service_guid, service_instance_guid, service_broker_guid |
|
|
page | Page of results to fetch |
|
|
results-per-page | Number of results per page |
|
|
order-direction | Order of the results: asc (default) or desc |
|
|
inline-relations-depth | 0 - don't inline any relations and return URLs. Otherwise, inline to depth N. |
|
|
orphan-relations | 0 - de-duplicate object entries in response |
|
|
exclude-relations | comma-delimited list of relations to drop from response |
|
|
include-relations | comma-delimited list of the only relations to include in response |
|
|
Name | Description | Default | Valid Values | Example Values |
---|---|---|---|---|
guid | The guid of the service plan |
|
|
|
name | The name of the service plan |
|
|
|
free | A boolean describing if the service plan is free |
|
|
|
description | A description of the service plan |
|
|
|
extra | A JSON string with additional data about the plan |
|
|
|
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 |
|
|
|
active | A boolean that determines whether plans can be used to create new instances. |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzMiIsImVtYWlsIjoiZW1haWwtMjU5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2NDV9.GjQO6_Gu_m4RWG47AuMZJDjGCs9O7ZGcX5uWKk-WU-c Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/service_plans" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzMiIsImVtYWlsIjoiZW1haWwtMjU5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2NDV9.GjQO6_Gu_m4RWG47AuMZJDjGCs9O7ZGcX5uWKk-WU-c" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "17c8c569-63a9-4c76-8d43-77b98b5c34dc", "url": "/v2/service_plans/17c8c569-63a9-4c76-8d43-77b98b5c34dc", "created_at": "2015-05-07T23:37:25Z", "updated_at": null }, "entity": { "name": "name-2021", "free": false, "description": "desc-209", "service_guid": "e775d44f-a0d4-4173-b51b-2f5f2ed4ec65", "extra": null, "unique_id": "47e4acd8-9880-4a3a-9a28-7d0be87e7aad", "public": true, "active": true, "service_url": "/v2/services/e775d44f-a0d4-4173-b51b-2f5f2ed4ec65", "service_instances_url": "/v2/service_plans/17c8c569-63a9-4c76-8d43-77b98b5c34dc/service_instances" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: febefbae-18c0-41bd-8b20-915718199ee9 Content-Length: 842 X-Content-Type-Options: nosniff