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

Request

Route

GET /v2/user_provided_service_instances

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: 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.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MCIsImVtYWlsIjoiZW1haWwtOThAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MTQxMzY4M30.VOqax1QZ7zou4i9ZsIwcHH_44JjsNHV8LOhPy7JoLbk
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MCIsImVtYWlsIjoiZW1haWwtOThAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MTQxMzY4M30.VOqax1QZ7zou4i9ZsIwcHH_44JjsNHV8LOhPy7JoLbk" \
	-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": "4323a7e4-1a65-47a8-b6ca-21ae223e5fd1",
        "url": "/v2/user_provided_service_instances/4323a7e4-1a65-47a8-b6ca-21ae223e5fd1",
        "created_at": "2015-12-22T18:28:03Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-520",
        "credentials": {
          "creds-key-214": "creds-val-214"
        },
        "space_guid": "3acd23b9-658a-4cd2-8eb6-1499df1c99f3",
        "type": "user_provided_service_instance",
        "syslog_drain_url": "https://foo.com/url-27",
        "route_service_url": null,
        "space_url": "/v2/spaces/3acd23b9-658a-4cd2-8eb6-1499df1c99f3",
        "service_bindings_url": "/v2/user_provided_service_instances/4323a7e4-1a65-47a8-b6ca-21ae223e5fd1/service_bindings",
        "routes_url": "/v2/user_provided_service_instances/4323a7e4-1a65-47a8-b6ca-21ae223e5fd1/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 1002
X-Content-Type-Options: nosniff