MultiConnectMultiConnectDocs Website home
MultiConnectCloud › API Deployments

3. Create an API deployment

  1. Open the dashboard and open your project.
  2. Click Create New Deployment, then choose API.
  3. Fill in the six steps below. Use Next and Back to move between them, and Submit on the last one.

The form checks every step before it uploads anything, and lists all the problems at once. The Deployment guide button at the top of the form opens packaging and connection help for the platform you picked.

Step 1: Basic Info

Field What to enter
Deployment Name How the deployment is listed in your project, for example orders-api. 3 to 60 characters: letters, numbers, spaces, hyphens and underscores, starting with a letter or number. It must be unique in the project. The name is not part of the URL

Step 2: Hosting Plan

Field What to enter
Hosting Plan The CPU, memory and storage each container gets, and the largest build zip you can upload (Max Upload Size). The form shows the plan's details and price

You pay the plan rate for every running container, by the hour. Three containers cost three times the plan rate. You can move to another plan later without downtime (Section 12). When you Update the deployment, this step shows the plan but does not change it.

Step 3: Runtime & Config

Field What to enter
Platform The runtime your build runs on. It cannot be changed later. See the table below. The help under each field covers every platform
Entry Point File .NET: required, the DLL named after your project, for example MyApi.dll. Node.js: the file node runs (empty means index.js). Flask and FastAPI: the file that defines app (empty means app.py or main.py). Django, Go and Java: leave empty. See Section 4
Start Command Optional. The field shows the default your platform runs when it is empty; type a command to replace it. Example: npm start. {PORT} in the command is replaced with the container's port
Web Socket On if clients keep a live two-way connection open (chat, live dashboards, notifications). Off for ordinary request and response APIs
Environment Variables Settings your code reads at start-up. Click Add Environment Variable, or Upload .env File. Set Secret to Yes for passwords and keys. See Section 5

The platforms:

Platform Runtime
.NET 10 ASP.NET Core 10 runtime
Node.js 22 Node.js 22, on Alpine Linux
Python Flask, Python FastAPI, Python Django Python 3.11
Go Go 1.26
Java Spring Boot Java 21 runtime

Step 4: Scaling & Regions

Field What to enter
Auto Scaling Managed (OFF): each region runs the number of containers you set. Automatic (ON): containers are added and removed with load
CPU Scale Up Threshold / Memory Scale Up Threshold Automatic only. Average use (%) above which a container is added. The form starts at 80
CPU Scale Down Threshold / Memory Scale Down Threshold Automatic only. Average use (%) below which a container is removed. The form starts at 30. Each must be lower than its scale-up value
Regions Click Add Region and pick a Region. Mark one region with Set as Primary. With Managed scaling, set Containers. With Automatic scaling, set Min Containers and Max Containers

Min containers always run and are always billed. Max is as far as autoscaling may grow, so it also caps your bill. Each plan sets the most containers a region can have. Two or more containers keep your API answering if one becomes unhealthy.

A region the plan cannot run in shows Not available for this plan. The Estimated monthly cost box shows the cost of the containers you picked.

Step 5: Access & Database

Both fields are optional.

Field What to enter
Access Keys Up to 5 of your account's access keys with Allow deploys (CLI) on, for the MultiConnect CLI. See Section 9
Linked Database A Database deployment from the same project, or No database. See Section 8

Step 6: Build

Drag your zip onto the box, or click it to choose the file. Only one .zip file is accepted, and it must be under the plan's Max Upload Size.

Click Submit. The build uploads from your browser, then the deployment starts. You can leave the page while it runs. Section 10 explains what happens next.