Create a Process
POST /v3/processes
Request
Route
POST /v3/processes
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
|
|
|
|
type
|
Type of the process
|
|
|
Body
| Name |
Description |
Default |
Valid Values |
Example Values |
{
"name": "process",
"memory": 256,
"instances": 2,
"disk_quota": 1024,
"space_guid": "e7e08943-bb53-4a48-aa65-9f271661be26",
"stack_guid": "7c7e5112-8604-4205-bff5-ff147dbfaaa9",
"state": "STOPPED",
"command": "run me",
"buildpack": "another-buildpack",
"health_check_timeout": 70,
"environment_json": {
"foo": "bar"
},
"type": "worker"
}
Headers
cURL
curl "https://api.[your-domain.com]/v3/processes" -d '{
"name": "process",
"memory": 256,
"instances": 2,
"disk_quota": 1024,
"space_guid": "e7e08943-bb53-4a48-aa65-9f271661be26",
"stack_guid": "7c7e5112-8604-4205-bff5-ff147dbfaaa9",
"state": "STOPPED",
"command": "run me",
"buildpack": "another-buildpack",
"health_check_timeout": 70,
"environment_json": {
"foo": "bar"
},
"type": "worker"
}' -X POST \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0MSIsImVtYWlsIjoiZW1haWwtMTczQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2Njl9.Ko154agHHOOTfIjC31kyVsani5UHqP1TndSSXIKvIns" \
-H "Host: example.org" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Cookie: "
Response
Status
201 Created
Body
{
"guid": "a63e00c7-4862-40ed-b5c7-f75dfc2a6052",
"type": "worker",
"command": "run me"
}
Headers