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.eyJ1c2VyX2lkIjoidWFhLWlkLTI3OSIsImVtYWlsIjoiZW1haWwtMjE5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4ODB9.4Dc02D4H56QsALQDrWWYu1lU8yusqdLrJaDVnZsA5x4
Host: example.org
Cookie: 

Route

GET /v2/apps/18749304-8ee2-4ebe-8688-9d07f7d2f478/routes

cURL

curl "https://api.[your-domain.com]/v2/apps/18749304-8ee2-4ebe-8688-9d07f7d2f478/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3OSIsImVtYWlsIjoiZW1haWwtMjE5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4ODB9.4Dc02D4H56QsALQDrWWYu1lU8yusqdLrJaDVnZsA5x4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6d45e982-7f27-4ebe-a905-1144ea0c7558
Content-Length: 741
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "eefee152-c459-4021-b16f-974480babf84",
        "url": "/v2/routes/eefee152-c459-4021-b16f-974480babf84",
        "created_at": "2015-01-27T19:14:40Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-18",
        "domain_guid": "9b57abfc-e20b-495e-bc38-c7e7439bf439",
        "space_guid": "575e08ed-6f51-4160-8580-3dd023692fe2",
        "domain_url": "/v2/domains/9b57abfc-e20b-495e-bc38-c7e7439bf439",
        "space_url": "/v2/spaces/575e08ed-6f51-4160-8580-3dd023692fe2",
        "apps_url": "/v2/routes/eefee152-c459-4021-b16f-974480babf84/apps"
      }
    }
  ]
}