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/500e64c6-7f70-4e3b-ab7b-940a6303d79b/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, 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.eyJ1c2VyX2lkIjoidWFhLWlkLTE4NyIsImVtYWlsIjoiZW1haWwtMTQyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTN9.tYqFHTLODYlhXdMUxKY5K2mIV0TWpGrtl6eO2tAGQ_Q
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances/500e64c6-7f70-4e3b-ab7b-940a6303d79b/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4NyIsImVtYWlsIjoiZW1haWwtMTQyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTN9.tYqFHTLODYlhXdMUxKY5K2mIV0TWpGrtl6eO2tAGQ_Q" \
	-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": "d6e18af9-9d84-4a53-a301-ab9bef03a7b0",
        "url": "/v2/routes/d6e18af9-9d84-4a53-a301-ab9bef03a7b0",
        "created_at": "2016-06-08T16:41:33Z",
        "updated_at": "2016-06-08T16:41:33Z"
      },
      "entity": {
        "host": "host-24",
        "path": "",
        "domain_guid": "428b9275-47a6-481b-97e3-d93ae18611ee",
        "space_guid": "dc7dd379-1ffb-4168-b2b4-773fe141dd2e",
        "service_instance_guid": "500e64c6-7f70-4e3b-ab7b-940a6303d79b",
        "port": null,
        "domain_url": "/v2/private_domains/428b9275-47a6-481b-97e3-d93ae18611ee",
        "space_url": "/v2/spaces/dc7dd379-1ffb-4168-b2b4-773fe141dd2e",
        "service_instance_url": "/v2/user_provided_service_instances/500e64c6-7f70-4e3b-ab7b-940a6303d79b",
        "apps_url": "/v2/routes/d6e18af9-9d84-4a53-a301-ab9bef03a7b0/apps",
        "route_mappings_url": "/v2/routes/d6e18af9-9d84-4a53-a301-ab9bef03a7b0/route_mappings"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 104c47da-03c8-424c-b54a-fda696e8bca1
Content-Length: 1086
X-Content-Type-Options: nosniff