Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/30f4f21e-dfb6-4d3a-8a17-02946c0f1f15/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, 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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1OCIsImVtYWlsIjoiZW1haWwtMTkwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NjF9.OKqTkIDEAI0-0Tprqy4N7vrxV_Y2F-kp4JLfJ50T4vw
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/30f4f21e-dfb6-4d3a-8a17-02946c0f1f15/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1OCIsImVtYWlsIjoiZW1haWwtMTkwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NjF9.OKqTkIDEAI0-0Tprqy4N7vrxV_Y2F-kp4JLfJ50T4vw" \
	-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": "d0b7ab64-cce5-4dfe-8e17-673b0d85d135",
        "url": "/v2/routes/d0b7ab64-cce5-4dfe-8e17-673b0d85d135",
        "created_at": "2015-03-20T18:27:41Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-7",
        "domain_guid": "810443fd-eba6-4cde-967b-fa604e1d02b7",
        "space_guid": "173d06a8-d2df-4aa4-8f0d-1bb76d3fceba",
        "domain_url": "/v2/domains/810443fd-eba6-4cde-967b-fa604e1d02b7",
        "space_url": "/v2/spaces/173d06a8-d2df-4aa4-8f0d-1bb76d3fceba",
        "apps_url": "/v2/routes/d0b7ab64-cce5-4dfe-8e17-673b0d85d135/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 128dcb5a-5489-4acc-8ec2-64f3e5bc49f1
Content-Length: 740
X-Content-Type-Options: nosniff