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": "9c46bac1-3f60-492a-90d3-d9c602dc0dec",
  "stack_guid": "3d8893dd-a2ec-4f29-b416-5f1815838239",
  "state": "STOPPED",
  "command": "run me",
  "buildpack": "another-buildpack",
  "health_check_timeout": 70,
  "environment_json": {
    "foo": "bar"
  },
  "type": "worker"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MiIsImVtYWlsIjoiZW1haWwtMjIzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5NzJ9.R1z9mTkE_p41-oz7Ox5kHqthpzVCP9Z2iB0RszVtnAM
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": "9c46bac1-3f60-492a-90d3-d9c602dc0dec",
  "stack_guid": "3d8893dd-a2ec-4f29-b416-5f1815838239",
  "state": "STOPPED",
  "command": "run me",
  "buildpack": "another-buildpack",
  "health_check_timeout": 70,
  "environment_json": {
    "foo": "bar"
  },
  "type": "worker"
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MiIsImVtYWlsIjoiZW1haWwtMjIzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5NzJ9.R1z9mTkE_p41-oz7Ox5kHqthpzVCP9Z2iB0RszVtnAM" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "guid": "ee3d03b2-76da-46c9-a78c-fc9d689a50f8",
  "type": "worker",
  "command": "run me"
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6af2b5aa-db35-4f67-b713-6986e1989735
Content-Length: 95
X-Content-Type-Options: nosniff