Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/17d4f6bc-663f-4458-9ac8-a24536e55263/routes?route_guid=33f6a309-ad23-42cc-9659-be1d89307393

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: 33f6a309-ad23-42cc-9659-be1d89307393

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2NyIsImVtYWlsIjoiZW1haWwtMTAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1MzN9.5a7HeHRYKbnai07tceslQhu3QW8gkPdszy59xf34sf4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/17d4f6bc-663f-4458-9ac8-a24536e55263/routes?route_guid=33f6a309-ad23-42cc-9659-be1d89307393" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2NyIsImVtYWlsIjoiZW1haWwtMTAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1MzN9.5a7HeHRYKbnai07tceslQhu3QW8gkPdszy59xf34sf4" \
	-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": "be86f999-fe80-4951-a736-a5fccaf8cc03",
        "url": "/v2/routes/be86f999-fe80-4951-a736-a5fccaf8cc03",
        "created_at": "2015-09-11T18:38:53Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-5",
        "path": "",
        "domain_guid": "19136b40-7ee3-4237-a622-8fe0602ae8a3",
        "space_guid": "bff69695-80e5-42be-a9a4-1c98e99f63c6",
        "service_instance_guid": null,
        "domain_url": "/v2/domains/19136b40-7ee3-4237-a622-8fe0602ae8a3",
        "space_url": "/v2/spaces/bff69695-80e5-42be-a9a4-1c98e99f63c6",
        "apps_url": "/v2/routes/be86f999-fe80-4951-a736-a5fccaf8cc03/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: d97e72f7-00d4-47ee-8cc9-40049bf84531
Content-Length: 799
X-Content-Type-Options: nosniff