Home
Version 3
Routes API

Routes API

List all Apps for the Route

GET /v2/routes/:guid/apps

Fields

Name Description Default Valid Values Example Values
guid The guid of the route.

Parameters

Name Description Valid Values Example Values
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: name, space_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.

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5NiIsImVtYWlsIjoiZW1haWwtMjIxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNTF9.bPkIs47M_yZ-RQZoFLge7tsyAJYk-xbqftj3d2wAhEI
Host: example.org
Cookie: 

Route

GET /v2/routes/b99f8cc6-6f02-452e-a673-03388befaa54/apps

cURL

curl "https://api.[your-domain.com]/v2/routes/b99f8cc6-6f02-452e-a673-03388befaa54/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5NiIsImVtYWlsIjoiZW1haWwtMjIxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNTF9.bPkIs47M_yZ-RQZoFLge7tsyAJYk-xbqftj3d2wAhEI" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 1e9e208e-026f-4145-9fb5-38bebda35fa8
Content-Length: 1580
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "2b067dea-49ae-4803-a4fd-477360d27ff9",
        "url": "/v2/apps/2b067dea-49ae-4803-a4fd-477360d27ff9",
        "created_at": "2014-11-05T01:02:31+00:00",
        "updated_at": "2014-11-05T01:02:31+00:00"
      },
      "entity": {
        "name": "name-1245",
        "production": false,
        "space_guid": "db51b1df-bee0-4e2d-8916-d2fff3372dcb",
        "stack_guid": "720262ec-4478-428b-aaee-775be4175545",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "0f95a89d-22c9-4b44-83d7-d0cc1893dd1d",
        "command": null,
        "console": false,
        "debug": null,
        "staging_task_id": null,
        "package_state": "PENDING",
        "health_check_timeout": null,
        "staging_failed_reason": null,
        "docker_image": null,
        "package_updated_at": "2014-11-05T01:02:31+00:00",
        "detected_start_command": "",
        "space_url": "/v2/spaces/db51b1df-bee0-4e2d-8916-d2fff3372dcb",
        "stack_url": "/v2/stacks/720262ec-4478-428b-aaee-775be4175545",
        "events_url": "/v2/apps/2b067dea-49ae-4803-a4fd-477360d27ff9/events",
        "service_bindings_url": "/v2/apps/2b067dea-49ae-4803-a4fd-477360d27ff9/service_bindings",
        "routes_url": "/v2/apps/2b067dea-49ae-4803-a4fd-477360d27ff9/routes"
      }
    }
  ]
}