User Provided Service Instances API

List all User Provided Service Instances

GET /v2/user_provided_service_instances

Request

Route

GET /v2/user_provided_service_instances

Parameters

Name	Description	Example Values
q	Parameters used to filter the result set. Format queries as <filter><op><value> Valid ops: : >= <= < > IN Valid filters: name, space_guid, organization_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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyOSIsImVtYWlsIjoiZW1haWwtMjMxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2NDB9.0ShM6wfaHVYReW6Bl6kNi0uxS9EXosMkUJ9QQ7qlK5E
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyOSIsImVtYWlsIjoiZW1haWwtMjMxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2NDB9.0ShM6wfaHVYReW6Bl6kNi0uxS9EXosMkUJ9QQ7qlK5E" \
	-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": "3a6f0605-beb6-45ed-8a71-2b765486a4d6",
        "url": "/v2/user_provided_service_instances/3a6f0605-beb6-45ed-8a71-2b765486a4d6",
        "created_at": "2016-04-16T01:24:00Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1071",
        "credentials": {
          "creds-key-53": "creds-val-53"
        },
        "space_guid": "590c3935-edd7-4dc7-a5b6-831749c7956c",
        "type": "user_provided_service_instance",
        "syslog_drain_url": "https://foo.com/url-66",
        "route_service_url": null,
        "space_url": "/v2/spaces/590c3935-edd7-4dc7-a5b6-831749c7956c",
        "service_bindings_url": "/v2/user_provided_service_instances/3a6f0605-beb6-45ed-8a71-2b765486a4d6/service_bindings",
        "routes_url": "/v2/user_provided_service_instances/3a6f0605-beb6-45ed-8a71-2b765486a4d6/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 1d7d7b85-367b-4d28-94fd-568e25f51e56
Content-Length: 1001
X-Content-Type-Options: nosniff