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.eyJ1c2VyX2lkIjoidWFhLWlkLTM3MiIsImVtYWlsIjoiZW1haWwtMjc0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MDl9.h7zfCkeDSNtslyYf5zu2Cwg8-O-P_SPTwqC62sD2NbA
Host: example.org
Cookie: 

Route

GET /v2/routes/5da0623d-e82a-4d00-978e-8fcd7e8febcd/apps

cURL

curl "https://api.[your-domain.com]/v2/routes/5da0623d-e82a-4d00-978e-8fcd7e8febcd/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3MiIsImVtYWlsIjoiZW1haWwtMjc0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MDl9.h7zfCkeDSNtslyYf5zu2Cwg8-O-P_SPTwqC62sD2NbA" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a7efb58b-fcd1-4cb9-8e8e-bca57c56cfe6
Content-Length: 1626
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "02bd4ad7-108a-490a-9327-cd3a3f01ddc0",
        "url": "/v2/apps/02bd4ad7-108a-490a-9327-cd3a3f01ddc0",
        "created_at": "2015-02-13T22:35:09Z",
        "updated_at": "2015-02-13T22:35:09Z"
      },
      "entity": {
        "name": "name-2015",
        "production": false,
        "space_guid": "570df552-dbe8-4504-953a-98da6a130a86",
        "stack_guid": "9efca08c-297e-4bc2-a8e8-a6a373eb19d7",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "53b40582-af97-4bda-b2b5-db9578696965",
        "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-02-13T22:35:09Z",
        "detected_start_command": "",
        "space_url": "/v2/spaces/570df552-dbe8-4504-953a-98da6a130a86",
        "stack_url": "/v2/stacks/9efca08c-297e-4bc2-a8e8-a6a373eb19d7",
        "events_url": "/v2/apps/02bd4ad7-108a-490a-9327-cd3a3f01ddc0/events",
        "service_bindings_url": "/v2/apps/02bd4ad7-108a-490a-9327-cd3a3f01ddc0/service_bindings",
        "routes_url": "/v2/apps/02bd4ad7-108a-490a-9327-cd3a3f01ddc0/routes"
      }
    }
  ]
}