Update a function | Neon Docs

PATCH/projects/{project_id}/branches/{branch_id}/functions/{slug}Update a function

Updates the function's mutable metadata — currently only the display name. A string sets the display name; null clears it, after which the function's name falls back to its slug. Leading and trailing whitespace is trimmed; a whitespace-only name is rejected. Acts only on a function owned by the branch: a slug that is only inherited from an ancestor branch returns 404 — rename it on the branch that owns it. Like every other change on a branch, a rename is isolated per branch: a branch forked before the rename keeps the name it had at fork time.

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

application/json

objectNeonFunctionUpdateRequest

namenull | stringrequired

New display name for the function. `null` clears the display name; the function's `name` then falls back to its slug. Leading and trailing whitespace is trimmed; a whitespace-only name is rejected.

maxLength 256 · minLength 1

Example request

{
  "name": "string"
}

Responses

objectNeonFunctionResponse

functionobjectrequired

Show child attributes

active_deploymentvalue

The most recent deployment whose build completed successfully. This is the deployment that serves invocations. Omitted until a deployment succeeds.

Show child attributes

allOf · 1 option

Option 1objectNeonFunctionDeployment

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"

created_atstringrequired

current_deploymentvalue

The most recent deployment, regardless of build status. It may still be building or it may have failed. Omitted until the first deployment is created.

Show child attributes

allOf · 1 option

Option 1: NeonFunctionDeployment ↑

idstringrequired

Opaque, stable function identifier.

invocation_urlstringrequired

URL at which the function is invoked. The host carries `<branch_id>-<slug>` as its first DNS label under a Neon-managed functions domain, and the URL ends with a trailing slash so paths concatenate onto it. Empty string when the function has no servable invoke host (e.g. a deployment without an invocation front-door).

namestringrequired

Free-form display name.

slugstringrequired

Branch-unique, lowercase DNS-label. Forms the invocation URL's host together with the branch id. Immutable.

Example response

{
  "function": {
    "active_deployment": {
      "created_at": "string",
      "environment": [
        "string"
      ],
      "error": "string",
      "id": 0,
      "memory_mib": 0,
      "runtime": "string",
      "status": "building"
    },
    "created_at": "string",
    "current_deployment": {
      "created_at": "string",
      "environment": [
        "string"
      ],
      "error": "string",
      "id": 0,
      "memory_mib": 0,
      "runtime": "string",
      "status": "building"
    },
    "id": "string",
    "invocation_url": "string",
    "name": "string",
    "slug": "string"
  }
}

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 PATCH 'https://console.neon.tech/api/v2/projects/string/branches/string/functions/string' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string"}'

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

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

import requests

response = requests.request(
    "PATCH",
    "https://console.neon.tech/api/v2/projects/string/branches/string/functions/string",
    headers={"Content-Type": "application/json"},
    data='{"name":"string"}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"name":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://console.neon.tech/api/v2/projects/string/branches/string/functions/string", 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");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"name\":\"string\"}");
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"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"name\":\"string\"}"))
    .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")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"name\":\"string\"}"
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.Patch, "https://console.neon.tech/api/v2/projects/string/branches/string/functions/string");
request.Content = new StringContent("{\"name\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "function": {
    "active_deployment": {
      "created_at": "string",
      "environment": [
        "string"
      ],
      "error": "string",
      "id": 0,
      "memory_mib": 0,
      "runtime": "string",
      "status": "building"
    },
    "created_at": "string",
    "current_deployment": {
      "created_at": "string",
      "environment": [
        "string"
      ],
      "error": "string",
      "id": 0,
      "memory_mib": 0,
      "runtime": "string",
      "status": "building"
    },
    "id": "string",
    "invocation_url": "string",
    "name": "string",
    "slug": "string"
  }
}

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