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.eyJ1c2VyX2lkIjoidWFhLWlkLTIwOCIsImVtYWlsIjoiZW1haWwtMTYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5NzR9.YgwGhSipryHizoabXqIu-tPWB51h48CRHT_Tc8cMCyM
Host: example.org
Cookie:

Route

GET /v2/routes/6afa4465-2e7b-4642-ba95-fe017ee47436/apps

cURL

curl "https://api.[your-domain.com]/v2/routes/6afa4465-2e7b-4642-ba95-fe017ee47436/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwOCIsImVtYWlsIjoiZW1haWwtMTYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5NzR9.YgwGhSipryHizoabXqIu-tPWB51h48CRHT_Tc8cMCyM" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: b46afce9-2f98-4b0e-a6f3-10b721763cc0
Content-Length: 1617
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "72b8148f-e10b-4a01-81d9-253f05456cd9",
        "url": "/v2/apps/72b8148f-e10b-4a01-81d9-253f05456cd9",
        "created_at": "2014-12-24T01:39:34+00:00",
        "updated_at": "2014-12-24T01:39:34+00:00"
      },
      "entity": {
        "name": "name-1554",
        "production": false,
        "space_guid": "33bb46d4-d503-4b86-a475-e889602d4e79",
        "stack_guid": "39d41775-1fed-4e14-83b6-7636b131bdc4",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "a00afac7-a2d7-4c30-80b5-f83e427d71e0",
        "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,
        "docker_image": null,
        "package_updated_at": "2014-12-24T01:39:34+00:00",
        "detected_start_command": "",
        "space_url": "/v2/spaces/33bb46d4-d503-4b86-a475-e889602d4e79",
        "stack_url": "/v2/stacks/39d41775-1fed-4e14-83b6-7636b131bdc4",
        "events_url": "/v2/apps/72b8148f-e10b-4a01-81d9-253f05456cd9/events",
        "service_bindings_url": "/v2/apps/72b8148f-e10b-4a01-81d9-253f05456cd9/service_bindings",
        "routes_url": "/v2/apps/72b8148f-e10b-4a01-81d9-253f05456cd9/routes"
      }
    }
  ]
}