Apps (Experimental) API

Filters Apps by guids, names, spaces, and organizations

GET /v3/apps

Request

Route

GET /v3/apps?names[]=my_app1&space_guids[]=5b436df9-6ce6-46ea-ac46-220e74b61cc2&space_guids[]=cfec8929-66df-476b-8a22-db20d7af7b2d&space_guids[]=ee3c03d8-c867-4f18-967e-505fd8dd1563&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

names: ["my_app1"]
space_guids: ["5b436df9-6ce6-46ea-ac46-220e74b61cc2", "cfec8929-66df-476b-8a22-db20d7af7b2d", "ee3c03d8-c867-4f18-967e-505fd8dd1563"]
page: 1
per_page: 2
order_by: created_at
order_direction: desc

Body

Name	Description	Default	Valid Values	Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5NyIsImVtYWlsIjoiZW1haWwtMTE4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDB9.EZj-O9xvfxBdasOjemk7ypBm5P_6Yj2PPFoIo9PdxVY
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps?names[]=my_app1&space_guids[]=5b436df9-6ce6-46ea-ac46-220e74b61cc2&space_guids[]=cfec8929-66df-476b-8a22-db20d7af7b2d&space_guids[]=ee3c03d8-c867-4f18-967e-505fd8dd1563&page=1&per_page=2&order_by=created_at&order_direction=desc" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5NyIsImVtYWlsIjoiZW1haWwtMTE4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDB9.EZj-O9xvfxBdasOjemk7ypBm5P_6Yj2PPFoIo9PdxVY" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 3,
    "first": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=5b436df9-6ce6-46ea-ac46-220e74b61cc2&space_guids[]=cfec8929-66df-476b-8a22-db20d7af7b2d&space_guids[]=ee3c03d8-c867-4f18-967e-505fd8dd1563&order_by=created_at&order_direction=desc&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=5b436df9-6ce6-46ea-ac46-220e74b61cc2&space_guids[]=cfec8929-66df-476b-8a22-db20d7af7b2d&space_guids[]=ee3c03d8-c867-4f18-967e-505fd8dd1563&order_by=created_at&order_direction=desc&page=2&per_page=2"
    },
    "next": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=5b436df9-6ce6-46ea-ac46-220e74b61cc2&space_guids[]=cfec8929-66df-476b-8a22-db20d7af7b2d&space_guids[]=ee3c03d8-c867-4f18-967e-505fd8dd1563&order_by=created_at&order_direction=desc&page=2&per_page=2"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-4697f9ae-2382-4e46-be9b-0b490e75ee33",
      "name": "my_app1",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "created_at": "2015-04-15T00:55:40Z",
      "updated_at": null,
      "environment_variables": {

      },
      "_links": {
        "self": {
          "href": "/v3/apps/guid-4697f9ae-2382-4e46-be9b-0b490e75ee33"
        },
        "processes": {
          "href": "/v3/apps/guid-4697f9ae-2382-4e46-be9b-0b490e75ee33/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-4697f9ae-2382-4e46-be9b-0b490e75ee33/packages"
        },
        "space": {
          "href": "/v2/spaces/5b436df9-6ce6-46ea-ac46-220e74b61cc2"
        },
        "start": {
          "href": "/v3/apps/guid-4697f9ae-2382-4e46-be9b-0b490e75ee33/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-4697f9ae-2382-4e46-be9b-0b490e75ee33/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-4697f9ae-2382-4e46-be9b-0b490e75ee33/current_droplet",
          "method": "PUT"
        }
      }
    },
    {
      "guid": "guid-8c3bdd1b-c3bd-4e2a-9e9d-3f7a15663f40",
      "name": "my_app1",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "created_at": "2015-04-15T00:55:40Z",
      "updated_at": null,
      "environment_variables": {

      },
      "_links": {
        "self": {
          "href": "/v3/apps/guid-8c3bdd1b-c3bd-4e2a-9e9d-3f7a15663f40"
        },
        "processes": {
          "href": "/v3/apps/guid-8c3bdd1b-c3bd-4e2a-9e9d-3f7a15663f40/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-8c3bdd1b-c3bd-4e2a-9e9d-3f7a15663f40/packages"
        },
        "space": {
          "href": "/v2/spaces/ee3c03d8-c867-4f18-967e-505fd8dd1563"
        },
        "start": {
          "href": "/v3/apps/guid-8c3bdd1b-c3bd-4e2a-9e9d-3f7a15663f40/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-8c3bdd1b-c3bd-4e2a-9e9d-3f7a15663f40/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-8c3bdd1b-c3bd-4e2a-9e9d-3f7a15663f40/current_droplet",
          "method": "PUT"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 4bfc8a78-a28d-4fd4-814f-27f39ea3b567
Content-Length: 3230
X-Content-Type-Options: nosniff