Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/79dae795-5034-44be-bd2f-665ae284c228/routes?route_guid=2083bd75-6bb4-43cd-b0da-f22773218716

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: 2083bd75-6bb4-43cd-b0da-f22773218716

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0OSIsImVtYWlsIjoiZW1haWwtMTUzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NTB9.CS5Ozusv8z8kCP-ELT9-HiunEbEaloPvf9wSnYNFtLk
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/79dae795-5034-44be-bd2f-665ae284c228/routes?route_guid=2083bd75-6bb4-43cd-b0da-f22773218716" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0OSIsImVtYWlsIjoiZW1haWwtMTUzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NTB9.CS5Ozusv8z8kCP-ELT9-HiunEbEaloPvf9wSnYNFtLk" \
	-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": "a65e798e-58bd-4ffc-8def-02e07d1361cb",
        "url": "/v2/routes/a65e798e-58bd-4ffc-8def-02e07d1361cb",
        "created_at": "2015-10-15T23:52:29Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-14",
        "path": "",
        "domain_guid": "0e419178-b82c-4884-87ab-da7606f7f55f",
        "space_guid": "7a380395-96db-493d-ad70-af62eaccf655",
        "service_instance_guid": null,
        "port": 0,
        "domain_url": "/v2/domains/0e419178-b82c-4884-87ab-da7606f7f55f",
        "space_url": "/v2/spaces/7a380395-96db-493d-ad70-af62eaccf655",
        "apps_url": "/v2/routes/a65e798e-58bd-4ffc-8def-02e07d1361cb/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 8b52cade-9e1d-4104-9edb-353072f8b7d4
Content-Length: 819
X-Content-Type-Options: nosniff