Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Fields

Name Description Default Valid Values Example Values

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
  • 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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3OSIsImVtYWlsIjoiZW1haWwtMjA0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MTJ9.UqHFD_qIHfrIP7ogI3IQPVrL2yEoTNTQhO3GjlxbpmQ
Host: example.org
Cookie: 

Route

GET /v2/apps/bec556d7-fa77-490d-99a2-6709089ea7ca/routes

cURL

curl "https://api.[your-domain.com]/v2/apps/bec556d7-fa77-490d-99a2-6709089ea7ca/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3OSIsImVtYWlsIjoiZW1haWwtMjA0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MTJ9.UqHFD_qIHfrIP7ogI3IQPVrL2yEoTNTQhO3GjlxbpmQ" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 58f4c354-2eb8-4323-a8f4-2c878e769b69
Content-Length: 745
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "ba265ff7-6940-40b2-8e63-9a58cf21a255",
        "url": "/v2/routes/ba265ff7-6940-40b2-8e63-9a58cf21a255",
        "created_at": "2014-11-13T23:38:31+00:00",
        "updated_at": null
      },
      "entity": {
        "host": "host-4",
        "domain_guid": "b83c4782-a23b-4d7e-9b77-028356f9155e",
        "space_guid": "be0df738-9a56-4e4d-99e7-a99c94fade40",
        "domain_url": "/v2/domains/b83c4782-a23b-4d7e-9b77-028356f9155e",
        "space_url": "/v2/spaces/be0df738-9a56-4e4d-99e7-a99c94fade40",
        "apps_url": "/v2/routes/ba265ff7-6940-40b2-8e63-9a58cf21a255/apps"
      }
    }
  ]
}