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.eyJ1c2VyX2lkIjoidWFhLWlkLTQyNCIsImVtYWlsIjoiZW1haWwtMjg2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg5MDJ9.0-FCaIs6ZZtpeUMoX2Lym__LPGOF2-MQxVh5hSijy9w
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/route_mappings" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQyNCIsImVtYWlsIjoiZW1haWwtMjg2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg5MDJ9.0-FCaIs6ZZtpeUMoX2Lym__LPGOF2-MQxVh5hSijy9w" \
	-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": "63603ed7-bd4a-4475-a371-5b34381e0cf7",
        "url": "/v2/route_mappings/63603ed7-bd4a-4475-a371-5b34381e0cf7",
        "created_at": "2016-06-08T16:41:42Z",
        "updated_at": "2016-06-08T16:41:26Z"
      },
      "entity": {
        "app_port": 8888,
        "app_guid": "ee8b175a-2228-4931-be8a-1f6445bd63bc",
        "route_guid": "eb1c4fcd-7d6d-41d2-bd2f-5811f53b6677",
        "app_url": "/v2/apps/ee8b175a-2228-4931-be8a-1f6445bd63bc",
        "route_url": "/v2/routes/eb1c4fcd-7d6d-41d2-bd2f-5811f53b6677"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a45d25b7-8742-46a5-94d5-7308ab954270
Content-Length: 663
X-Content-Type-Options: nosniff