Home
Version 3
Processes (Experimental) API

Processes (Experimental) API

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": "b7e9b15f-3c0a-4673-b13e-6c96113a2fd2",
  "stack_guid": "870fcb81-8105-4b01-af06-88440c26badd",
  "state": "STOPPED",
  "command": "run me",
  "buildpack": "another-buildpack",
  "health_check_timeout": 70,
  "environment_json": {
    "foo": "bar"
  },
  "type": "worker"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwMyIsImVtYWlsIjoiZW1haWwtMTM1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NTN9.OaaiTRflWQW3SO2kr2XK9dhWr3UZ4R3GVUNg-iqYE74
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/processes" -d '{
  "name": "process",
  "memory": 256,
  "instances": 2,
  "disk_quota": 1024,
  "space_guid": "b7e9b15f-3c0a-4673-b13e-6c96113a2fd2",
  "stack_guid": "870fcb81-8105-4b01-af06-88440c26badd",
  "state": "STOPPED",
  "command": "run me",
  "buildpack": "another-buildpack",
  "health_check_timeout": 70,
  "environment_json": {
    "foo": "bar"
  },
  "type": "worker"
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwMyIsImVtYWlsIjoiZW1haWwtMTM1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NTN9.OaaiTRflWQW3SO2kr2XK9dhWr3UZ4R3GVUNg-iqYE74" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "guid": "a307c30b-cff5-4c74-b30e-0993b8e368a6",
  "type": "worker",
  "command": "run me"
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c5510259-3f12-439c-bbfb-47f036b6a77c
Content-Length: 95
X-Content-Type-Options: nosniff