Sign in

v1

latestOpenAPI 3.1.02026-07-134612587.0 KB
Endpoints

Scale endpoint to zero [WRITE]

Scale the endpoint down to zero replicas and mark it as Stopped. The endpoint's spec must have scale-to-zero enabled (scaling.scaleToZeroTimeout set); otherwise the call returns 400 "workload cannot be scaled to zero". Not valid when the workload is in the Deleting stage. Use POST /resume to wake the endpoint back up.

post/v2/endpoint/{namespace}/{name}/scale-to-zero

Path parameters

namespacestring required

User or organization name

namestring required

Endpoint name

Response

Endpoint scaled to zero successfully

healthRoutestring required

Endpoint health route

namestring required

Endpoint name. Must only contains lowercase alphanumeric characters or '-' and have a length of 32 characters maximum

tagsstring[] required
type'public' | 'authenticated' | 'private' required

Endpoint visibility and authentication mode

Example response

{
  "compute": {
    "instanceSize": "x1",
    "instanceType": "intel-spr",
    "scaling": {
      "maxReplica": 4,
      "measure": {
        "hardwareUsage": 80
      },
      "minReplica": 1,
      "scaleToZeroTimeout": 15
    }
  },
  "model": {
    "env": {
      "MAX_CONCURRENT_REQUESTS": "128"
    },
    "image": {
      "tgi": {
        "healthRoute": "/health",
        "port": 80,
        "url": "https://host/image:tag",
        "maxBatchPrefillTokens": 2048,
        "maxBatchTotalTokens": 2048,
        "maxInputLength": 1024,
        "maxTotalTokens": 1512,
        "disableCustomKernels": true
      }
    },
    "repository": "meta-llama/Llama-2-7b-hf",
    "revision": "main",
    "secrets": {
      "HF_TOKEN": "hf_xxx"
    }
  },
  "name": "my-endpoint",
  "network": {
    "cidrList": [
      "10.0.0.0/8"
    ]
  },
  "privateService": {
    "accountId": "123456789012"
  },
  "provider": {
    "region": "us-east-1",
    "vendor": "aws"
  },
  "route": {
    "domain": "api.example.com",
    "path": "/v1/models/gpt2"
  },
  "status": {
    "readyReplica": 2,
    "targetReplica": 4,
    "url": "https://endpoint-id.region.vendor.endpoints.huggingface.cloud"
  }
}