Home
Version 3
Services API

Services API

List all Service Plans for the Service

GET /v2/services/:guid/service_plans

Request

Route

GET /v2/services/7bb83cd5-c3b7-4ff1-acc8-a49f9cec39eb/service_plans

Parameters

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
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
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

Body

Name Description Default Valid Values Example Values
guid The guid of the Service.

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4MSIsImVtYWlsIjoiZW1haWwtMjgyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MjF9.Njqb6oT_hHL4iheXXeX9Eebzt4TLRb0ZQ5HOqkz_2yQ
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/services/7bb83cd5-c3b7-4ff1-acc8-a49f9cec39eb/service_plans" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4MSIsImVtYWlsIjoiZW1haWwtMjgyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MjF9.Njqb6oT_hHL4iheXXeX9Eebzt4TLRb0ZQ5HOqkz_2yQ" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "9668b71a-7101-4b0d-be2d-b663b18061a2",
        "url": "/v2/service_plans/9668b71a-7101-4b0d-be2d-b663b18061a2",
        "created_at": "2015-04-07T19:12:01Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2078",
        "free": false,
        "description": "desc-181",
        "service_guid": "7bb83cd5-c3b7-4ff1-acc8-a49f9cec39eb",
        "extra": null,
        "unique_id": "7c598b38-0d82-4f5a-8bbc-3dd33fc12dd6",
        "public": true,
        "active": true,
        "service_url": "/v2/services/7bb83cd5-c3b7-4ff1-acc8-a49f9cec39eb",
        "service_instances_url": "/v2/service_plans/9668b71a-7101-4b0d-be2d-b663b18061a2/service_instances"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7cb127f9-79a3-402e-bc4e-f29850eb0687
Content-Length: 842
X-Content-Type-Options: nosniff