Apps (Experimental) API

Filters Apps by guids, names, spaces, and organizations

GET /v3/apps

Request

Route

GET /v3/apps?names=my_app1&space_guids=42dc5e11-6b5f-4d9e-8b23-5eac076cc336%2C3c4f82bd-028f-4e9d-812e-63dfaa8dedd2%2Cc7305400-b46a-4cd4-bbb0-be234b7f5dd0&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: 42dc5e11-6b5f-4d9e-8b23-5eac076cc336,3c4f82bd-028f-4e9d-812e-63dfaa8dedd2,c7305400-b46a-4cd4-bbb0-be234b7f5dd0
page: 1
per_page: 2
order_by: -created_at

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0MiIsImVtYWlsIjoiZW1haWwtMzA5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDgwMzg5NzR9.LBBpZ4-fvLSQvlRrdqXFRkcpRPeOs1mV_n608rLRwLk
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps?names=my_app1&space_guids=42dc5e11-6b5f-4d9e-8b23-5eac076cc336%2C3c4f82bd-028f-4e9d-812e-63dfaa8dedd2%2Cc7305400-b46a-4cd4-bbb0-be234b7f5dd0&page=1&per_page=2&order_by=-created_at" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0MiIsImVtYWlsIjoiZW1haWwtMzA5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDgwMzg5NzR9.LBBpZ4-fvLSQvlRrdqXFRkcpRPeOs1mV_n608rLRwLk" \
	-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=42dc5e11-6b5f-4d9e-8b23-5eac076cc336%2C3c4f82bd-028f-4e9d-812e-63dfaa8dedd2%2Cc7305400-b46a-4cd4-bbb0-be234b7f5dd0"
    },
    "last": {
      "href": "/v3/apps?names=my_app1&order_by=-created_at&page=2&per_page=2&space_guids=42dc5e11-6b5f-4d9e-8b23-5eac076cc336%2C3c4f82bd-028f-4e9d-812e-63dfaa8dedd2%2Cc7305400-b46a-4cd4-bbb0-be234b7f5dd0"
    },
    "next": {
      "href": "/v3/apps?names=my_app1&order_by=-created_at&page=2&per_page=2&space_guids=42dc5e11-6b5f-4d9e-8b23-5eac076cc336%2C3c4f82bd-028f-4e9d-812e-63dfaa8dedd2%2Cc7305400-b46a-4cd4-bbb0-be234b7f5dd0"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-1bf4cb16-c64b-40ca-98b8-76ea526ffd90",
      "name": "my_app1",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "created_at": "2015-11-13T17:02:54Z",
      "updated_at": null,
      "lifecycle": {
        "type": "buildpack",
        "data": {
          "buildpack": "name-2442",
          "stack": "name-2443"
        }
      },
      "environment_variables": {

      },
      "links": {
        "self": {
          "href": "/v3/apps/guid-1bf4cb16-c64b-40ca-98b8-76ea526ffd90"
        },
        "space": {
          "href": "/v2/spaces/42dc5e11-6b5f-4d9e-8b23-5eac076cc336"
        },
        "processes": {
          "href": "/v3/apps/guid-1bf4cb16-c64b-40ca-98b8-76ea526ffd90/processes"
        },
        "routes": {
          "href": "/v3/apps/guid-1bf4cb16-c64b-40ca-98b8-76ea526ffd90/routes"
        },
        "packages": {
          "href": "/v3/apps/guid-1bf4cb16-c64b-40ca-98b8-76ea526ffd90/packages"
        },
        "droplets": {
          "href": "/v3/apps/guid-1bf4cb16-c64b-40ca-98b8-76ea526ffd90/droplets"
        },
        "start": {
          "href": "/v3/apps/guid-1bf4cb16-c64b-40ca-98b8-76ea526ffd90/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-1bf4cb16-c64b-40ca-98b8-76ea526ffd90/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-1bf4cb16-c64b-40ca-98b8-76ea526ffd90/current_droplet",
          "method": "PUT"
        }
      }
    },
    {
      "guid": "guid-e222858d-f11b-454d-a77f-854d1a2c8aaf",
      "name": "my_app1",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "created_at": "2015-11-13T17:02:54Z",
      "updated_at": null,
      "lifecycle": {
        "type": "buildpack",
        "data": {
          "buildpack": "name-2444",
          "stack": "name-2445"
        }
      },
      "environment_variables": {

      },
      "links": {
        "self": {
          "href": "/v3/apps/guid-e222858d-f11b-454d-a77f-854d1a2c8aaf"
        },
        "space": {
          "href": "/v2/spaces/c7305400-b46a-4cd4-bbb0-be234b7f5dd0"
        },
        "processes": {
          "href": "/v3/apps/guid-e222858d-f11b-454d-a77f-854d1a2c8aaf/processes"
        },
        "routes": {
          "href": "/v3/apps/guid-e222858d-f11b-454d-a77f-854d1a2c8aaf/routes"
        },
        "packages": {
          "href": "/v3/apps/guid-e222858d-f11b-454d-a77f-854d1a2c8aaf/packages"
        },
        "droplets": {
          "href": "/v3/apps/guid-e222858d-f11b-454d-a77f-854d1a2c8aaf/droplets"
        },
        "start": {
          "href": "/v3/apps/guid-e222858d-f11b-454d-a77f-854d1a2c8aaf/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-e222858d-f11b-454d-a77f-854d1a2c8aaf/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-e222858d-f11b-454d-a77f-854d1a2c8aaf/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.015389
Content-Length: 3836