Apps (Experimental) API

Filters Apps by guids, names, spaces, and organizations

GET /v3/apps

Request

Route

GET /v3/apps?names[]=my_app1&space_guids[]=5a301940-e864-4064-b817-97f98ff658ac&space_guids[]=d479203c-849a-4f77-9ec8-e6847bc102c5&space_guids[]=7996b9fb-3cc0-408d-b108-6756097e848f&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: ["5a301940-e864-4064-b817-97f98ff658ac", "d479203c-849a-4f77-9ec8-e6847bc102c5", "7996b9fb-3cc0-408d-b108-6756097e848f"]
page: 1
per_page: 2
order_by: created_at
order_direction: desc

Body

Name	Description	Default	Valid Values	Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0MCIsImVtYWlsIjoiZW1haWwtODlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzMTY0NjYzMn0.t2UgttDYl1LLneApOk-CivEbrYyMhxqjB-LU3_lX5c4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps?names[]=my_app1&space_guids[]=5a301940-e864-4064-b817-97f98ff658ac&space_guids[]=d479203c-849a-4f77-9ec8-e6847bc102c5&space_guids[]=7996b9fb-3cc0-408d-b108-6756097e848f&page=1&per_page=2&order_by=created_at&order_direction=desc" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0MCIsImVtYWlsIjoiZW1haWwtODlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzMTY0NjYzMn0.t2UgttDYl1LLneApOk-CivEbrYyMhxqjB-LU3_lX5c4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 3,
    "first": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=5a301940-e864-4064-b817-97f98ff658ac&space_guids[]=d479203c-849a-4f77-9ec8-e6847bc102c5&space_guids[]=7996b9fb-3cc0-408d-b108-6756097e848f&order_by=created_at&order_direction=desc&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=5a301940-e864-4064-b817-97f98ff658ac&space_guids[]=d479203c-849a-4f77-9ec8-e6847bc102c5&space_guids[]=7996b9fb-3cc0-408d-b108-6756097e848f&order_by=created_at&order_direction=desc&page=2&per_page=2"
    },
    "next": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=5a301940-e864-4064-b817-97f98ff658ac&space_guids[]=d479203c-849a-4f77-9ec8-e6847bc102c5&space_guids[]=7996b9fb-3cc0-408d-b108-6756097e848f&order_by=created_at&order_direction=desc&page=2&per_page=2"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-83c44d23-b90c-497a-acf3-e022a5f02736",
      "name": "my_app1",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "created_at": "2015-05-07T23:37:12Z",
      "updated_at": null,
      "environment_variables": {

      },
      "_links": {
        "self": {
          "href": "/v3/apps/guid-83c44d23-b90c-497a-acf3-e022a5f02736"
        },
        "processes": {
          "href": "/v3/apps/guid-83c44d23-b90c-497a-acf3-e022a5f02736/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-83c44d23-b90c-497a-acf3-e022a5f02736/packages"
        },
        "space": {
          "href": "/v2/spaces/5a301940-e864-4064-b817-97f98ff658ac"
        },
        "start": {
          "href": "/v3/apps/guid-83c44d23-b90c-497a-acf3-e022a5f02736/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-83c44d23-b90c-497a-acf3-e022a5f02736/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-83c44d23-b90c-497a-acf3-e022a5f02736/current_droplet",
          "method": "PUT"
        }
      }
    },
    {
      "guid": "guid-bedc8cc1-9d30-4a2d-9178-80b01d57bb8a",
      "name": "my_app1",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "created_at": "2015-05-07T23:37:12Z",
      "updated_at": null,
      "environment_variables": {

      },
      "_links": {
        "self": {
          "href": "/v3/apps/guid-bedc8cc1-9d30-4a2d-9178-80b01d57bb8a"
        },
        "processes": {
          "href": "/v3/apps/guid-bedc8cc1-9d30-4a2d-9178-80b01d57bb8a/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-bedc8cc1-9d30-4a2d-9178-80b01d57bb8a/packages"
        },
        "space": {
          "href": "/v2/spaces/7996b9fb-3cc0-408d-b108-6756097e848f"
        },
        "start": {
          "href": "/v3/apps/guid-bedc8cc1-9d30-4a2d-9178-80b01d57bb8a/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-bedc8cc1-9d30-4a2d-9178-80b01d57bb8a/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-bedc8cc1-9d30-4a2d-9178-80b01d57bb8a/current_droplet",
          "method": "PUT"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 95b45494-ddec-499f-94da-368d95f3f524
Content-Length: 3230
X-Content-Type-Options: nosniff