Skip to main content
POST
https://api.novita.ai
/
gpu-instance
/
openapi
/
v1
/
endpoint
/
update
Update Endpoint
curl --request POST \
  --url https://api.novita.ai/gpu-instance/openapi/v1/endpoint/update \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "id": "<string>",
  "name": "<string>",
  "clusterID": "<string>",
  "workerConfig": {
    "minNum": 123,
    "maxNum": 123,
    "freeTimeout": 123,
    "maxConcurrent": 123,
    "gpuNum": 123
  },
  "ports": [
    {
      "port": "<string>"
    }
  ],
  "policy": {
    "type": "<string>",
    "value": 123
  },
  "image": {
    "image": "<string>",
    "authId": "<string>",
    "command": "<string>"
  },
  "volumeMounts": [
    {
      "type": "<string>",
      "size": 123,
      "id": "<string>",
      "mountPath": "<string>"
    }
  ],
  "envs": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "healthy": {
    "path": "<string>"
  }
}
'

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.
ports
object[]
required
HTTP ports. Only one port is supported. Supported port range: 1-65535, excluding internal ports 2222, 2223, and 2224.
policy
object
required
Scaling policy. The valid range is dynamically retrieved through the parameter limits API.
image
object
required
Container image configuration.
volumeMounts
object[]
Storage configuration in GB.
envs
object[]
Environment variables.
healthy
object
Health check endpoint configuration.