Apply Serve config

Push a new Serve config. The controller performs a rolling update if the config differs from the active one.

PUT /api/serve/applications

Apply Serve config

cURL

curl --request PUT \
  --url http://{host}:{port}/api/serve/applications/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "applications": [
    {
      "name": "search",
      "import_path": "my_module:app",
      "route_prefix": "/",
      "args": {},
      "runtime_env": {},
      "deployments": [
        {
          "name": "<string>",
          "num_replicas": 1,
          "max_ongoing_requests": 2,
          "ray_actor_options": {
            "num_cpus": 2,
            "num_gpus": 1
          },
          "autoscaling_config": {
            "min_replicas": 1,
            "max_replicas": 2,
            "initial_replicas": 1,
            "target_ongoing_requests": 1,
            "metrics_interval_s": 1,
            "look_back_period_s": 1,
            "smoothing_factor": 1,
            "downscale_delay_s": 1,
            "upscale_delay_s": 1
          },
          "user_config": {},
          "graceful_shutdown_timeout_s": 1,
          "health_check_period_s": 1,
          "health_check_timeout_s": 1
        }
      ]
    }
  ],
  "proxy_location": "EveryNode",
  "http_options": {
    "host": "0.0.0.0",
    "port": 8000,
    "request_timeout_s": 123
  },
  "grpc_options": {
    "port": 9000,
    "grpc_servicer_functions": [
      "<string>"
    ]
  }
}
'

400

{
  "error": "<string>"
}

Body

application/json

applications · object[] · required

Show child attributes

proxy_location · enum<string> · default: EveryNode

Available options: EveryNode, HeadOnly, Disabled

http_options · object

Show child attributes

grpc_options · object

Show child attributes

Response

200

Config accepted