Home
Version 3
Services API

Services API

List all Service Plans for the Service

GET /v2/services/:guid/service_plans

Fields

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

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.

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3IiwiZW1haWwiOiJlbWFpbC0xN0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE1NzU0MTMwfQ.9lEWg0MF1B2nbRTVoyvhLj8gDbI-SDxEfHRKgg3LBM4
Host: example.org
Cookie: 

Route

GET /v2/services/7777260e-c23a-4c05-aec8-87aea3162b2e/service_plans

cURL

curl "https://api.[your-domain.com]/v2/services/7777260e-c23a-4c05-aec8-87aea3162b2e/service_plans" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3IiwiZW1haWwiOiJlbWFpbC0xN0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE1NzU0MTMwfQ.9lEWg0MF1B2nbRTVoyvhLj8gDbI-SDxEfHRKgg3LBM4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 093180df-16f4-4b65-8f5e-07da698b13bf
Content-Length: 844
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "af9908a4-1599-4d5c-a8f4-b2b7eabb79ec",
        "url": "/v2/service_plans/af9908a4-1599-4d5c-a8f4-b2b7eabb79ec",
        "created_at": "2014-11-05T01:02:10+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-76",
        "free": false,
        "description": "desc-33",
        "service_guid": "7777260e-c23a-4c05-aec8-87aea3162b2e",
        "extra": null,
        "unique_id": "5474ca07-f7ca-4696-aa01-922392d2fed1",
        "public": true,
        "active": true,
        "service_url": "/v2/services/7777260e-c23a-4c05-aec8-87aea3162b2e",
        "service_instances_url": "/v2/service_plans/af9908a4-1599-4d5c-a8f4-b2b7eabb79ec/service_instances"
      }
    }
  ]
}