Home
Version 3
Routes Mapping API

Routes Mapping API

List all Route Mappings

GET /v2/route_mappings

Request

Route

GET /v2/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
  • 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
app_guid The guid of the bound application.
  • guid-77cfb0d2-bed5-436f-b9a7-a734da5cf571
route_guid The guid of the bound route.
  • guid-45b46c81-7f75-4b7f-b5f9-5fafcf46c0b2
app_port Port on which the application should listen, and to which requests for the mapped route will be routed. Must be among those already configured for the app. If a port is not specified when mapping the route, the first one in the list of those configured for the app will be chosen.

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTgxIiwiZW1haWwiOiJlbWFpbC04MEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU2NDUyMjI3fQ.c-q30aoIF-dz7rqg3AnZ6hTZwCmoXuduuh0ezaIrdbk
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/route_mappings" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTgxIiwiZW1haWwiOiJlbWFpbC04MEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU2NDUyMjI3fQ.c-q30aoIF-dz7rqg3AnZ6hTZwCmoXuduuh0ezaIrdbk" \
	-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": "2c7e01f0-b86a-4de1-918c-04954f0d1423",
        "url": "/v2/route_mappings/2c7e01f0-b86a-4de1-918c-04954f0d1423",
        "created_at": "2016-02-19T02:03:47Z",
        "updated_at": null
      },
      "entity": {
        "app_port": 8888,
        "app_guid": "21a4b9cf-7527-472e-853b-0e072ba9a12b",
        "route_guid": "db02f7f1-c4aa-478a-98ca-ff3e4eb53fce",
        "app_url": "/v2/apps/21a4b9cf-7527-472e-853b-0e072ba9a12b",
        "route_url": "/v2/routes/db02f7f1-c4aa-478a-98ca-ff3e4eb53fce"
      }
    }
  ]
}

Headers

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