Routes API

List all Apps for the Route

GET /v2/routes/:guid/apps

Request

Route

GET /v2/routes/f052877e-a046-4bc0-87d6-612c52630cf5/apps?app_guid=efe7d4fd-d070-4760-9de8-1c9d8525986a

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: efe7d4fd-d070-4760-9de8-1c9d8525986a

Body

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzOSIsImVtYWlsIjoiZW1haWwtMTc1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyNzN9.QHKMovfUANMJXM2GzVoipxTQhDuV2eMBRWLTom2wnNg
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/routes/f052877e-a046-4bc0-87d6-612c52630cf5/apps?app_guid=efe7d4fd-d070-4760-9de8-1c9d8525986a" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzOSIsImVtYWlsIjoiZW1haWwtMTc1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyNzN9.QHKMovfUANMJXM2GzVoipxTQhDuV2eMBRWLTom2wnNg" \
	-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": "23fd0e9f-165c-4a54-a1a7-87cd68b19bae",
        "url": "/v2/apps/23fd0e9f-165c-4a54-a1a7-87cd68b19bae",
        "created_at": "2016-01-19T19:41:13Z",
        "updated_at": "2016-01-19T19:41:13Z"
      },
      "entity": {
        "name": "name-1872",
        "production": false,
        "space_guid": "b066fbd9-f116-44c6-bf0d-729349ad6f9d",
        "stack_guid": "687dc8df-bc33-4158-8fa0-a81e10b72ec1",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "38d44f39-0290-4b76-8531-e9310fd8f00f",
        "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": "2016-01-19T19:41:13Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/b066fbd9-f116-44c6-bf0d-729349ad6f9d",
        "stack_url": "/v2/stacks/687dc8df-bc33-4158-8fa0-a81e10b72ec1",
        "events_url": "/v2/apps/23fd0e9f-165c-4a54-a1a7-87cd68b19bae/events",
        "service_bindings_url": "/v2/apps/23fd0e9f-165c-4a54-a1a7-87cd68b19bae/service_bindings",
        "routes_url": "/v2/apps/23fd0e9f-165c-4a54-a1a7-87cd68b19bae/routes"
      }
    }
  ]
}

Headers

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