Home
Version 3
User Provided Service Instances API

User Provided Service Instances API

List all User Provided Service Instances

GET /v2/user_provided_service_instances

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OCIsImVtYWlsIjoiZW1haWwtMjA5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4Nzl9.aLyxZGFBRpBwWfN9AIz_-Yp_yJp-tZAeSHjTVNsIaf0
Host: example.org
Cookie: 

Route

GET /v2/user_provided_service_instances

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OCIsImVtYWlsIjoiZW1haWwtMjA5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4Nzl9.aLyxZGFBRpBwWfN9AIz_-Yp_yJp-tZAeSHjTVNsIaf0" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 5f2525bc-71f7-493a-b104-2af5c9d0de17
Content-Length: 863
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "5750ccbf-e232-41ab-b32e-aba3ed756616",
        "url": "/v2/user_provided_service_instances/5750ccbf-e232-41ab-b32e-aba3ed756616",
        "created_at": "2015-01-27T19:14:39Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1596",
        "credentials": {
          "creds-key-465": "creds-val-465"
        },
        "space_guid": "fb95efb7-f40f-4514-afa9-89264ddd5512",
        "type": "user_provided_service_instance",
        "syslog_drain_url": "https://foo.com/url-99",
        "space_url": "/v2/spaces/fb95efb7-f40f-4514-afa9-89264ddd5512",
        "service_bindings_url": "/v2/user_provided_service_instances/5750ccbf-e232-41ab-b32e-aba3ed756616/service_bindings"
      }
    }
  ]
}