Update the configuration of an existing process. Only the provided fields are changed - all other fields retain their current values. Changes to resource type, scaling, or probes take effect on the next deployment. Protocol changes are applied asynchronously.
API key authentication. Pass your API key as a Bearer token in the Authorization header.
Application identifier
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"fb5e5168-4281-4bec-94c5-0d1584e9e657"
Process identifier
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"fb5e5168-4281-4bec-94c5-0d1584e9e657"
Human-readable name for the process shown in the dashboard
1 - 255"web"
Command used to start the process
1024"npm start"
Identifier of the process resource type (machine size) to assign. Use the List Process Resource Types endpoint to retrieve available options.
"fb5e5168-4281-4bec-94c5-0d1584e9e657"
Scaling configuration for the process
Port number the process listens on for incoming connections
1 <= x <= 655358080
Whether external traffic routing is enabled for this process. Only applicable to web processes.
true
Ingress protocol for the process. http - standard HTTP/HTTPS traffic. grpc - gRPC protocol. Only applicable to web processes. The change is applied asynchronously by syncing the ingress configuration.
http, grpc "http"
Cron expression defining the execution schedule. Only applicable to cron processes.
100"0 */6 * * *"
IANA time zone for the cron schedule. Only applicable to cron processes.
100"America/New_York"
When the job process should run relative to deployments. beforeDeployment - run before the deployment starts. afterSuccessDeployment - run after a successful deployment. afterFailedDeployment - run after a failed deployment. Only applicable to job processes.
beforeDeployment, afterSuccessDeployment, afterFailedDeployment "beforeDeployment"
Kubernetes liveness probe configuration. Only applicable to web processes.
Kubernetes readiness probe configuration. Only applicable to web processes.
Default Response
Unique identifier for the process
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"fb5e5168-4281-4bec-94c5-0d1584e9e657"
Identifier of the application this process belongs to
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"fb5e5168-4281-4bec-94c5-0d1584e9e657"
Unique key identifying the process within the application, derived from the Procfile entry name
1 - 64"web"
Process runtime type. web - HTTP server process that handles incoming web traffic. worker - background process that runs continuously. cron - scheduled process that runs at specified intervals. job - one-time process that runs to completion and then stops.
web, worker, cron, job "web"
Human-readable name for the process shown in the dashboard
1 - 255"Web Process"
Command used to start the process
1024"npm start"
Port number the process listens on for incoming connections
1 <= x <= 655358080
Whether external traffic routing is enabled for this process. Only applicable to web processes.
true
Protocol used for ingress traffic. http - standard HTTP/HTTPS traffic. grpc - gRPC protocol. Only applicable to web processes.
http, grpc "http"
Scaling configuration for the process
{
"type": "manual",
"config": { "instanceCount": 1 }
}Identifier of the process resource type (machine size) assigned to this process. Use the List Process Resource Types endpoint to retrieve available options.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"fb5e5168-4281-4bec-94c5-0d1584e9e657"
Name of the resource type (machine size) assigned to this process
"s1"
Maximum CPU allocation in millicores
1 <= x <= 9007199254740991500
Maximum memory allocation in megabytes
1 <= x <= 9007199254740991512
Cron expression defining the execution schedule. Only applicable to cron processes.
100"0 * * * *"
IANA time zone for the cron schedule. Only applicable to cron processes.
100"America/New_York"
When the job process should run relative to deployments. beforeDeployment - run before the deployment starts. afterSuccessDeployment - run after a successful deployment. afterFailedDeployment - run after a failed deployment. Only applicable to job processes.
beforeDeployment, afterSuccessDeployment, afterFailedDeployment "afterSuccessDeployment"
Kubernetes liveness probe configuration. Used to detect when a process is stuck and needs to be restarted. Only populated for web processes.
{
"httpGet": {
"path": "/health",
"port": 8080,
"scheme": "HTTP"
}
}Kubernetes readiness probe configuration. Used to determine when a process is ready to receive traffic. Only populated for web processes.
{
"httpGet": {
"path": "/ready",
"port": 8080,
"scheme": "HTTP"
}
}Internal Kubernetes DNS hostname for service-to-service communication within the cluster
"my-app-web.my-app-abc123.svc.cluster.local"
Timestamp when the process was created, in ISO 8601 format
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$"2025-01-30T00:00:00.000Z"
Timestamp when the process was last modified, in ISO 8601 format
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$"2025-01-30T00:00:00.000Z"