Apps (Experimental) API

List all Apps

GET /v3/apps

Request

Route

GET /v3/apps?page=1&per_page=2&order_by=created_at&order_direction=desc

Parameters

Name	Description	Valid Values	Example Values
names	Names of apps to filter by	array of strings	names[]=name1&names[]=name2
space_guids	Spaces to filter by	array of strings	space_guids[]=space_guid1&space_guids[]=space_guid2
organization_guids	Organizations to filter by	array of strings	organization_guids[]=org_guid1&organization_guids[]=org_guid2
guids	App guids to filter by	array of strings	guid[]=guid1&guid[]=guid2
page	Page to display	>= 1
per_page	Number of results per page	1 - 5000
order_by	Value to sort by	created_at, updated_at
order_direction	Direction to sort by	asc, desc

page: 1
per_page: 2
order_by: created_at
order_direction: desc

Body

Name	Description	Default	Valid Values	Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5NiIsImVtYWlsIjoiZW1haWwtMjIzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzIzMTM2MjF9.sHBz2QIuA2qhhhRC9wzDSAhCqRfz23t23fP8hoZIzfI
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps?page=1&per_page=2&order_by=created_at&order_direction=desc" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5NiIsImVtYWlsIjoiZW1haWwtMjIzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzIzMTM2MjF9.sHBz2QIuA2qhhhRC9wzDSAhCqRfz23t23fP8hoZIzfI" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 3,
    "first": {
      "href": "/v3/apps?order_by=created_at&order_direction=desc&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps?order_by=created_at&order_direction=desc&page=2&per_page=2"
    },
    "next": {
      "href": "/v3/apps?order_by=created_at&order_direction=desc&page=2&per_page=2"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-da107ca4-ba59-41de-a698-d2c4b6c71f20",
      "name": "my_app3",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "created_at": "1970-01-01T00:00:03Z",
      "updated_at": null,
      "environment_variables": {
        "magic": "beautiful"
      },
      "_links": {
        "self": {
          "href": "/v3/apps/guid-da107ca4-ba59-41de-a698-d2c4b6c71f20"
        },
        "processes": {
          "href": "/v3/apps/guid-da107ca4-ba59-41de-a698-d2c4b6c71f20/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-da107ca4-ba59-41de-a698-d2c4b6c71f20/packages"
        },
        "space": {
          "href": "/v2/spaces/bcf0437c-cc88-4db9-ba2b-d0f1dc96f759"
        },
        "start": {
          "href": "/v3/apps/guid-da107ca4-ba59-41de-a698-d2c4b6c71f20/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-da107ca4-ba59-41de-a698-d2c4b6c71f20/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-da107ca4-ba59-41de-a698-d2c4b6c71f20/current_droplet",
          "method": "PUT"
        }
      }
    },
    {
      "guid": "guid-1a2f9831-2c92-4b49-88e6-1bc0ed497a3e",
      "name": "my_app2",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "created_at": "1970-01-01T00:00:02Z",
      "updated_at": null,
      "environment_variables": {

      },
      "_links": {
        "self": {
          "href": "/v3/apps/guid-1a2f9831-2c92-4b49-88e6-1bc0ed497a3e"
        },
        "processes": {
          "href": "/v3/apps/guid-1a2f9831-2c92-4b49-88e6-1bc0ed497a3e/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-1a2f9831-2c92-4b49-88e6-1bc0ed497a3e/packages"
        },
        "space": {
          "href": "/v2/spaces/bcf0437c-cc88-4db9-ba2b-d0f1dc96f759"
        },
        "start": {
          "href": "/v3/apps/guid-1a2f9831-2c92-4b49-88e6-1bc0ed497a3e/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-1a2f9831-2c92-4b49-88e6-1bc0ed497a3e/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-1a2f9831-2c92-4b49-88e6-1bc0ed497a3e/current_droplet",
          "method": "PUT"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: e3260e3d-0f79-4566-b849-073e2c5d90e5
Content-Length: 2751
X-Content-Type-Options: nosniff