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.eyJ1c2VyX2lkIjoidWFhLWlkLTIyNiIsImVtYWlsIjoiZW1haWwtMTY3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDd9.OUaxFnfRhy4ON9kC855FrWzUZQ_powbXToq_ECGqhJE
Host: example.org
Cookie: 

Route

GET /v2/apps/631d79f9-298a-445f-b44d-1ea720c2d0f7/routes

cURL

curl "https://api.[your-domain.com]/v2/apps/631d79f9-298a-445f-b44d-1ea720c2d0f7/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyNiIsImVtYWlsIjoiZW1haWwtMTY3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDd9.OUaxFnfRhy4ON9kC855FrWzUZQ_powbXToq_ECGqhJE" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c53ad2c2-f370-41bc-acc3-c0eb7366168e
Content-Length: 746
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "080da1d8-b41b-491a-ad52-ee916cf1f4ba",
        "url": "/v2/routes/080da1d8-b41b-491a-ad52-ee916cf1f4ba",
        "created_at": "2015-01-20T01:52:26+00:00",
        "updated_at": null
      },
      "entity": {
        "host": "host-13",
        "domain_guid": "62e51ff6-53f8-474a-a74b-d581ae5d6ead",
        "space_guid": "0a08f82c-42a4-4859-b6a0-f4cc6fa96e67",
        "domain_url": "/v2/domains/62e51ff6-53f8-474a-a74b-d581ae5d6ead",
        "space_url": "/v2/spaces/0a08f82c-42a4-4859-b6a0-f4cc6fa96e67",
        "apps_url": "/v2/routes/080da1d8-b41b-491a-ad52-ee916cf1f4ba/apps"
      }
    }
  ]
}