Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/28e68151-cce6-4b35-9100-be28aed24dfd/routes

Parameters

Name Description Valid Values Example Values
guid The guid of the App
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: host, domain_guid, path, port
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTE1NSIsImVtYWlsIjoiZW1haWwtMTIzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTgzOTl9.f15HjyhA-md28rbA_1-V1Zex9aH6Sf7bBamoygEhBcg
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/apps/28e68151-cce6-4b35-9100-be28aed24dfd/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1NSIsImVtYWlsIjoiZW1haWwtMTIzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTgzOTl9.f15HjyhA-md28rbA_1-V1Zex9aH6Sf7bBamoygEhBcg" \
	-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": "5d1f2a35-e101-413c-9e71-6101a02dcc33",
        "url": "/v2/routes/5d1f2a35-e101-413c-9e71-6101a02dcc33",
        "created_at": "2016-04-22T19:33:19Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-2",
        "path": "",
        "domain_guid": "eed10c0e-7027-4b51-801e-572774c63d19",
        "space_guid": "a0478040-d041-4e8a-b8c1-bb4ea4fb2b30",
        "service_instance_guid": null,
        "port": null,
        "domain_url": "/v2/domains/eed10c0e-7027-4b51-801e-572774c63d19",
        "space_url": "/v2/spaces/a0478040-d041-4e8a-b8c1-bb4ea4fb2b30",
        "apps_url": "/v2/routes/5d1f2a35-e101-413c-9e71-6101a02dcc33/apps",
        "route_mappings_url": "/v2/routes/5d1f2a35-e101-413c-9e71-6101a02dcc33/route_mappings"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 2ded24c9-9394-4f69-ae1e-dc9e08d4b629
Content-Length: 917
X-Content-Type-Options: nosniff