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/3716d95d-da82-4f1a-a6fc-e75f5f86c600/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.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMiIsImVtYWlsIjoiZW1haWwtMjI0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTg0MDd9.ftz1xvdpmCB1ORzpJakP2ib_y25QT-2KuFlSYQJ4ByU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances/3716d95d-da82-4f1a-a6fc-e75f5f86c600/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMiIsImVtYWlsIjoiZW1haWwtMjI0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTg0MDd9.ftz1xvdpmCB1ORzpJakP2ib_y25QT-2KuFlSYQJ4ByU" \
	-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": "1866ff2c-7280-4a41-b5e6-4a4b48b31dd7",
        "url": "/v2/routes/1866ff2c-7280-4a41-b5e6-4a4b48b31dd7",
        "created_at": "2016-04-22T19:33:27Z",
        "updated_at": "2016-04-22T19:33:27Z"
      },
      "entity": {
        "host": "host-20",
        "path": "",
        "domain_guid": "7bce3d3d-8a20-4a82-8413-c2119b39f152",
        "space_guid": "b262c78e-0641-4ade-bb91-3293549c6468",
        "service_instance_guid": "3716d95d-da82-4f1a-a6fc-e75f5f86c600",
        "port": null,
        "domain_url": "/v2/domains/7bce3d3d-8a20-4a82-8413-c2119b39f152",
        "space_url": "/v2/spaces/b262c78e-0641-4ade-bb91-3293549c6468",
        "service_instance_url": "/v2/user_provided_service_instances/3716d95d-da82-4f1a-a6fc-e75f5f86c600",
        "apps_url": "/v2/routes/1866ff2c-7280-4a41-b5e6-4a4b48b31dd7/apps",
        "route_mappings_url": "/v2/routes/1866ff2c-7280-4a41-b5e6-4a4b48b31dd7/route_mappings"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a2ece062-da27-424f-b6f8-b486cf3a5799
Content-Length: 1078
X-Content-Type-Options: nosniff