Skip to main content
PATCH
curl

Path Parameters

process
integer
required

Numeric Process ID.

Required range: x >= 1

Body

application/json
runtime
enum<string>
required

systemd or docker

Available options:
systemd,
docker
command
string[]
required

One command argument; repeat for each argv item

Required array length: 1 - 64 elements
Maximum string length: 4096
user
string

Existing non-root account for a Node systemd Process

Maximum string length: 32
Pattern: ^[a-z_][a-z0-9_-]{0,31}$(?![\s\S])
image
string | null

Conditionally required.

Maximum string length: 255
Pattern: ^[A-Za-z0-9][A-Za-z0-9._\/:@-]*$(?![\s\S])
working_directory
string | null

Runtime working directory

Maximum string length: 4096
Pattern: ^\/(?!.*(?:^|\/)\.\.(?:\/|$))[^\x00\r\n]*$(?![\s\S])
environment
object

Docker environment as a name-to-string-value map; values are redacted in responses.

ports
string[]
Maximum array length: 100
Pattern: ^(?:(?:\d{1,3}\.){3}\d{1,3}:)?\d{1,5}:\d{1,5}(?:\/(?:tcp|udp))?$(?![\s\S])
volumes
object[]
Maximum array length: 100
restart_policy
enum<string>
Available options:
never,
on-failure,
always,
unless-stopped
keep_alive
boolean

Keep running through app-dev idle hibernation

Response

The request succeeded.

data
object
required
meta
object
required