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/49044851-a214-4169-917e-6ccc092e3b09/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

Body

Name Description Default Valid Values Example Values
route_guid The guid of the route

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MyIsImVtYWlsIjoiZW1haWwtMTAxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2ODN9.6hc-oVXJRvH2GIDG85T96MNbXaUwZPuV6BLLmX_nmTY
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances/49044851-a214-4169-917e-6ccc092e3b09/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MyIsImVtYWlsIjoiZW1haWwtMTAxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2ODN9.6hc-oVXJRvH2GIDG85T96MNbXaUwZPuV6BLLmX_nmTY" \
	-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": "e2f5b08a-94ff-4182-a3ed-9e74a88505be",
        "url": "/v2/routes/e2f5b08a-94ff-4182-a3ed-9e74a88505be",
        "created_at": "2015-12-22T18:28:03Z",
        "updated_at": "2015-12-22T18:28:03Z"
      },
      "entity": {
        "host": "host-15",
        "path": "",
        "domain_guid": "ea7a71fd-fd7d-42a9-b45f-3806df03fda8",
        "space_guid": "abf534cb-da1f-45f7-839d-4d33a994d173",
        "service_instance_guid": "49044851-a214-4169-917e-6ccc092e3b09",
        "port": 0,
        "domain_url": "/v2/domains/ea7a71fd-fd7d-42a9-b45f-3806df03fda8",
        "space_url": "/v2/spaces/abf534cb-da1f-45f7-839d-4d33a994d173",
        "service_instance_url": "/v2/user_provided_service_instances/49044851-a214-4169-917e-6ccc092e3b09",
        "apps_url": "/v2/routes/e2f5b08a-94ff-4182-a3ed-9e74a88505be/apps"
      }
    }
  ]
}

Headers

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