Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Fields

Name Description Default Valid Values Example Values

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, organization_guid
  • 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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyNiIsImVtYWlsIjoiZW1haWwtMjI5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MDV9.lKBpAeLFaKpzI7ez7mDiWj2aHaXwpR914yXJ9zq1GRY
Host: example.org
Cookie:

Route

GET /v2/apps/28a08650-ae37-438b-9a2e-7084ec88ce46/routes

cURL

curl "https://api.[your-domain.com]/v2/apps/28a08650-ae37-438b-9a2e-7084ec88ce46/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyNiIsImVtYWlsIjoiZW1haWwtMjI5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MDV9.lKBpAeLFaKpzI7ez7mDiWj2aHaXwpR914yXJ9zq1GRY" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6014edb2-59ba-453e-ac84-0d3272b2a3da
Content-Length: 740
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "9b24de1a-1028-4f22-8ef9-2b65cd726376",
        "url": "/v2/routes/9b24de1a-1028-4f22-8ef9-2b65cd726376",
        "created_at": "2015-02-13T22:35:05Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-3",
        "domain_guid": "48e32510-c284-4d81-a112-eb077ad05fc1",
        "space_guid": "9b68d7d5-6b7e-43f2-acc2-b5ec95b16d80",
        "domain_url": "/v2/domains/48e32510-c284-4d81-a112-eb077ad05fc1",
        "space_url": "/v2/spaces/9b68d7d5-6b7e-43f2-acc2-b5ec95b16d80",
        "apps_url": "/v2/routes/9b24de1a-1028-4f22-8ef9-2b65cd726376/apps"
      }
    }
  ]
}