Skip to main content
GET
Get deployment

Authorizations

​
Authorization
string
header
required

API key with the vk_ prefix. Create one from the dashboard.

Path Parameters

​
deployment_id
string
required

Deployment ID

Response

The deployment

​
object
string
required
​
id
string
required
​
status
enum<string>
required
Available options:
queued,
provisioning,
serving,
unhealthy,
stopped,
failed,
scaled_to_zero,
waking
​
name
string
required
​
model
string
required
​
source
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
source_model_id
string | null

For a custom_model deployment, the saved model this was created from (provenance). Also set on a source=huggingface deployment that took the transparent cache hit (serving from the caller's cached S3 copy). Null otherwise.

​
cache_model_id
string | null

HF cache-through: the library model (status importing) this deployment's box is uploading its snapshot into. Null unless the deployment was created with cache=true and the upload is the one this boot owns.

​
endpoint_url
string | null
​
gpu
null | object

Pydantic GPUInfo (with type field). Rust uses gpu_type internally but serializes as "type" for JSON parity.

​
provider
string | null
​
byoc_repo
string | null

BYOC (provider='huggingface'): the HF hub repository this endpoint serves under the owner's account. Null for every non-BYOC deployment.

​
engine
string | null
​
vllm_extra_args
string[] | null

VS-370: the extra vLLM CLI flags this deployment was created with (argv list). Null unless supplied at create.

​
vllm_image
string | null

VS-426: the explicit vLLM serving image this deployment was created with. Null unless supplied at create.

​
startup_profiling
boolean

Whether this deployment was created with startup diagnostics on.

​
trace_bodies
boolean

Whether request/response bodies are captured as traces.

​
trace_retention
string | null

Trace retention class ("extended" or null = base). Null unless trace_bodies deployments set it.

​
startup_metrics
any

Startup phase timings reported by a profiled deployment's first healthy heartbeat (seconds: model_sync_s, engine_start_to_healthy_s, total_s). Null unless startup_profiling was set and the engine reached healthy.

​
num_replicas
integer<int32>

VS-341: DESIRED replica count (GPU boxes) behind this deployment. The observed count is ready_replicas — the K8s spec/status split; the CLI renders "ready/desired" (e.g. 2/3).

​
ready_replicas
integer<int32>

Observed: replicas currently serving with a routable endpoint.

​
min_replicas
integer<int32>

Replica-count bounds. min == max => fixed N (autoscaling off).

​
max_replicas
integer<int32>
​
concurrency_target
number<double> | null

Per-replica concurrency setpoint (stored as target_ongoing_requests).

​
scale_to_zero_window_seconds
integer<int32> | null

VS-313: idle window before a min=0 deployment parks (None = 3600s).

​
idle_delete_after_days
integer<int32> | null

VS-313: parked-deployment GC in days (None = kept forever).

​
cost_per_hour_usd
number<double> | null
​
total_cost_usd
number<double> | null
​
total_requests
integer<int32>
​
error
string | null
​
started_at
string<date-time> | null
​
stopped_at
string<date-time> | null