Home
Version 3
Processes (Experimental) API

Processes (Experimental) API

List all Processes

GET /v3/processes

Request

Route

GET /v3/processes?page=1&per_page=2

Parameters

Name Description Valid Values Example Values
page Page to display
  • >= 1
per_page Number of results per page
  • 1-5000
page: 1
per_page: 2

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMyIsImVtYWlsIjoiZW1haWwtMTQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyNzF9.ccMQyIBT1m6dmX6EyNrmpMy6GnxKIUrAi_-2GWufClQ
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/processes?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMyIsImVtYWlsIjoiZW1haWwtMTQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyNzF9.ccMQyIBT1m6dmX6EyNrmpMy6GnxKIUrAi_-2GWufClQ" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "pagination": {
    "total_results": 3,
    "first": {
      "href": "/v3/processes?page=1&per_page=2"
    },
    "last": {
      "href": "/v3/processes?page=2&per_page=2"
    },
    "next": {
      "href": "/v3/processes?page=2&per_page=2"
    },
    "previous": null
  },
  "resources": [
    {
      "guid": "92007252-e46b-4b3e-a94d-1b19c1ad004e",
      "type": "web",
      "command": null,
      "instances": 1,
      "memory_in_mb": 1024,
      "disk_in_mb": 1024,
      "created_at": "2016-01-19T19:41:10Z",
      "updated_at": "2016-01-19T19:41:10Z",
      "links": {
        "self": {
          "href": "/v3/processes/92007252-e46b-4b3e-a94d-1b19c1ad004e"
        },
        "scale": {
          "href": "/v3/processes/92007252-e46b-4b3e-a94d-1b19c1ad004e/scale",
          "method": "PUT"
        },
        "app": {
          "href": "/v3/apps/guid-28cfc92a-b8cf-4765-9328-fe570395abcd"
        },
        "space": {
          "href": "/v2/spaces/79c3e31e-7bf6-4c29-95fd-3b4347e6ffdc"
        }
      }
    },
    {
      "guid": "a011d701-b579-4826-85e7-379195bc1473",
      "type": "web",
      "command": null,
      "instances": 1,
      "memory_in_mb": 1024,
      "disk_in_mb": 1024,
      "created_at": "2016-01-19T19:41:10Z",
      "updated_at": "2016-01-19T19:41:10Z",
      "links": {
        "self": {
          "href": "/v3/processes/a011d701-b579-4826-85e7-379195bc1473"
        },
        "scale": {
          "href": "/v3/processes/a011d701-b579-4826-85e7-379195bc1473/scale",
          "method": "PUT"
        },
        "app": {
          "href": "/v3/apps/"
        },
        "space": {
          "href": "/v2/spaces/79c3e31e-7bf6-4c29-95fd-3b4347e6ffdc"
        }
      }
    }
  ]
}

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.055740
Content-Length: 1718