Routes API

List all Apps for the Route

GET /v2/routes/:guid/apps

Request

Route

GET /v2/routes/d793c7f1-870a-491f-96d0-10be83d58444/apps?app_guid=fdc50398-03fe-48c6-9111-bd3d6d6a51a5

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: fdc50398-03fe-48c6-9111-bd3d6d6a51a5

Body

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3OCIsImVtYWlsIjoiZW1haWwtMjgwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDk1MzE1MzZ9.eP5TWseCpknGbaXu5lMzVhOcr4aVXOnwa_49Ub9Qm08
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/routes/d793c7f1-870a-491f-96d0-10be83d58444/apps?app_guid=fdc50398-03fe-48c6-9111-bd3d6d6a51a5" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3OCIsImVtYWlsIjoiZW1haWwtMjgwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDk1MzE1MzZ9.eP5TWseCpknGbaXu5lMzVhOcr4aVXOnwa_49Ub9Qm08" \
	-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": "f1243da8-e613-490a-8a0e-21ef1bcce952",
        "url": "/v2/apps/f1243da8-e613-490a-8a0e-21ef1bcce952",
        "created_at": "2015-11-30T23:38:56Z",
        "updated_at": "2015-11-30T23:38:56Z"
      },
      "entity": {
        "name": "name-2404",
        "production": false,
        "space_guid": "55f1c5ea-12a5-4128-8f20-606af2a3bce1",
        "stack_guid": "0ef84d2a-4fdd-43ba-afbc-074a5e19ea66",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "5c7c81b2-941b-48a6-b718-c57c02a5f802",
        "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-11-30T23:38:56Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/55f1c5ea-12a5-4128-8f20-606af2a3bce1",
        "stack_url": "/v2/stacks/0ef84d2a-4fdd-43ba-afbc-074a5e19ea66",
        "events_url": "/v2/apps/f1243da8-e613-490a-8a0e-21ef1bcce952/events",
        "service_bindings_url": "/v2/apps/f1243da8-e613-490a-8a0e-21ef1bcce952/service_bindings",
        "routes_url": "/v2/apps/f1243da8-e613-490a-8a0e-21ef1bcce952/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 1823
X-Content-Type-Options: nosniff