Home
Version 3
Routes API

Routes API

List all Route Mappings for the Route

GET /v2/routes/:guid/route_mappings

Request

Route

GET /v2/routes/e8842b01-26ad-40d3-9ff7-0b17bb08ad67/route_mappings

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: app_guid, route_guid
(Note that filtering on route_guid will return an empty list if you specify anything other than the guid included in the path.)
  • 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
guid The guid of the route.

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1MiIsImVtYWlsIjoiZW1haWwtMjU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2NDJ9.SkyfVtLyaU6Ea0gXXZyKWrA5ckJpvFxGMRLa5h5rFk0
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/routes/e8842b01-26ad-40d3-9ff7-0b17bb08ad67/route_mappings" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1MiIsImVtYWlsIjoiZW1haWwtMjU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2NDJ9.SkyfVtLyaU6Ea0gXXZyKWrA5ckJpvFxGMRLa5h5rFk0" \
	-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": "4b032cef-203f-4080-9367-eb902e93f43a",
        "url": "/v2/route_mappings/4b032cef-203f-4080-9367-eb902e93f43a",
        "created_at": "2016-04-16T01:24:02Z",
        "updated_at": null
      },
      "entity": {
        "app_port": null,
        "app_guid": "39432f88-2e5a-4447-bc75-91423059d789",
        "route_guid": "e8842b01-26ad-40d3-9ff7-0b17bb08ad67",
        "app_url": "/v2/apps/39432f88-2e5a-4447-bc75-91423059d789",
        "route_url": "/v2/routes/e8842b01-26ad-40d3-9ff7-0b17bb08ad67"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7bb5c93e-f809-4862-9ca5-4e4be6428824
Content-Length: 663
X-Content-Type-Options: nosniff