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.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMCIsImVtYWlsIjoiZW1haWwtMTcxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg1OTk0NDF9.aOLAQCT8q5jZKibIL6pfW1ED0q4bf4U8Adb8p3I_hCM
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/route_mappings" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMCIsImVtYWlsIjoiZW1haWwtMTcxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg1OTk0NDF9.aOLAQCT8q5jZKibIL6pfW1ED0q4bf4U8Adb8p3I_hCM" \
	-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": "6f7934d6-648f-469b-955f-5873cb90b131",
        "url": "/v2/route_mappings/6f7934d6-648f-469b-955f-5873cb90b131",
        "created_at": "2016-03-14T22:30:41Z",
        "updated_at": null
      },
      "entity": {
        "app_port": 8888,
        "app_guid": "3e68ba88-55bf-485a-b740-024484269b7d",
        "route_guid": "5c41ed05-a06c-435c-9caf-ad25fe3d3617",
        "app_url": "/v2/apps/3e68ba88-55bf-485a-b740-024484269b7d",
        "route_url": "/v2/routes/5c41ed05-a06c-435c-9caf-ad25fe3d3617"
      }
    }
  ]
}

Headers

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