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.
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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5NyIsImVtYWlsIjoiZW1haWwtMjIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MTR9.K0ly2ZUxLNWP6wZs_4ffoQizGcjQ0PTF2CesIea3DYE
Host: example.org
Cookie: 

Route

GET /v2/routes/0cca1fe4-3a53-402f-881f-53c539b72bfc/apps

cURL

curl "https://api.[your-domain.com]/v2/routes/0cca1fe4-3a53-402f-881f-53c539b72bfc/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5NyIsImVtYWlsIjoiZW1haWwtMjIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MTR9.K0ly2ZUxLNWP6wZs_4ffoQizGcjQ0PTF2CesIea3DYE" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 21621be0-119d-4775-bfd2-75648295dbd8
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": "2ecf69e6-e678-415c-83f0-34fa9b806788",
        "url": "/v2/apps/2ecf69e6-e678-415c-83f0-34fa9b806788",
        "created_at": "2014-11-13T23:38:34+00:00",
        "updated_at": "2014-11-13T23:38:34+00:00"
      },
      "entity": {
        "name": "name-1236",
        "production": false,
        "space_guid": "458d895a-896a-4996-9d4d-800ba62cc2d7",
        "stack_guid": "a3e28ede-9845-41ea-810b-1c0c28ac9492",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "dc7e9dae-a4cc-400f-9434-50e4c5d71f73",
        "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-13T23:38:34+00:00",
        "detected_start_command": "",
        "space_url": "/v2/spaces/458d895a-896a-4996-9d4d-800ba62cc2d7",
        "stack_url": "/v2/stacks/a3e28ede-9845-41ea-810b-1c0c28ac9492",
        "events_url": "/v2/apps/2ecf69e6-e678-415c-83f0-34fa9b806788/events",
        "service_bindings_url": "/v2/apps/2ecf69e6-e678-415c-83f0-34fa9b806788/service_bindings",
        "routes_url": "/v2/apps/2ecf69e6-e678-415c-83f0-34fa9b806788/routes"
      }
    }
  ]
}