Home
Version 3
Apps (Experimental) API

Apps (Experimental) API

Filters Apps by guids, names, spaces, and organizations

GET /v3/apps

Request

Route

GET /v3/apps?names=my_app1&space_guids=70c5c00c-c534-49b5-89be-0990b6691536%2C82775251-3218-4a32-9525-a3dc3d4284f1%2Ca8996745-408f-4ae7-9632-144664e3e4fc&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: 70c5c00c-c534-49b5-89be-0990b6691536,82775251-3218-4a32-9525-a3dc3d4284f1,a8996745-408f-4ae7-9632-144664e3e4fc
page: 1
per_page: 2
order_by: -created_at

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwNSIsImVtYWlsIjoiZW1haWwtMTM3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMDV9.X0jb1_y1psQ-N_Hk7l1nRiW5l7PyRq86dQM1SmZMRY4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps?names=my_app1&space_guids=70c5c00c-c534-49b5-89be-0990b6691536%2C82775251-3218-4a32-9525-a3dc3d4284f1%2Ca8996745-408f-4ae7-9632-144664e3e4fc&page=1&per_page=2&order_by=-created_at" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwNSIsImVtYWlsIjoiZW1haWwtMTM3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMDV9.X0jb1_y1psQ-N_Hk7l1nRiW5l7PyRq86dQM1SmZMRY4" \
	-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=70c5c00c-c534-49b5-89be-0990b6691536%2C82775251-3218-4a32-9525-a3dc3d4284f1%2Ca8996745-408f-4ae7-9632-144664e3e4fc"
    },
    "last": {
      "href": "/v3/apps?names=my_app1&order_by=-created_at&page=2&per_page=2&space_guids=70c5c00c-c534-49b5-89be-0990b6691536%2C82775251-3218-4a32-9525-a3dc3d4284f1%2Ca8996745-408f-4ae7-9632-144664e3e4fc"
    },
    "next": {
      "href": "/v3/apps?names=my_app1&order_by=-created_at&page=2&per_page=2&space_guids=70c5c00c-c534-49b5-89be-0990b6691536%2C82775251-3218-4a32-9525-a3dc3d4284f1%2Ca8996745-408f-4ae7-9632-144664e3e4fc"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "guid-85c0816b-a436-482d-9879-31ff57bc186c",
      "name": "my_app1",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "buildpack": null,
      "created_at": "2015-10-13T17:31:45Z",
      "updated_at": null,
      "environment_variables": {

      },
      "links": {
        "self": {
          "href": "/v3/apps/guid-85c0816b-a436-482d-9879-31ff57bc186c"
        },
        "space": {
          "href": "/v2/spaces/70c5c00c-c534-49b5-89be-0990b6691536"
        },
        "processes": {
          "href": "/v3/apps/guid-85c0816b-a436-482d-9879-31ff57bc186c/processes"
        },
        "routes": {
          "href": "/v3/apps/guid-85c0816b-a436-482d-9879-31ff57bc186c/routes"
        },
        "packages": {
          "href": "/v3/apps/guid-85c0816b-a436-482d-9879-31ff57bc186c/packages"
        },
        "droplets": {
          "href": "/v3/apps/guid-85c0816b-a436-482d-9879-31ff57bc186c/droplets"
        },
        "start": {
          "href": "/v3/apps/guid-85c0816b-a436-482d-9879-31ff57bc186c/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-85c0816b-a436-482d-9879-31ff57bc186c/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-85c0816b-a436-482d-9879-31ff57bc186c/current_droplet",
          "method": "PUT"
        }
      }
    },
    {
      "guid": "guid-e3f0b3f0-fb48-4bde-8e9c-d0f69748749a",
      "name": "my_app1",
      "desired_state": "STOPPED",
      "total_desired_instances": 0,
      "buildpack": null,
      "created_at": "2015-10-13T17:31:45Z",
      "updated_at": null,
      "environment_variables": {

      },
      "links": {
        "self": {
          "href": "/v3/apps/guid-e3f0b3f0-fb48-4bde-8e9c-d0f69748749a"
        },
        "space": {
          "href": "/v2/spaces/a8996745-408f-4ae7-9632-144664e3e4fc"
        },
        "processes": {
          "href": "/v3/apps/guid-e3f0b3f0-fb48-4bde-8e9c-d0f69748749a/processes"
        },
        "routes": {
          "href": "/v3/apps/guid-e3f0b3f0-fb48-4bde-8e9c-d0f69748749a/routes"
        },
        "packages": {
          "href": "/v3/apps/guid-e3f0b3f0-fb48-4bde-8e9c-d0f69748749a/packages"
        },
        "droplets": {
          "href": "/v3/apps/guid-e3f0b3f0-fb48-4bde-8e9c-d0f69748749a/droplets"
        },
        "start": {
          "href": "/v3/apps/guid-e3f0b3f0-fb48-4bde-8e9c-d0f69748749a/start",
          "method": "PUT"
        },
        "stop": {
          "href": "/v3/apps/guid-e3f0b3f0-fb48-4bde-8e9c-d0f69748749a/stop",
          "method": "PUT"
        },
        "assign_current_droplet": {
          "href": "/v3/apps/guid-e3f0b3f0-fb48-4bde-8e9c-d0f69748749a/current_droplet",
          "method": "PUT"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 02d81053-549c-4820-9674-0265270e4870
Content-Length: 3578
X-Content-Type-Options: nosniff