Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/39ea4fcd-898b-49a4-bad8-872fd8e1e76f/routes?route_guid=00ddb212-a684-4bd7-b0fa-f01ec46091fa

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: 00ddb212-a684-4bd7-b0fa-f01ec46091fa

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0IiwiZW1haWwiOiJlbWFpbC0zM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ3MTE2ODI5fQ.O_7fCZqZFfC_rQexc_ci040JPOpQMo56pNJGPztTtiM
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/apps/39ea4fcd-898b-49a4-bad8-872fd8e1e76f/routes?route_guid=00ddb212-a684-4bd7-b0fa-f01ec46091fa" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0IiwiZW1haWwiOiJlbWFpbC0zM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ3MTE2ODI5fQ.O_7fCZqZFfC_rQexc_ci040JPOpQMo56pNJGPztTtiM" \
	-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": "0f61b7cb-a6b4-4aa0-aaad-f3426c15217a",
        "url": "/v2/routes/0f61b7cb-a6b4-4aa0-aaad-f3426c15217a",
        "created_at": "2015-11-03T00:53:48Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-8",
        "path": "",
        "domain_guid": "995e49d3-1ae9-42be-b6ca-008eff62f0f5",
        "space_guid": "1adab00e-b41b-4f0e-9ff0-db5172881dcd",
        "service_instance_guid": null,
        "port": 0,
        "domain_url": "/v2/domains/995e49d3-1ae9-42be-b6ca-008eff62f0f5",
        "space_url": "/v2/spaces/1adab00e-b41b-4f0e-9ff0-db5172881dcd",
        "apps_url": "/v2/routes/0f61b7cb-a6b4-4aa0-aaad-f3426c15217a/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7d84143f-a190-4236-ba03-a2e1639d41e6
Content-Length: 818
X-Content-Type-Options: nosniff