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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMiLCJlbWFpbCI6ImVtYWlsLTNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MzYxODcwM30.V36KQtR9onJhMb1XuK2fFzeG4EE8G_TFMARfjjWev44
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/route_mappings" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMiLCJlbWFpbCI6ImVtYWlsLTNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MzYxODcwM30.V36KQtR9onJhMb1XuK2fFzeG4EE8G_TFMARfjjWev44" \
	-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": "b00b43ee-95ec-4389-8db2-c4343b81a015",
        "url": "/v2/route_mappings/b00b43ee-95ec-4389-8db2-c4343b81a015",
        "created_at": "2016-05-12T00:45:03Z",
        "updated_at": null
      },
      "entity": {
        "app_port": 8888,
        "app_guid": "3c982d9b-7baa-48fc-aa41-01fa45cadff7",
        "route_guid": "18b03720-3272-44b0-a839-83500d0f8632",
        "app_url": "/v2/apps/3c982d9b-7baa-48fc-aa41-01fa45cadff7",
        "route_url": "/v2/routes/18b03720-3272-44b0-a839-83500d0f8632"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 8755b8c3-c93d-42c8-aada-5e93498fddbc
Content-Length: 663
X-Content-Type-Options: nosniff