Home
Version 3
Routes API

Routes API

List all Apps for the Route

GET /v2/routes/:guid/apps

Request

Route

GET /v2/routes/0b9fe59b-77bb-4484-a6eb-03f687a18158/apps?app_guid=ff031e95-694d-42f2-82ff-f71531499670

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: ff031e95-694d-42f2-82ff-f71531499670

Body

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM5OCIsImVtYWlsIjoiZW1haWwtMjY2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQ3ODI5NDN9.uQejZmp8duj6ruaO7LoC3_0hSM8t7kRRB3hmcK0IB3k
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/routes/0b9fe59b-77bb-4484-a6eb-03f687a18158/apps?app_guid=ff031e95-694d-42f2-82ff-f71531499670" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM5OCIsImVtYWlsIjoiZW1haWwtMjY2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQ3ODI5NDN9.uQejZmp8duj6ruaO7LoC3_0hSM8t7kRRB3hmcK0IB3k" \
	-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": "3349626d-bae7-431f-b1d6-43669bf6e3be",
        "url": "/v2/apps/3349626d-bae7-431f-b1d6-43669bf6e3be",
        "created_at": "2015-10-07T00:35:43Z",
        "updated_at": "2015-10-07T00:35:43Z"
      },
      "entity": {
        "name": "name-2224",
        "production": false,
        "space_guid": "38df3c60-ad79-4d68-a456-701b064583f7",
        "stack_guid": "f20f70ca-b61e-46f1-8530-27f9e2111765",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "352d90c7-7515-4b86-a511-b83da57ccac4",
        "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-10-07T00:35:43Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "space_url": "/v2/spaces/38df3c60-ad79-4d68-a456-701b064583f7",
        "stack_url": "/v2/stacks/f20f70ca-b61e-46f1-8530-27f9e2111765",
        "events_url": "/v2/apps/3349626d-bae7-431f-b1d6-43669bf6e3be/events",
        "service_bindings_url": "/v2/apps/3349626d-bae7-431f-b1d6-43669bf6e3be/service_bindings",
        "routes_url": "/v2/apps/3349626d-bae7-431f-b1d6-43669bf6e3be/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 0efa30ac-1de0-4aaa-9c5c-aa7c501c3e0a
Content-Length: 1800
X-Content-Type-Options: nosniff