Home
Version 3
User Provided Service Instances API

User Provided Service Instances API

List all Routes for the User Provided Service Instance

GET /v2/user_provided_service_instances/:guid/routes

Request

Route

GET /v2/user_provided_service_instances/cb1340ee-1257-48c8-9680-e1967fafaa4d/routes

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: host, domain_guid, organization_guid, path, port
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTIwOSIsImVtYWlsIjoiZW1haWwtMTQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjA1MDY2NDd9.zPJ4tbw1Zt5lk_afU167wRFuZ99BLTT_g8LL0SEba64
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances/cb1340ee-1257-48c8-9680-e1967fafaa4d/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwOSIsImVtYWlsIjoiZW1haWwtMTQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjA1MDY2NDd9.zPJ4tbw1Zt5lk_afU167wRFuZ99BLTT_g8LL0SEba64" \
	-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": "165c7ed7-8efc-4f10-950b-ae18be52b1bb",
        "url": "/v2/routes/165c7ed7-8efc-4f10-950b-ae18be52b1bb",
        "created_at": "2016-04-06T00:17:27Z",
        "updated_at": "2016-04-06T00:17:27Z"
      },
      "entity": {
        "host": "host-9",
        "path": "",
        "domain_guid": "5d51de66-9a42-4aed-9756-26f1682d7802",
        "space_guid": "f70ea2c1-b8a4-4db4-b1e6-48dd78e451cd",
        "service_instance_guid": "cb1340ee-1257-48c8-9680-e1967fafaa4d",
        "port": 0,
        "domain_url": "/v2/domains/5d51de66-9a42-4aed-9756-26f1682d7802",
        "space_url": "/v2/spaces/f70ea2c1-b8a4-4db4-b1e6-48dd78e451cd",
        "service_instance_url": "/v2/user_provided_service_instances/cb1340ee-1257-48c8-9680-e1967fafaa4d",
        "apps_url": "/v2/routes/165c7ed7-8efc-4f10-950b-ae18be52b1bb/apps",
        "route_mappings_url": "/v2/routes/165c7ed7-8efc-4f10-950b-ae18be52b1bb/route_mappings"
      }
    }
  ]
}

Headers

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