Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/40f40f9b-48ed-4588-a52c-8d782b10a600/routes

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, organization_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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3NCIsImVtYWlsIjoiZW1haWwtMjA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjY2MzM5MTJ9.SysWnR66nacgTiyG02XsIEjIYYBZTVvR1wmLUfYuwv4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/40f40f9b-48ed-4588-a52c-8d782b10a600/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3NCIsImVtYWlsIjoiZW1haWwtMjA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjY2MzM5MTJ9.SysWnR66nacgTiyG02XsIEjIYYBZTVvR1wmLUfYuwv4" \
	-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": "ac77e186-c6d0-4ef7-b972-b2597642014c",
        "url": "/v2/routes/ac77e186-c6d0-4ef7-b972-b2597642014c",
        "created_at": "2015-03-10T23:11:52Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-17",
        "domain_guid": "2575a74d-2b1b-444e-9a1c-0fde65773e23",
        "space_guid": "98d70184-05d0-44a2-8c1d-d6535f863593",
        "domain_url": "/v2/domains/2575a74d-2b1b-444e-9a1c-0fde65773e23",
        "space_url": "/v2/spaces/98d70184-05d0-44a2-8c1d-d6535f863593",
        "apps_url": "/v2/routes/ac77e186-c6d0-4ef7-b972-b2597642014c/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a3ae896d-6244-4ae3-a758-56ed9bbb03aa
Content-Length: 741
X-Content-Type-Options: nosniff