Home
Version 3
Routes API

Routes API

List all Apps for the Route

GET /v2/routes/:guid/apps

Request

Route

GET /v2/routes/cfc16444-16f9-4e9d-a96f-1e946b9451fc/apps

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, diego
  • 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
guid The guid of the route.

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTciLCJlbWFpbCI6ImVtYWlsLTdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNzMyMzk1NX0.2j9HsOKoNQpZOJ1BUv18fPo1pgjntMH9uKB7nwFB1mo
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/routes/cfc16444-16f9-4e9d-a96f-1e946b9451fc/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTciLCJlbWFpbCI6ImVtYWlsLTdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNzMyMzk1NX0.2j9HsOKoNQpZOJ1BUv18fPo1pgjntMH9uKB7nwFB1mo" \
	-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": "e1268509-e66c-4091-9ec6-14725af0077e",
        "url": "/v2/apps/e1268509-e66c-4091-9ec6-14725af0077e",
        "created_at": "2015-03-18T22:52:35Z",
        "updated_at": "2015-03-18T22:52:35Z"
      },
      "entity": {
        "name": "name-24",
        "production": false,
        "space_guid": "e772fb63-43fe-40bd-b7e9-ee70bea4b8fb",
        "stack_guid": "07a0f024-92d4-4b23-b00a-d4313f12897f",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "aa5a9595-6bda-49db-a224-0cb70aa60c79",
        "command": null,
        "console": false,
        "debug": null,
        "staging_task_id": null,
        "package_state": "PENDING",
        "health_check_type": "port",
        "health_check_timeout": null,
        "staging_failed_reason": null,
        "diego": false,
        "docker_image": null,
        "package_updated_at": "2015-03-18T22:52:35Z",
        "detected_start_command": "",
        "space_url": "/v2/spaces/e772fb63-43fe-40bd-b7e9-ee70bea4b8fb",
        "stack_url": "/v2/stacks/07a0f024-92d4-4b23-b00a-d4313f12897f",
        "events_url": "/v2/apps/e1268509-e66c-4091-9ec6-14725af0077e/events",
        "service_bindings_url": "/v2/apps/e1268509-e66c-4091-9ec6-14725af0077e/service_bindings",
        "routes_url": "/v2/apps/e1268509-e66c-4091-9ec6-14725af0077e/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: b4e643f7-a211-48b7-895f-1aa4b5b91931
Content-Length: 1624
X-Content-Type-Options: nosniff