Apps (Experimental) API

Filters Apps by guids, names, spaces, and organizations

GET /v3/apps

Request

Route

GET /v3/apps?names=my_app1&space_guids=2a178c67-bb68-4a49-9c13-b062ef4058c2%2Cda0f23d4-c98a-433a-81c2-10953ca3700a%2C8ad60375-e433-43c4-b33f-54662388c00b&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

names: my_app1
space_guids: 2a178c67-bb68-4a49-9c13-b062ef4058c2,da0f23d4-c98a-433a-81c2-10953ca3700a,8ad60375-e433-43c4-b33f-54662388c00b
page: 1
per_page: 2
order_by: -created_at

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwNSIsImVtYWlsIjoiZW1haWwtMjA4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQ3ODI5Mzl9.cE_Tsd_8dDcmrFBNdpxMZlA-a1oOUUyG2QQPCk9KY3s
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps?names=my_app1&space_guids=2a178c67-bb68-4a49-9c13-b062ef4058c2%2Cda0f23d4-c98a-433a-81c2-10953ca3700a%2C8ad60375-e433-43c4-b33f-54662388c00b&page=1&per_page=2&order_by=-created_at" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwNSIsImVtYWlsIjoiZW1haWwtMjA4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQ3ODI5Mzl9.cE_Tsd_8dDcmrFBNdpxMZlA-a1oOUUyG2QQPCk9KY3s" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 3,
    "first": {
      "href": "/v3/apps?names=my_app1&order_by=-created_at&page=1&per_page=2&space_guids=2a178c67-bb68-4a49-9c13-b062ef4058c2%2Cda0f23d4-c98a-433a-81c2-10953ca3700a%2C8ad60375-e433-43c4-b33f-54662388c00b"
    },
    "last": {
      "href": "/v3/apps?names=my_app1&order_by=-created_at&page=2&per_page=2&space_guids=2a178c67-bb68-4a49-9c13-b062ef4058c2%2Cda0f23d4-c98a-433a-81c2-10953ca3700a%2C8ad60375-e433-43c4-b33f-54662388c00b"
    },
    "next": {
      "href": "/v3/apps?names=my_app1&order_by=-created_at&page=2&per_page=2&space_guids=2a178c67-bb68-4a49-9c13-b062ef4058c2%2Cda0f23d4-c98a-433a-81c2-10953ca3700a%2C8ad60375-e433-43c4-b33f-54662388c00b"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-7f979b02-0f7d-4869-a781-cabd6455e095",
      "name": "my_app1",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "buildpack": null,
      "created_at": "2015-10-07T00:35:39Z",
      "updated_at": null,
      "environment_variables": {

      },
      "links": {
        "self": {
          "href": "/v3/apps/guid-7f979b02-0f7d-4869-a781-cabd6455e095"
        },
        "space": {
          "href": "/v2/spaces/2a178c67-bb68-4a49-9c13-b062ef4058c2"
        },
        "processes": {
          "href": "/v3/apps/guid-7f979b02-0f7d-4869-a781-cabd6455e095/processes"
        },
        "routes": {
          "href": "/v3/apps/guid-7f979b02-0f7d-4869-a781-cabd6455e095/routes"
        },
        "packages": {
          "href": "/v3/apps/guid-7f979b02-0f7d-4869-a781-cabd6455e095/packages"
        },
        "droplets": {
          "href": "/v3/apps/guid-7f979b02-0f7d-4869-a781-cabd6455e095/droplets"
        },
        "start": {
          "href": "/v3/apps/guid-7f979b02-0f7d-4869-a781-cabd6455e095/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-7f979b02-0f7d-4869-a781-cabd6455e095/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-7f979b02-0f7d-4869-a781-cabd6455e095/current_droplet",
          "method": "PUT"
        }
      }
    },
    {
      "guid": "guid-4b03af4e-48a2-43c9-b062-5d186fc36f66",
      "name": "my_app1",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "buildpack": null,
      "created_at": "2015-10-07T00:35:39Z",
      "updated_at": null,
      "environment_variables": {

      },
      "links": {
        "self": {
          "href": "/v3/apps/guid-4b03af4e-48a2-43c9-b062-5d186fc36f66"
        },
        "space": {
          "href": "/v2/spaces/8ad60375-e433-43c4-b33f-54662388c00b"
        },
        "processes": {
          "href": "/v3/apps/guid-4b03af4e-48a2-43c9-b062-5d186fc36f66/processes"
        },
        "routes": {
          "href": "/v3/apps/guid-4b03af4e-48a2-43c9-b062-5d186fc36f66/routes"
        },
        "packages": {
          "href": "/v3/apps/guid-4b03af4e-48a2-43c9-b062-5d186fc36f66/packages"
        },
        "droplets": {
          "href": "/v3/apps/guid-4b03af4e-48a2-43c9-b062-5d186fc36f66/droplets"
        },
        "start": {
          "href": "/v3/apps/guid-4b03af4e-48a2-43c9-b062-5d186fc36f66/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-4b03af4e-48a2-43c9-b062-5d186fc36f66/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-4b03af4e-48a2-43c9-b062-5d186fc36f66/current_droplet",
          "method": "PUT"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: b3f67f1e-709a-4683-bfd2-c69b84f41091
Content-Length: 3578
X-Content-Type-Options: nosniff