# Use the HttpClient for Milvus REST Requests

Choose the REST-based HttpClient for HTTP-only and serverless runtimes. Connect to Milvus, configure timeouts, and handle HTTP errors.

SDK: `@zilliz/milvus2-sdk-node@3.0.10` · Tested with Milvus 3.0.6

Canonical documentation: https://milvus-io.github.io/milvus-sdk-node/advanced/http-client/

## Section links

- [HttpClient vs MilvusClient](https://milvus-io.github.io/milvus-sdk-node/advanced/http-client/#httpclient-vs-milvusclient)
- [Creating HTTP Client](https://milvus-io.github.io/milvus-sdk-node/advanced/http-client/#creating-http-client)
- [Using HTTP Client in Serverless Environments](https://milvus-io.github.io/milvus-sdk-node/advanced/http-client/#using-http-client-in-serverless-environments)
- [HTTP Client Configuration](https://milvus-io.github.io/milvus-sdk-node/advanced/http-client/#http-client-configuration)
- [Error Handling](https://milvus-io.github.io/milvus-sdk-node/advanced/http-client/#error-handling)
- [Best Practices](https://milvus-io.github.io/milvus-sdk-node/advanced/http-client/#best-practices)
- [Next Steps](https://milvus-io.github.io/milvus-sdk-node/advanced/http-client/#next-steps)
- [Operation shortcuts](https://milvus-io.github.io/milvus-sdk-node/advanced/http-client/#operation-shortcuts)

Use `HttpClient` to call Milvus REST v2 from runtimes with Fetch support, including HTTP-only edge and serverless platforms. Choose `MilvusClient` when your runtime supports gRPC and you need the SDK’s streaming or gRPC administration APIs.

## HttpClient vs MilvusClient

| Decision | MilvusClient (gRPC) | HttpClient (REST) |
| --- | --- | --- |
| Protocol | gRPC over HTTP/2 | Milvus REST v2 over HTTP with JSON |
| Request field casing | snake_case, such as `collection_name` | camelCase, such as `collectionName` |
| Serverless and edge support | Use in Node.js runtimes that support gRPC connections | Use in Fetch-capable runtimes, including HTTP-only serverless and edge environments |
| Streaming and gRPC-only admin RPCs | Supports replication and WAL streams, plus proxy and telemetry administration | Supports REST management operations and returns JSON responses |
| Response and error handling | Inspect `error_code` on a status or `status.error_code` on a result. Transport failures can reject. | Inspect `code` where the REST response provides it. Non-2xx responses throw `HttpError`. |

## Creating HTTP Client

```ts
import { HttpClient } from '@zilliz/milvus2-sdk-node';

const client = new HttpClient({
  endpoint: process.env.MILVUS_ENDPOINT ?? 'http://localhost:19530',
  token: process.env.MILVUS_TOKEN,
});

const { code, data } = await client.listCollections({ dbName: 'default' });
if (code !== 0) throw new Error(`Milvus returned code ${code}`);
console.log(data);
```

## Using HTTP Client in Serverless Environments

For edge runtimes without Node.js built-ins, import `HttpClient` from `@zilliz/milvus2-sdk-node/dist/milvus/HttpClient.js`.

See the deployment guides for [Cloudflare Workers](https://milvus-io.github.io/milvus-sdk-node/advanced/cloudflare/), [Vercel](https://milvus-io.github.io/milvus-sdk-node/advanced/vercel/), and [AWS Lambda](https://milvus-io.github.io/milvus-sdk-node/advanced/aws-lambda/).

## HTTP Client Configuration

See the [constructor and per-request options](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#constructor) for database defaults, timeouts, and custom Fetch implementations.

## Error Handling

Catch [`HttpError`](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#errors) for non-2xx HTTP responses. Inspect the Milvus `code` in successful HTTP responses.

## Best Practices

Use environment variables for credentials and reuse the client across requests in long-running services. See [Best Practices](https://milvus-io.github.io/milvus-sdk-node/advanced/best-practices/) for deployment advice.

## Next Steps

Use the [SDK reference](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/) to look up TypeScript methods, or use the [REST explorer](https://milvus-io.github.io/milvus-sdk-node/rest-api/) to run a request directly.

## Operation shortcuts

- [
  
  Why HTTP Client for Serverless?
  
  ](https://milvus-io.github.io/milvus-sdk-node/advanced/http-client/#using-http-client-in-serverless-environments)
- [
  
  Vercel Example
  
  ](https://milvus-io.github.io/milvus-sdk-node/advanced/vercel/)
- [
  
  Cloudflare Workers Example
  
  ](https://milvus-io.github.io/milvus-sdk-node/advanced/cloudflare/)
- [
  
  AWS Lambda Example
  
  ](https://milvus-io.github.io/milvus-sdk-node/advanced/aws-lambda/)
- [
  
  Serverless Best Practices
  
  ](https://milvus-io.github.io/milvus-sdk-node/advanced/http-client/#best-practices)
- [
  
  Collection Operations
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#collection-apis)
- [
  
  Create Collection
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createcollection)
- [
  
  List Collections
  
  ](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/list/)
- [
  
  Describe Collection
  
  ](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/describe/)
- [
  
  Drop Collection
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropcollection)
- [
  
  Vector Operations
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#data-apis)
- [
  
  Insert Vectors
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#insert)
- [
  
  Search Vectors
  
  ](https://milvus-io.github.io/milvus-sdk-node/rest-api/entities/search/)
- [
  
  Query Vectors
  
  ](https://milvus-io.github.io/milvus-sdk-node/rest-api/entities/query/)
- [
  
  Delete Vectors
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#delete)
- [
  
  Index Operations
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#index-apis)
- [
  
  Create Index
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createindex)
- [
  
  Describe Index
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#describeindex)
- [
  
  List Indexes
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listindexes)
- [
  
  Drop Index
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropindex)
- [
  
  Partition Operations
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#partition-apis)
- [
  
  Create Partition
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createpartition)
- [
  
  List Partitions
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listpartitions)
- [
  
  Drop Partition
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#droppartition)
- [
  
  Alias Operations
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#alias-apis)
- [
  
  Create Alias
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createalias)
- [
  
  List Aliases
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listaliases)
- [
  
  Drop Alias
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropalias)
- [
  
  Import Operations
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#import-apis)
- [
  
  Import Data
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createimportjobs)
- [
  
  User Operations
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#user-and-role-apis)
- [
  
  Create User
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createuser)
- [
  
  List Users
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listusers)
- [
  
  Role Operations
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#user-and-role-apis)
- [
  
  Create Role
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createrole)
- [
  
  List Roles
  
  ](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listroles)
