> ## Documentation Index
> Fetch the complete documentation index at: https://docs.novita.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Endpoint

## Description

When updating an endpoint, all parameters must be provided in full.

## Request Headers

**Content-Type** `string` *required*

Enum: `application/json`

**Authorization** `string` *required*

Bearer authentication format, for example: Bearer \{\{API Key}}.

## Request Body

**id** `string` *required*

The Endpoint ID to update.

**name** `string`

Endpoint name.

**clusterID** `string`

Cluster information. Required when mounting cloud storage and must match the cluster ID where the cloud storage is located. String with a length limit of 0-255 characters.

**workerConfig** `object` *required*

Worker configuration. The valid range is dynamically retrieved through the parameter limits API.

**properties**

**minNum** `integer` *required*

Minimum number of workers.

**maxNum** `integer` *required*

Maximum number of workers.

**freeTimeout** `integer` *required*

Idle timeout in seconds.

**maxConcurrent** `integer` *required*

Maximum concurrency.

**gpuNum** `integer` *required*

Number of GPUs per worker.

**requestTimeout** `integer` *required*

Request timeout (seconds).

**ports** `object[]` *required*

HTTP ports. Only one port is supported. Supported port range: 1-65535, excluding internal ports 2222, 2223, and 2224.

**properties**

**port** `string` *required*

HTTP port.

**policy** `object` *required*

Scaling policy. The valid range is dynamically retrieved through the parameter limits API.

**properties**

**type** `string` *required*

Scaling policy type. Available values:

* `queue`: Queue latency policy, scales workers based on request wait time in the queue.
* `concurrency`: Queue request policy, scales workers based on the number of requests in the queue.

**value** `integer` *required*

The meaning of value depends on the type:

* When type = queue, value represents the queue wait time in seconds.
* When type = concurrency, value represents the maximum number of requests in the queue.

**image** `object` *required*

Container image configuration.

**properties**

**image** `string` *required*

Image address. String with a length limit of 0-511 characters.

**authId** `string`

Private image credential ID (not required for public images or platform user images). String with a length limit of 0-255 characters.

**command** `string`

Container startup command. String with a length limit of 0-2047 characters.

**volumeMounts** `object[]`

Storage configuration in GB.

**properties**

**type** `string` *required*

Storage type. Available values:

* `local`: Local storage.
* `network`: Network storage.

**size** `integer`

Local storage size, currently fixed at 30. Not required for network storage.

**id** `string`

Network storage ID. Not required for local storage.

**mountPath** `string` *required*

Storage mount path. String with a length limit of 0-255 characters.

**envs** `object[]`

Environment variables.

**properties**

**key** `string` *required*

Environment variable name.

**value** `string` *required*

Environment variable value.

**healthy** `object`

Health check endpoint configuration.

**properties**

**path** `string` *required*

The path for health checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.