Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/92913bcb-3215-4c65-8bfe-39db2133cf14/routes?route_guid=63f7bf14-664e-453f-b1f1-335f311d04cb

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: 63f7bf14-664e-453f-b1f1-335f311d04cb

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwNyIsImVtYWlsIjoiZW1haWwtMjI0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzY4Mjk3OTR9.l0JMvbl0XGFR8wqceeaKxsuj81-Fl3-BySgLylKjklU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/92913bcb-3215-4c65-8bfe-39db2133cf14/routes?route_guid=63f7bf14-664e-453f-b1f1-335f311d04cb" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwNyIsImVtYWlsIjoiZW1haWwtMjI0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzY4Mjk3OTR9.l0JMvbl0XGFR8wqceeaKxsuj81-Fl3-BySgLylKjklU" \
	-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": "895be659-ee9e-4428-a3e1-97b2f87fcfc5",
        "url": "/v2/routes/895be659-ee9e-4428-a3e1-97b2f87fcfc5",
        "created_at": "2015-07-06T23:23:14Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-12",
        "path": "",
        "domain_guid": "c2b1ae8a-a3cd-4b0a-b8d2-bb2b8e556f4f",
        "space_guid": "7d4e6ce4-c025-490f-9da8-86b0d64af130",
        "domain_url": "/v2/domains/c2b1ae8a-a3cd-4b0a-b8d2-bb2b8e556f4f",
        "space_url": "/v2/spaces/7d4e6ce4-c025-490f-9da8-86b0d64af130",
        "apps_url": "/v2/routes/895be659-ee9e-4428-a3e1-97b2f87fcfc5/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 894c142f-7412-4524-b0f9-cb84e8a9c536
Content-Length: 761
X-Content-Type-Options: nosniff