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.

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2MCIsImVtYWlsIjoiZW1haWwtMTg1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDR9.qun8HTnkYwLe-YqW6tIwrKqOuvGHikz2RFk1BmBTxpo
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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2MCIsImVtYWlsIjoiZW1haWwtMTg1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDR9.qun8HTnkYwLe-YqW6tIwrKqOuvGHikz2RFk1BmBTxpo" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: e129cd37-fefd-4338-8c0c-6ec0d53dcc85
Content-Length: 867
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "eede4c3e-434b-4759-94c7-ba8f4ca5df05",
        "url": "/v2/user_provided_service_instances/eede4c3e-434b-4759-94c7-ba8f4ca5df05",
        "created_at": "2014-11-05T01:02:24+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-863",
        "credentials": {
          "creds-key-397": "creds-val-397"
        },
        "space_guid": "d435bbe3-c435-4d3c-a66f-37f79a3467f2",
        "type": "user_provided_service_instance",
        "syslog_drain_url": "https://foo.com/url-60",
        "space_url": "/v2/spaces/d435bbe3-c435-4d3c-a66f-37f79a3467f2",
        "service_bindings_url": "/v2/user_provided_service_instances/eede4c3e-434b-4759-94c7-ba8f4ca5df05/service_bindings"
      }
    }
  ]
}