Home
Version 3
Processes (Experimental) API

Processes (Experimental) API

Updating a Process

PATCH /v3/processes/:guid

Request

Route

PATCH /v3/processes/0fd90e89-4288-4a56-bf82-721ba29a5bfe

Body

Name Description Default Valid Values Example Values
command Start command for process
{
  "command": "X"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQwNyIsImVtYWlsIjoiZW1haWwtMjc4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5OTF9.uGqeojnxqg4KYQ2TAZT4sf8ZNeg4Pi1yZV6sgQNsgKQ
Content-Type: application/json
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/processes/0fd90e89-4288-4a56-bf82-721ba29a5bfe" -d '{
  "command": "X"
}' -X PATCH \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQwNyIsImVtYWlsIjoiZW1haWwtMjc4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5OTF9.uGqeojnxqg4KYQ2TAZT4sf8ZNeg4Pi1yZV6sgQNsgKQ" \
	-H "Content-Type: application/json" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "guid": "0fd90e89-4288-4a56-bf82-721ba29a5bfe",
  "type": "web",
  "command": "X",
  "instances": 1,
  "memory_in_mb": 1024,
  "disk_in_mb": 1024,
  "created_at": "2016-01-13T17:29:51Z",
  "updated_at": "2016-01-13T17:29:51Z",
  "links": {
    "self": {
      "href": "/v3/processes/0fd90e89-4288-4a56-bf82-721ba29a5bfe"
    },
    "scale": {
      "href": "/v3/processes/0fd90e89-4288-4a56-bf82-721ba29a5bfe/scale",
      "method": "PUT"
    },
    "app": {
      "href": "/v3/apps/"
    },
    "space": {
      "href": "/v2/spaces/152dd57a-3016-43ba-936c-063fefea5610"
    }
  }
}

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
X-Runtime: 0.029413
Content-Length: 586