Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/684c2eae-28db-45f2-8ad5-fe26e2d9f60c/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.eyJ1c2VyX2lkIjoidWFhLWlkLTQzOCIsImVtYWlsIjoiZW1haWwtMzAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg5MDR9.Wymvt5uNa0nSO6bO8n7rk8DrSG2J3NK0CEogHcfWFhQ
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/684c2eae-28db-45f2-8ad5-fe26e2d9f60c/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQzOCIsImVtYWlsIjoiZW1haWwtMzAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg5MDR9.Wymvt5uNa0nSO6bO8n7rk8DrSG2J3NK0CEogHcfWFhQ" \
	-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": "311d34d1-c045-4853-845f-05132377ad7d",
        "url": "/v2/routes/311d34d1-c045-4853-845f-05132377ad7d",
        "created_at": "2016-06-08T16:41:44Z",
        "updated_at": "2016-06-08T16:41:26Z"
      },
      "entity": {
        "host": "host-36",
        "path": "",
        "domain_guid": "40a499f7-198a-4289-9aa2-605ba43f92ee",
        "space_guid": "c7c0dd06-b078-43d7-adcb-3974cd785fdd",
        "service_instance_guid": null,
        "port": null,
        "domain_url": "/v2/private_domains/40a499f7-198a-4289-9aa2-605ba43f92ee",
        "space_url": "/v2/spaces/c7c0dd06-b078-43d7-adcb-3974cd785fdd",
        "apps_url": "/v2/routes/311d34d1-c045-4853-845f-05132377ad7d/apps",
        "route_mappings_url": "/v2/routes/311d34d1-c045-4853-845f-05132377ad7d/route_mappings"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: b580185c-d564-4263-9624-7200aea889b2
Content-Length: 926
X-Content-Type-Options: nosniff