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/8c2f10f2-9f50-4392-8ed2-87cd17329192/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.eyJ1c2VyX2lkIjoidWFhLWlkLTQyMSIsImVtYWlsIjoiZW1haWwtMjgzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3Mjh9.J3fZvk6d0emW2QFbbcqy6msNaFuWTYWgFgEQibX4BHI
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/routes/8c2f10f2-9f50-4392-8ed2-87cd17329192/route_mappings" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQyMSIsImVtYWlsIjoiZW1haWwtMjgzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3Mjh9.J3fZvk6d0emW2QFbbcqy6msNaFuWTYWgFgEQibX4BHI" \
	-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": "45b46812-5c49-4b6e-a4e6-e0810e77ec05",
        "url": "/v2/route_mappings/45b46812-5c49-4b6e-a4e6-e0810e77ec05",
        "created_at": "2016-05-12T00:45:28Z",
        "updated_at": null
      },
      "entity": {
        "app_port": null,
        "app_guid": "cd6e5b4c-28c6-41be-92dc-1d37b7afe979",
        "route_guid": "8c2f10f2-9f50-4392-8ed2-87cd17329192",
        "app_url": "/v2/apps/cd6e5b4c-28c6-41be-92dc-1d37b7afe979",
        "route_url": "/v2/routes/8c2f10f2-9f50-4392-8ed2-87cd17329192"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 608854b3-e6ce-4fd5-a2fd-fbe6764ce3df
Content-Length: 663
X-Content-Type-Options: nosniff