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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNiIsImVtYWlsIjoiZW1haWwtNzRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLnJlYWQiLCJjbG91ZF9jb250cm9sbGVyLndyaXRlIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzMzk4MTEwM30.S9WkaG36I-DVeBRSgMKyuSXxf5VXBmKgSbk3fDBOPco
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/processes?page=1&per_page=2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNiIsImVtYWlsIjoiZW1haWwtNzRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLnJlYWQiLCJjbG91ZF9jb250cm9sbGVyLndyaXRlIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzMzk4MTEwM30.S9WkaG36I-DVeBRSgMKyuSXxf5VXBmKgSbk3fDBOPco" \
	-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": "81d08595-4f1d-4f55-897d-ed9751661171",
      "type": "web",
      "command": null,
      "instances": 1,
      "created_at": "2015-06-04T00:05:03Z",
      "updated_at": "2015-06-04T00:05:03Z",
      "_links": {
        "self": {
          "href": "/v3/processes/81d08595-4f1d-4f55-897d-ed9751661171"
        },
        "scale": {
          "href": "/v3/processes/81d08595-4f1d-4f55-897d-ed9751661171/scale",
          "method": "PUT"
        },
        "app": {
          "href": "/v3/apps/guid-409dc1a7-c77b-485b-b86e-839d4606c6fc"
        },
        "space": {
          "href": "/v2/spaces/c23a0bc0-725f-49df-a157-5d572d8598ab"
        }
      }
    },
    {
      "guid": "fa32669b-424f-46f5-93ff-30ea4c4c9733",
      "type": "web",
      "command": null,
      "instances": 1,
      "created_at": "2015-06-04T00:05:03Z",
      "updated_at": "2015-06-04T00:05:03Z",
      "_links": {
        "self": {
          "href": "/v3/processes/fa32669b-424f-46f5-93ff-30ea4c4c9733"
        },
        "scale": {
          "href": "/v3/processes/fa32669b-424f-46f5-93ff-30ea4c4c9733/scale",
          "method": "PUT"
        },
        "app": {
          "href": "/v3/apps/"
        },
        "space": {
          "href": "/v2/spaces/c23a0bc0-725f-49df-a157-5d572d8598ab"
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 2839a910-7444-4738-9467-780575c372b5
Content-Length: 1612
X-Content-Type-Options: nosniff