Updating a Process
PATCH /v3/processes/:guid
Request
Route
PATCH /v3/processes/8dbad6ba-42e9-4906-bae7-08e4d81f64b8
Parameters
Name |
Description |
Valid Values |
Example Values |
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
|
|
|
type
|
Type of the process
|
|
|
Body
Name |
Description |
Default |
Valid Values |
Example Values |
{
"memory": 2555,
"instances": 2,
"disk_quota": 2048,
"space_guid": "ccf9eff0-ec79-478d-ac58-5516f45dae3a",
"stack_guid": "de42381f-1dbb-4c80-aec6-e35877cf4909",
"state": "STARTED",
"command": "X",
"buildpack": "another-buildpack",
"health_check_timeout": 70,
"environment_json": {
"foo": "bar"
},
"type": "worker"
}
Headers
cURL
curl "https://api.[your-domain.com]/v3/processes/8dbad6ba-42e9-4906-bae7-08e4d81f64b8" -d '{
"memory": 2555,
"instances": 2,
"disk_quota": 2048,
"space_guid": "ccf9eff0-ec79-478d-ac58-5516f45dae3a",
"stack_guid": "de42381f-1dbb-4c80-aec6-e35877cf4909",
"state": "STARTED",
"command": "X",
"buildpack": "another-buildpack",
"health_check_timeout": 70,
"environment_json": {
"foo": "bar"
},
"type": "worker"
}' -X PATCH \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwNCIsImVtYWlsIjoiZW1haWwtMTM1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MDZ9.6sjNCjJQzzzMtm-4yDL38TvmduAwMJUAwyju5NfUmY4" \
-H "Host: example.org" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Cookie: "
Response
Status
200 OK
Body
{
"guid": "8dbad6ba-42e9-4906-bae7-08e4d81f64b8",
"type": "worker",
"command": "X"
}
Headers