Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/34dc253d-9d08-4e97-b540-e2d59b0c6b04/routes?route_guid=4e935b8b-951e-478d-bd34-baabc1e585d0

Parameters

Name Description Valid Values Example Values
guid The guid of the App
route_guid The guid of the route
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: host, domain_guid, organization_guid, path
  • 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
route_guid: 4e935b8b-951e-478d-bd34-baabc1e585d0

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzNSIsImVtYWlsIjoiZW1haWwtMTYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzg2NDE3OTl9.lsEp-0v67XUpnXYM0bBo81W3nCEEyurlFA2Rksd60sM
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/34dc253d-9d08-4e97-b540-e2d59b0c6b04/routes?route_guid=4e935b8b-951e-478d-bd34-baabc1e585d0" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzNSIsImVtYWlsIjoiZW1haWwtMTYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzg2NDE3OTl9.lsEp-0v67XUpnXYM0bBo81W3nCEEyurlFA2Rksd60sM" \
	-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": "ea95782f-e852-42a1-83dd-7d266ad9f32d",
        "url": "/v2/routes/ea95782f-e852-42a1-83dd-7d266ad9f32d",
        "created_at": "2015-07-27T22:43:19Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-14",
        "path": "",
        "domain_guid": "1f36d1d3-fcba-49dc-9320-d60ead679d35",
        "space_guid": "dd314ba4-3690-48d1-becb-25abe5da801c",
        "domain_url": "/v2/domains/1f36d1d3-fcba-49dc-9320-d60ead679d35",
        "space_url": "/v2/spaces/dd314ba4-3690-48d1-becb-25abe5da801c",
        "apps_url": "/v2/routes/ea95782f-e852-42a1-83dd-7d266ad9f32d/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 64f9e061-5853-423f-b9e4-a6322c6ad284
Content-Length: 761
X-Content-Type-Options: nosniff