Home
Version 3
Apps (Experimental) API

Apps (Experimental) API

List all Apps

GET /v3/apps

Request

Route

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

Parameters

Name Description Valid Values Example Values
names Names of apps to filter by
  • array of strings
  • names=name1,name2
space_guids Spaces to filter by
  • array of strings
  • space_guids=space_guid1,space_guid2
organization_guids Organizations to filter by
  • array of strings
  • organization_guids=org_guid1,org_guid2
guids App guids to filter by
  • array of strings
  • guid=guid1,guid2
page Page to display
  • >= 1
per_page Number of results per page
  • 1 - 5000
order_by Value to sort by. Prepend with "+" or "-" to change sort direction to ascending or descending, respectively.
  • created_at, updated_at
page: 1
per_page: 2
order_by: -created_at

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3OSIsImVtYWlsIjoiZW1haWwtMTE3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2ODV9.m-3wA-3xyMovHMEGZewTrMkUXjjDY-IYDSCu8DbKTvk
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps?page=1&per_page=2&order_by=-created_at" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3OSIsImVtYWlsIjoiZW1haWwtMTE3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2ODV9.m-3wA-3xyMovHMEGZewTrMkUXjjDY-IYDSCu8DbKTvk" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 3,
    "first": {
      "href": "/v3/apps?order_by=-created_at&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps?order_by=-created_at&page=2&per_page=2"
    },
    "next": {
      "href": "/v3/apps?order_by=-created_at&page=2&per_page=2"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-13552bb6-a866-4e2c-9d47-c2bccc4c35a1",
      "name": "my_app3",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "created_at": "1970-01-01T00:00:03Z",
      "updated_at": null,
      "lifecycle": {
        "type": "buildpack",
        "data": {
          "buildpack": "name-606",
          "stack": "name-607"
        }
      },
      "environment_variables": {
        "magic": "beautiful"
      },
      "links": {
        "self": {
          "href": "/v3/apps/guid-13552bb6-a866-4e2c-9d47-c2bccc4c35a1"
        },
        "space": {
          "href": "/v2/spaces/f4347f1a-0d9c-4b3b-baba-d7ec30761072"
        },
        "processes": {
          "href": "/v3/apps/guid-13552bb6-a866-4e2c-9d47-c2bccc4c35a1/processes"
        },
        "routes": {
          "href": "/v3/apps/guid-13552bb6-a866-4e2c-9d47-c2bccc4c35a1/routes"
        },
        "packages": {
          "href": "/v3/apps/guid-13552bb6-a866-4e2c-9d47-c2bccc4c35a1/packages"
        },
        "droplets": {
          "href": "/v3/apps/guid-13552bb6-a866-4e2c-9d47-c2bccc4c35a1/droplets"
        },
        "start": {
          "href": "/v3/apps/guid-13552bb6-a866-4e2c-9d47-c2bccc4c35a1/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-13552bb6-a866-4e2c-9d47-c2bccc4c35a1/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-13552bb6-a866-4e2c-9d47-c2bccc4c35a1/current_droplet",
          "method": "PUT"
        }
      }
    },
    {
      "guid": "guid-354f66ff-6618-4f38-aede-a3f8b194c260",
      "name": "my_app2",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "created_at": "1970-01-01T00:00:02Z",
      "updated_at": null,
      "lifecycle": {
        "type": "buildpack",
        "data": {
          "buildpack": "name-604",
          "stack": "name-605"
        }
      },
      "environment_variables": {

      },
      "links": {
        "self": {
          "href": "/v3/apps/guid-354f66ff-6618-4f38-aede-a3f8b194c260"
        },
        "space": {
          "href": "/v2/spaces/f4347f1a-0d9c-4b3b-baba-d7ec30761072"
        },
        "processes": {
          "href": "/v3/apps/guid-354f66ff-6618-4f38-aede-a3f8b194c260/processes"
        },
        "routes": {
          "href": "/v3/apps/guid-354f66ff-6618-4f38-aede-a3f8b194c260/routes"
        },
        "packages": {
          "href": "/v3/apps/guid-354f66ff-6618-4f38-aede-a3f8b194c260/packages"
        },
        "droplets": {
          "href": "/v3/apps/guid-354f66ff-6618-4f38-aede-a3f8b194c260/droplets"
        },
        "start": {
          "href": "/v3/apps/guid-354f66ff-6618-4f38-aede-a3f8b194c260/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-354f66ff-6618-4f38-aede-a3f8b194c260/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-354f66ff-6618-4f38-aede-a3f8b194c260/current_droplet",
          "method": "PUT"
        }
      }
    }
  ]
}

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
X-Runtime: 0.013809
Content-Length: 3437