Skip to main content
PATCH
Patch Endpoint Settings

Authorizations

Authorization
string
header
required

Pass your API key as a Bearer token. Create API keys in the project overview.

Path Parameters

endpoint_id
string
required

Unique endpoint ID.

Body

application/json

Fields to update. All fields are optional, but at least one must be provided.

container_start_command
string | null

Container start command.

Example:

"python app.py"

container_env_vars
object[] | null

Container environment variables.

container_port
integer | null

Container service port (1-65535).

Required range: 1 <= x <= 65535
Example:

8080

container_health_check_path
string | null

Health check endpoint path.

Example:

"/healthz"

container_health_check_timeout
integer | null

Container health check timeout in seconds.

Required range: x >= 1
Example:

30

health_check_timeout
integer | null

Overall health check timeout in seconds. Deployment fails if health check does not pass within this time.

Required range: x >= 1
Example:

300

container_metric_path
string | null

Prometheus metrics endpoint path.

Example:

"/metrics"

Response

Updated endpoint settings.

endpoint_id
string

Unique endpoint ID.

name
string

Endpoint name.

is_active
boolean

Active status (always false after successful patch).

container_start_command
string | null

Current start command.

container_env_vars
object[] | null

Current environment variables.

container_port
integer | null

Current port.

container_health_check_path
string | null

Current health check path.

container_health_check_timeout
integer | null

Current health check timeout.

health_check_timeout
integer | null

Current overall health check timeout.

container_metric_path
string | null

Current metric path.

updated_at
string<date-time>

Update time.