Deploy code to a function

POST/projects/{project_id}/branches/{branch_id}/functions/{slug}/deploymentsDeploy code to a function

Creates a deployment for the function. Supply any subset of zip, environment, and runtime; omitted fields inherit the function's latest version. At least one field must be supplied. The first deployment of a function must include zip. The newest deployment becomes active.

Note: This endpoint is currently in Beta.

Parameters

project_idstringpathrequired

The Neon project ID

pattern ^[a-z0-9-]{1,60}$

branch_idstringpathrequired

The Neon branch ID

pattern ^[a-z0-9-]{1,60}$

slugstringpathrequired

The function slug

pattern ^[a-z0-9]{1,20}$

Request body

required

multipart/form-data

objectFunctionDeployRequest

environmentstring

Optional JSON object (a string-to-string map) of environment variables for the deployment, e.g. {"KEY":"VALUE"}. Carried as a JSON-encoded string because multipart form data does not support typed object parts. Values are write-only: they are encrypted at rest, and responses carry only the variable names (the `environment` array), never the values.

runtimestring

one of "nodejs24"

zipstring · binary

Optional ZIP archive of the function source code. Omit to reuse the latest version's bundle (a config-only change). Required for the first deployment of a function.

Example request

{
  "environment": "string",
  "runtime": "nodejs24",
  "zip": "binary"
}

Responses

objectNeonFunctionDeploymentResponse

deploymentobjectrequired

Show child attributes

created_atstringrequired

environmentarray of string

The NAMES of the deployment's environment variables, sorted. Values are encrypted at rest and are never returned — they are write-only. To change a value, deploy the variable with the new value; to remove a variable, deploy it with an empty value.

Show child attributes

errorstring

Human-readable reason the deployment build failed. Present only when `status` is `failed`.

idinteger · int32required

The deployment id, which is the platform version number (monotonic per function).

memory_mibinteger · int32required

runtimestringrequired

statusstringrequired

Build lifecycle status of the deployment.

one of "pending", "building", "completed", "failed"

Example response

{
  "deployment": {
    "created_at": "string",
    "environment": [
      "string"
    ],
    "error": "string",
    "id": 0,
    "memory_mib": 0,
    "runtime": "string",
    "status": "building"
  }
}

defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

branch_idrequiredpath parameter

slugrequiredpath parameter

curl -X POST 'https://console.neon.tech/api/v2/projects/string/branches/string/functions/string/deployments' \
  -H 'Content-Type: application/json' \
  -d '{"environment":"string","runtime":"nodejs24","zip":"binary"}'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/functions/string/deployments', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"environment":"string","runtime":"nodejs24","zip":"binary"}),
});
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/functions/string/deployments', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"environment\":\"string\",\"runtime\":\"nodejs24\",\"zip\":\"binary\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://console.neon.tech/api/v2/projects/string/branches/string/functions/string/deployments",
    headers={"Content-Type": "application/json"},
    data='{"environment":"string","runtime":"nodejs24","zip":"binary"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"environment":"string","runtime":"nodejs24","zip":"binary"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://console.neon.tech/api/v2/projects/string/branches/string/functions/string/deployments", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/string/branches/string/functions/string/deployments");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"environment\":\"string\",\"runtime\":\"nodejs24\",\"zip\":\"binary\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/string/branches/string/functions/string/deployments"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"environment\":\"string\",\"runtime\":\"nodejs24\",\"zip\":\"binary\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/branches/string/functions/string/deployments")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"environment\":\"string\",\"runtime\":\"nodejs24\",\"zip\":\"binary\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://console.neon.tech/api/v2/projects/string/branches/string/functions/string/deployments");
request.Content = new StringContent("{\"environment\":\"string\",\"runtime\":\"nodejs24\",\"zip\":\"binary\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "deployment": {
    "created_at": "string",
    "environment": [
      "string"
    ],
    "error": "string",
    "id": 0,
    "memory_mib": 0,
    "runtime": "string",
    "status": "building"
  }
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}