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.eyJ1c2VyX2lkIjoidWFhLWlkLTEyOSIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDQ3MTY5MX0.ugSpEsGr7I_6NgE7WfHm1GbAXATmEY3hFKbnKBUSkWQ
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.eyJ1c2VyX2lkIjoidWFhLWlkLTEyOSIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDQ3MTY5MX0.ugSpEsGr7I_6NgE7WfHm1GbAXATmEY3hFKbnKBUSkWQ" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 435e7be7-9348-46fa-be47-69d60442e4b7
Content-Length: 862
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "22e0ef9f-b9e7-4a3b-916e-9b448fbf7e5c",
        "url": "/v2/user_provided_service_instances/22e0ef9f-b9e7-4a3b-916e-9b448fbf7e5c",
        "created_at": "2015-02-13T22:34:51Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-357",
        "credentials": {
          "creds-key-196": "creds-val-196"
        },
        "space_guid": "b64874b4-c3e6-4ec2-86da-5eb503cbaf33",
        "type": "user_provided_service_instance",
        "syslog_drain_url": "https://foo.com/url-10",
        "space_url": "/v2/spaces/b64874b4-c3e6-4ec2-86da-5eb503cbaf33",
        "service_bindings_url": "/v2/user_provided_service_instances/22e0ef9f-b9e7-4a3b-916e-9b448fbf7e5c/service_bindings"
      }
    }
  ]
}