Home
Version 3
Routes API

Routes API

List all Apps for the Route

GET /v2/routes/:guid/apps

Request

Route

GET /v2/routes/b4688e20-fc1c-4408-a596-53a719c790ce/apps?app_guid=29e9e048-75e3-4a71-8668-f8920e9fba60

Parameters

Name Description Valid Values Example Values
app_guid The guid of the app
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, stack_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
app_guid: 29e9e048-75e3-4a71-8668-f8920e9fba60

Body

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3NiIsImVtYWlsIjoiZW1haWwtMjQ0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQyNjA2NTR9.R5w9OSE87ejVERcY726shO5I_L5YOCpc9g5CEcuxAew
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/routes/b4688e20-fc1c-4408-a596-53a719c790ce/apps?app_guid=29e9e048-75e3-4a71-8668-f8920e9fba60" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3NiIsImVtYWlsIjoiZW1haWwtMjQ0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQyNjA2NTR9.R5w9OSE87ejVERcY726shO5I_L5YOCpc9g5CEcuxAew" \
	-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": "2b2ff697-17f3-4cff-a8a0-819e2b14a570",
        "url": "/v2/apps/2b2ff697-17f3-4cff-a8a0-819e2b14a570",
        "created_at": "2015-09-30T23:30:54Z",
        "updated_at": "2015-09-30T23:30:54Z"
      },
      "entity": {
        "name": "name-1890",
        "production": false,
        "space_guid": "826f5760-e041-458a-917b-d3f76e2bf3b7",
        "stack_guid": "3d3d791a-b2e7-48ce-989c-62992ecfd78a",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "30360d1c-2c46-42eb-97be-630b0c3b0a45",
        "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,
        "staging_failed_description": null,
        "diego": false,
        "docker_image": null,
        "package_updated_at": "2015-09-30T23:30:54Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "space_url": "/v2/spaces/826f5760-e041-458a-917b-d3f76e2bf3b7",
        "stack_url": "/v2/stacks/3d3d791a-b2e7-48ce-989c-62992ecfd78a",
        "events_url": "/v2/apps/2b2ff697-17f3-4cff-a8a0-819e2b14a570/events",
        "service_bindings_url": "/v2/apps/2b2ff697-17f3-4cff-a8a0-819e2b14a570/service_bindings",
        "routes_url": "/v2/apps/2b2ff697-17f3-4cff-a8a0-819e2b14a570/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 97be6f97-3233-401a-a71e-439e68f62ccb
Content-Length: 1800
X-Content-Type-Options: nosniff