API reference · Schema
ServerlessRelease
objectstringrequiredAlways `serverless_release`: the type of this object
One of
serverless_releaseidstringrequiredUnique ID (`srl_…`)
ID with prefix srl_
endpoint_idstringrequiredID of the endpoint
ID with prefix sep_
versionintegerrequiredRelease number within the endpoint: 1, 2, 3… (never reused)
statusstringrequired`rolling_out`: the current release while workers of older releases remain. `active`: the current release, every worker runs it. `superseded`: a newer release replaced it.
One of
rolling_outactivesupersededsourcestringrequiredWhat made the release: `created` (the endpoint was created), `updated` (an update changed the worker spec) or `rollback` (a copy of `based_on_release_id`)
One of
createdupdatedrollbackbased_on_release_idstring | nullrequiredID of the based on release
imagestringrequiredContainer image reference
registry_credential_idstring | nullrequiredID of the registry credential
commandarray of stringrequiredEntrypoint override; empty: the image's own
argsarray of stringrequiredArguments override; empty: the image's own
Environment variables; secrets appear only as references
skusarray of stringrequiredAcceptable hardware in order of preference
gpu_countintegerrequiredNumber of GPUs
concurrencyintegerrequiredJobs or HTTP requests one worker takes at once
disk_bytesintegerrequiredLimit on each worker's writable disk, in bytes (0: no limit beyond the host's)
Models the worker mounts from the host’s model cache
ShowHide 1 field of
modelsreference_idstringrequiredA model reference of this project (POST /v1/model-references). Its files are cached on the host and mounted read-only at /model-cache/models--<owner>--<name> before the worker starts; HF_HUB_CACHE points there unless env sets it.
ID with prefix mrf_
httpobject | nullrequiredHTTP endpoints: where the container serves (null for queue)
ShowHide 2 fields of
httpportintegerrequiredThe port the container serves HTTP on
health_pathstringrequiredPath probed (GET; 2xx or 3xx is healthy) before a worker takes requests
Network volumes mounted into every worker; workers run on the host they are pinned to
ShowHide 3 fields of
volumesvolume_idstringrequiredID of the volume
ID with prefix vol_
mount_pathstringrequiredWhere every worker sees the volume
read_onlybooleanrequiredWorkers cannot write to it
created_atstring (date-time)requiredWhen it was created (ISO 8601, UTC)
completed_atstring (date-time) | nullrequiredWhen no worker of an older release remained
{
"object": "serverless_release",
"id": "srl_01jc5zq4m8k3v6x9t2w7r0b1e4",
"endpoint_id": "sep_01jc5zq4m8k3v6x9t2w7r0b1e4",
"version": 1,
"status": "rolling_out",
"source": "created",
"based_on_release_id": "string",
"image": "string",
"registry_credential_id": "string",
"command": [
"string"
],
"args": [
"string"
],
"env": [
{
"name": "string",
"value": "string"
}
],
"skus": [
"string"
],
"gpu_count": 1,
"concurrency": 1,
"disk_bytes": 1,
"models": [
{
"reference_id": "mrf_01jc5zq4m8k3v6x9t2w7r0b1e4"
}
],
"http": {
"port": 1,
"health_path": "string"
},
"volumes": [
{
"volume_id": "vol_01jc5zq4m8k3v6x9t2w7r0b1e4",
"mount_path": "string",
"read_only": true
}
],
"created_at": "2026-01-01T00:00:00.000Z",
"completed_at": "2026-01-01T00:00:00.000Z"
}Used by
- Release history, newest first
GET /v1/serverless/endpoints/{endpoint_id}/releases - Get a release
GET /v1/serverless/releases/{release_id} - Roll back: a new release with an earlier release's worker spec
POST /v1/serverless/endpoints/{endpoint_id}/rollback