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/0d4ff568-8800-4e05-85c8-d5e533bfb323/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.eyJ1c2VyX2lkIjoidWFhLWlkLTE5OCIsImVtYWlsIjoiZW1haWwtMTMwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NTJ9.i0PzWeIhJaCOx4xB0YECNfbYpoeXX9jWmm4CZ_93Ezg
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/services/0d4ff568-8800-4e05-85c8-d5e533bfb323/service_plans" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5OCIsImVtYWlsIjoiZW1haWwtMTMwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NTJ9.i0PzWeIhJaCOx4xB0YECNfbYpoeXX9jWmm4CZ_93Ezg" \
	-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": "e846ce0a-c42f-453d-97ca-b81743a259fc",
        "url": "/v2/service_plans/e846ce0a-c42f-453d-97ca-b81743a259fc",
        "created_at": "2015-03-20T18:27:32Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1268",
        "free": false,
        "description": "desc-81",
        "service_guid": "0d4ff568-8800-4e05-85c8-d5e533bfb323",
        "extra": null,
        "unique_id": "53215f00-b90d-43c8-b5e4-84b72c07b3e0",
        "public": true,
        "active": true,
        "service_url": "/v2/services/0d4ff568-8800-4e05-85c8-d5e533bfb323",
        "service_instances_url": "/v2/service_plans/e846ce0a-c42f-453d-97ca-b81743a259fc/service_instances"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 5f953992-27ff-43af-bfb1-855d39db41be
Content-Length: 841
X-Content-Type-Options: nosniff