Apps (Experimental) API

Filters Apps by guids, names, spaces, and organizations

GET /v3/apps

Request

Route

GET /v3/apps?names[]=my_app1&space_guids[]=38d76e33-b7fa-446b-9294-ecba51454e85&space_guids[]=8bdf5832-690b-46f8-b53f-67ddb5eb4c23&space_guids[]=4ee96fbb-ba19-431a-9b47-d24dc21d2cce&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: ["38d76e33-b7fa-446b-9294-ecba51454e85", "8bdf5832-690b-46f8-b53f-67ddb5eb4c23", "4ee96fbb-ba19-431a-9b47-d24dc21d2cce"]
page: 1
per_page: 2
order_by: created_at
order_direction: desc

Body

Name	Description	Default	Valid Values	Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1NyIsImVtYWlsIjoiZW1haWwtMjczQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzUxMDI4NjV9.VTNKAL1u5OOZHHwweHEFvLuHe_etRw-dGRal6DZFoHs
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps?names[]=my_app1&space_guids[]=38d76e33-b7fa-446b-9294-ecba51454e85&space_guids[]=8bdf5832-690b-46f8-b53f-67ddb5eb4c23&space_guids[]=4ee96fbb-ba19-431a-9b47-d24dc21d2cce&page=1&per_page=2&order_by=created_at&order_direction=desc" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1NyIsImVtYWlsIjoiZW1haWwtMjczQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzUxMDI4NjV9.VTNKAL1u5OOZHHwweHEFvLuHe_etRw-dGRal6DZFoHs" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 3,
    "first": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=38d76e33-b7fa-446b-9294-ecba51454e85&space_guids[]=8bdf5832-690b-46f8-b53f-67ddb5eb4c23&space_guids[]=4ee96fbb-ba19-431a-9b47-d24dc21d2cce&order_by=created_at&order_direction=desc&page=1&per_page=2"
    },
    "last": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=38d76e33-b7fa-446b-9294-ecba51454e85&space_guids[]=8bdf5832-690b-46f8-b53f-67ddb5eb4c23&space_guids[]=4ee96fbb-ba19-431a-9b47-d24dc21d2cce&order_by=created_at&order_direction=desc&page=2&per_page=2"
    },
    "next": {
      "href": "/v3/apps?names[]=my_app1&space_guids[]=38d76e33-b7fa-446b-9294-ecba51454e85&space_guids[]=8bdf5832-690b-46f8-b53f-67ddb5eb4c23&space_guids[]=4ee96fbb-ba19-431a-9b47-d24dc21d2cce&order_by=created_at&order_direction=desc&page=2&per_page=2"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-77a292ae-25c6-4300-978f-e133d1aa8667",
      "name": "my_app1",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "created_at": "2015-06-16T23:41:05Z",
      "updated_at": null,
      "environment_variables": {

      },
      "_links": {
        "self": {
          "href": "/v3/apps/guid-77a292ae-25c6-4300-978f-e133d1aa8667"
        },
        "processes": {
          "href": "/v3/apps/guid-77a292ae-25c6-4300-978f-e133d1aa8667/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-77a292ae-25c6-4300-978f-e133d1aa8667/packages"
        },
        "space": {
          "href": "/v2/spaces/38d76e33-b7fa-446b-9294-ecba51454e85"
        },
        "start": {
          "href": "/v3/apps/guid-77a292ae-25c6-4300-978f-e133d1aa8667/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-77a292ae-25c6-4300-978f-e133d1aa8667/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-77a292ae-25c6-4300-978f-e133d1aa8667/current_droplet",
          "method": "PUT"
        }
      }
    },
    {
      "guid": "guid-664bed36-95b5-4f80-a99a-230b6292f69e",
      "name": "my_app1",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "created_at": "2015-06-16T23:41:05Z",
      "updated_at": null,
      "environment_variables": {

      },
      "_links": {
        "self": {
          "href": "/v3/apps/guid-664bed36-95b5-4f80-a99a-230b6292f69e"
        },
        "processes": {
          "href": "/v3/apps/guid-664bed36-95b5-4f80-a99a-230b6292f69e/processes"
        },
        "packages": {
          "href": "/v3/apps/guid-664bed36-95b5-4f80-a99a-230b6292f69e/packages"
        },
        "space": {
          "href": "/v2/spaces/4ee96fbb-ba19-431a-9b47-d24dc21d2cce"
        },
        "start": {
          "href": "/v3/apps/guid-664bed36-95b5-4f80-a99a-230b6292f69e/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-664bed36-95b5-4f80-a99a-230b6292f69e/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-664bed36-95b5-4f80-a99a-230b6292f69e/current_droplet",
          "method": "PUT"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 57e0bb21-2a91-4afe-a7bc-c53452c1361d
Content-Length: 3230
X-Content-Type-Options: nosniff