Home
Version 3
Apps API

Apps API

List all Apps

GET /v2/apps

Request

Route

GET /v2/apps

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, 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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ1NSIsImVtYWlsIjoiZW1haWwtMzI2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5OTZ9.B88uVe-dSwForQFKEet8YWzQ-gFQN_Cb3c_C3VDbFks
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ1NSIsImVtYWlsIjoiZW1haWwtMzI2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5OTZ9.B88uVe-dSwForQFKEet8YWzQ-gFQN_Cb3c_C3VDbFks" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "2e7cb302-a89b-44af-a4b1-7a7f1d4286d4",
        "url": "/v2/apps/2e7cb302-a89b-44af-a4b1-7a7f1d4286d4",
        "created_at": "2016-01-13T17:29:56Z",
        "updated_at": "2016-01-13T17:29:56Z"
      },
      "entity": {
        "name": "name-2431",
        "production": false,
        "space_guid": "12ce2f42-6b38-41c3-b4c3-23e13946e584",
        "stack_guid": "3f3c22b5-2957-4f6a-9cfd-a8ffba28ef44",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "29a0d27a-1405-41d4-83cf-d4b53eca18e3",
        "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-13T17:29:56Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/12ce2f42-6b38-41c3-b4c3-23e13946e584",
        "stack_url": "/v2/stacks/3f3c22b5-2957-4f6a-9cfd-a8ffba28ef44",
        "events_url": "/v2/apps/2e7cb302-a89b-44af-a4b1-7a7f1d4286d4/events",
        "service_bindings_url": "/v2/apps/2e7cb302-a89b-44af-a4b1-7a7f1d4286d4/service_bindings",
        "routes_url": "/v2/apps/2e7cb302-a89b-44af-a4b1-7a7f1d4286d4/routes"
      }
    },
    {
      "metadata": {
        "guid": "98e9a25d-1bc2-4ede-93d5-bd33b79bb629",
        "url": "/v2/apps/98e9a25d-1bc2-4ede-93d5-bd33b79bb629",
        "created_at": "2016-01-13T17:29:56Z",
        "updated_at": "2016-01-13T17:29:56Z"
      },
      "entity": {
        "name": "name-2441",
        "production": false,
        "space_guid": "f8fab927-6471-41e7-bc37-66acacb018e5",
        "stack_guid": "0c2fdb6e-ed89-4682-a426-661eebb3048d",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "ba6f169d-a2ff-4a8d-bbac-09b83be62da6",
        "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-13T17:29:56Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/f8fab927-6471-41e7-bc37-66acacb018e5",
        "stack_url": "/v2/stacks/0c2fdb6e-ed89-4682-a426-661eebb3048d",
        "events_url": "/v2/apps/98e9a25d-1bc2-4ede-93d5-bd33b79bb629/events",
        "service_bindings_url": "/v2/apps/98e9a25d-1bc2-4ede-93d5-bd33b79bb629/service_bindings",
        "routes_url": "/v2/apps/98e9a25d-1bc2-4ede-93d5-bd33b79bb629/routes"
      }
    },
    {
      "metadata": {
        "guid": "dfb931aa-4d0b-4438-add3-22b1303d3cd9",
        "url": "/v2/apps/dfb931aa-4d0b-4438-add3-22b1303d3cd9",
        "created_at": "2016-01-13T17:29:56Z",
        "updated_at": "2016-01-13T17:29:56Z"
      },
      "entity": {
        "name": "name-2436",
        "production": false,
        "space_guid": "e33b5ea0-02f5-48b5-810f-967870b0e513",
        "stack_guid": "4645519e-4ec7-42f2-a8ae-e4a5163c16e5",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "ca3f2e94-bbf9-49ae-9a74-60ea439cfe92",
        "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-13T17:29:56Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/e33b5ea0-02f5-48b5-810f-967870b0e513",
        "stack_url": "/v2/stacks/4645519e-4ec7-42f2-a8ae-e4a5163c16e5",
        "events_url": "/v2/apps/dfb931aa-4d0b-4438-add3-22b1303d3cd9/events",
        "service_bindings_url": "/v2/apps/dfb931aa-4d0b-4438-add3-22b1303d3cd9/service_bindings",
        "routes_url": "/v2/apps/dfb931aa-4d0b-4438-add3-22b1303d3cd9/routes"
      }
    }
  ]
}

Headers

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