Home
Version 3
Processes (Experimental) API

Processes (Experimental) API

Updating a Process

PATCH /v3/processes/:guid

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
name Name of process
memory Amount of memory (MB) allocated to each instance
instances Number of instances
disk_quota Amount of disk space (MB) allocated to each instance
space_guid Guid of associated Space
stack_guid Guid of associated Stack
state Desired state of process
command Start command for process
buildpack Buildpack used to stage process
health_check_timeout Health check timeout for process
docker_image Name of docker image containing process
environment_json JSON key-value pairs for ENV variables

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3NiIsImVtYWlsIjoiZW1haWwtMTQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjJ9.ZDT6eVhHyRGOtphG-ZCIKZhVUOs6hn6ln7gz837O8GU
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

Route

PATCH /v3/processes/167098e2-1286-450e-814e-4a2e89a4a6a7

Body

{
  "name": "new_name",
  "memory": 2555,
  "instances": 2,
  "disk_quota": 2048,
  "space_guid": "c14b2d9a-4d87-4187-905c-4c73dc3b7d1e",
  "stack_guid": "48f240b9-e7bb-4d11-80e0-055c3f680c68",
  "command": "X"
}

cURL

curl "https://api.[your-domain.com]/v3/processes/167098e2-1286-450e-814e-4a2e89a4a6a7" -d '{
  "name": "new_name",
  "memory": 2555,
  "instances": 2,
  "disk_quota": 2048,
  "space_guid": "c14b2d9a-4d87-4187-905c-4c73dc3b7d1e",
  "stack_guid": "48f240b9-e7bb-4d11-80e0-055c3f680c68",
  "command": "X"
}' -X PATCH \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3NiIsImVtYWlsIjoiZW1haWwtMTQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjJ9.ZDT6eVhHyRGOtphG-ZCIKZhVUOs6hn6ln7gz837O8GU" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: baa6d772-2797-4de9-b245-7e4e63b861cf
Content-Length: 52
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "guid": "167098e2-1286-450e-814e-4a2e89a4a6a7"
}