Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/0e9e87d1-5137-462a-9eeb-c58cf8cfd692/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, path, port
  • 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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4NiIsImVtYWlsIjoiZW1haWwtMTg4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2Mzd9.LTqNF5J6G7pdc43PjhTUR2V_-m4W16hOOSIgUBKjYxc
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/apps/0e9e87d1-5137-462a-9eeb-c58cf8cfd692/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4NiIsImVtYWlsIjoiZW1haWwtMTg4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2Mzd9.LTqNF5J6G7pdc43PjhTUR2V_-m4W16hOOSIgUBKjYxc" \
	-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": "02e6678d-4c76-4489-bf18-1bae7a4f8a2c",
        "url": "/v2/routes/02e6678d-4c76-4489-bf18-1bae7a4f8a2c",
        "created_at": "2016-04-16T01:23:57Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-13",
        "path": "",
        "domain_guid": "edddaf20-6008-405d-b9b0-c9399e758748",
        "space_guid": "2fa58965-70e0-451a-b05c-4fb2a3c97168",
        "service_instance_guid": null,
        "port": null,
        "domain_url": "/v2/domains/edddaf20-6008-405d-b9b0-c9399e758748",
        "space_url": "/v2/spaces/2fa58965-70e0-451a-b05c-4fb2a3c97168",
        "apps_url": "/v2/routes/02e6678d-4c76-4489-bf18-1bae7a4f8a2c/apps",
        "route_mappings_url": "/v2/routes/02e6678d-4c76-4489-bf18-1bae7a4f8a2c/route_mappings"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6f6704df-2b4f-4f03-bc0d-18e1d3440315
Content-Length: 918
X-Content-Type-Options: nosniff