Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vast.ai/llms.txt

Use this file to discover all available pages before exploring further.

Update an existing serverless endpoint group.

​
Signature

VastAI.update_endpoint(
    id: int,
    min_load: Optional[float] = None,
    target_util: Optional[float] = None,
    cold_mult: Optional[float] = None,
    cold_workers: Optional[int] = None,
    max_workers: Optional[int] = None,
    endpoint_name: Optional[str] = None
) -> str

​
Parameters

​
id
int
required
ID of the endpoint to update.
​
min_load
Optional[float]
Minimum load (requests/sec) below which idle workers are scaled down.
​
target_util
Optional[float]
Target worker utilization ratio (0.0-1.0).
​
cold_mult
Optional[float]
Multiplier applied to warm worker count for pre-warming cold workers.
​
cold_workers
Optional[int]
Number of pre-warmed (cold) workers to keep ready.
​
max_workers
Optional[int]
Maximum number of workers allowed in this endpoint.
​
endpoint_name
Optional[str]
Human-readable name for the endpoint.

​
Returns

str, Result from the API call.

​
Example

from vastai import VastAI

client = VastAI(api_key="YOUR_API_KEY")
result = client.update_endpoint(id=12345)
print(result)