Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/0165dd6f-3eb6-441d-b90b-9b5ef4fb4be2/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, 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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNiIsImVtYWlsIjoiZW1haWwtMTA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5ODR9.ztS6tal9ILB_uqCJOoDyuDLIipViljr4wd34aLLoP_E
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/0165dd6f-3eb6-441d-b90b-9b5ef4fb4be2/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNiIsImVtYWlsIjoiZW1haWwtMTA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5ODR9.ztS6tal9ILB_uqCJOoDyuDLIipViljr4wd34aLLoP_E" \
	-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": "c379fa51-d8f7-473b-9e86-2f6123868678",
        "url": "/v2/routes/c379fa51-d8f7-473b-9e86-2f6123868678",
        "created_at": "2015-05-21T01:03:04Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-6",
        "path": "",
        "domain_guid": "2c314ad4-6ed9-4152-a353-9e2b83ded384",
        "space_guid": "228534e0-d840-4b8b-b551-4b7a50a32e81",
        "domain_url": "/v2/domains/2c314ad4-6ed9-4152-a353-9e2b83ded384",
        "space_url": "/v2/spaces/228534e0-d840-4b8b-b551-4b7a50a32e81",
        "apps_url": "/v2/routes/c379fa51-d8f7-473b-9e86-2f6123868678/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 27dace89-3d89-4a01-bdc2-70d8b200bb44
Content-Length: 760
X-Content-Type-Options: nosniff