Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/07c6781c-6623-41cb-a1e3-7682e8800643/routes?route_guid=3390f1fc-1f8f-478a-b0d1-34070dae5bd9

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: 3390f1fc-1f8f-478a-b0d1-34070dae5bd9

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyNyIsImVtYWlsIjoiZW1haWwtMTU5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMDl9.H6W-Y8peHTqUmycFKy9bpvlmJ1D2Txy_4t32PFoeRno
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/07c6781c-6623-41cb-a1e3-7682e8800643/routes?route_guid=3390f1fc-1f8f-478a-b0d1-34070dae5bd9" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyNyIsImVtYWlsIjoiZW1haWwtMTU5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMDl9.H6W-Y8peHTqUmycFKy9bpvlmJ1D2Txy_4t32PFoeRno" \
	-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": "ac9df03f-1f47-447b-a9f4-e41d95632298",
        "url": "/v2/routes/ac9df03f-1f47-447b-a9f4-e41d95632298",
        "created_at": "2015-10-13T17:31:49Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-10",
        "path": "",
        "domain_guid": "992a8370-ad84-4efd-99e0-a93f2953635a",
        "space_guid": "8fb6a73b-34da-4ba8-8859-891e4bbb78f0",
        "service_instance_guid": null,
        "port": 0,
        "domain_url": "/v2/domains/992a8370-ad84-4efd-99e0-a93f2953635a",
        "space_url": "/v2/spaces/8fb6a73b-34da-4ba8-8859-891e4bbb78f0",
        "apps_url": "/v2/routes/ac9df03f-1f47-447b-a9f4-e41d95632298/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 992d714e-1a7a-494f-bae7-215f0b63f95e
Content-Length: 819
X-Content-Type-Options: nosniff