Home
Version 3
Apps API

Apps API

List all Routes for the App

GET /v2/apps/:guid/routes

Request

Route

GET /v2/apps/1a936fe6-16b9-47c7-94ec-89b63948bfcb/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.eyJ1c2VyX2lkIjoidWFhLWlkLTI4MyIsImVtYWlsIjoiZW1haWwtMjExQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2NDB9.eLGWldvT53GTgwETYaIjo0p1vWD5bENWCZe-yvoj_4c
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/1a936fe6-16b9-47c7-94ec-89b63948bfcb/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4MyIsImVtYWlsIjoiZW1haWwtMjExQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2NDB9.eLGWldvT53GTgwETYaIjo0p1vWD5bENWCZe-yvoj_4c" \
	-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": "64822b83-7fea-4c36-8630-9d19bb293fd0",
        "url": "/v2/routes/64822b83-7fea-4c36-8630-9d19bb293fd0",
        "created_at": "2015-05-07T23:37:20Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-20",
        "domain_guid": "9834853f-728d-4823-b61c-49352d5e5305",
        "space_guid": "0d999548-4f14-41fa-bae9-fc1808325f66",
        "path": "",
        "domain_url": "/v2/domains/9834853f-728d-4823-b61c-49352d5e5305",
        "space_url": "/v2/spaces/0d999548-4f14-41fa-bae9-fc1808325f66",
        "apps_url": "/v2/routes/64822b83-7fea-4c36-8630-9d19bb293fd0/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c5ec1823-fc36-4f13-88aa-6520e788e196
Content-Length: 761
X-Content-Type-Options: nosniff