# Functions

Neon Management API — Functions endpoints.

---

> API Reference / Functions / List functions on the branch

## GET /projects/{project_id}/branches/{branch_id}/functions

Lists functions on the specified branch.

**Note**: This endpoint is currently in Private Beta.


### Parameters

- `project_id` (string, path, required)
  The Neon project ID
- `branch_id` (string, path, required)
  The Neon branch ID
- `cursor` (string, query, optional)
  A cursor to use in pagination. A cursor defines your place in the data list. Include `response.pagination.next` in subsequent API calls to fetch next page of the list.
- `limit` (integer, query, optional)
  Specify a value from 1 to 1000 to limit number of functions in the response

### Response (200)

- `functions` (array, optional)
  - `id` (string, required)
    Opaque, stable function identifier.
  - `slug` (string, required)
    Branch-unique, lowercase DNS-label. Forms the invocation URL's host together with the branch id. Immutable.
  - `name` (string, required)
    Free-form display name.
  - `invocation_url` (string, required)
    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).
  - `current_deployment` (object, optional)
    - `id` (integer, required, format: int32)
      The deployment id, which is the platform version number (monotonic per function).
    - `status` (string, required)
      Build lifecycle status of the deployment.
      Possible values: `pending`, `building`, `completed`, `failed`
    - `memory_mib` (integer, required, format: int32)
    - `runtime` (string, required)
    - `created_at` (string, required)
    - `environment` (array, optional)
      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.
      
    - `error` (string, optional)
      Human-readable reason the deployment build failed. Present only
      when `status` is `failed`.
      
  - `active_deployment` (object, optional)
    - `id` (integer, required, format: int32)
      The deployment id, which is the platform version number (monotonic per function).
    - `status` (string, required)
      Build lifecycle status of the deployment.
      Possible values: `pending`, `building`, `completed`, `failed`
    - `memory_mib` (integer, required, format: int32)
    - `runtime` (string, required)
    - `created_at` (string, required)
    - `environment` (array, optional)
      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.
      
    - `error` (string, optional)
      Human-readable reason the deployment build failed. Present only
      when `status` is `failed`.
      
  - `created_at` (string, required)
- `pagination` (object, optional)
  To paginate the response, issue an initial request with `limit` value. Then, add the value returned in the response `.pagination.next` attribute into the request under the `cursor` query parameter to the subsequent request to retrieve next page in pagination. The contents on cursor `next` are opaque, clients are not expected to make any assumptions on the format of the data inside the cursor.
  - `next` (string, optional)
  - `sort_by` (string, optional)
  - `sort_order` (string, optional)

### Code examples

```bash
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/functions" \
  -H "Authorization: Bearer $NEON_API_KEY"
```

```typescript
import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.listProjectBranchFunctions({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID,
    branch_id: process.env.BRANCH_ID
  }
});
```

### Errors

**default**
General 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.

- `request_id` (string, optional)
  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.
  
- `code` (string, required)
  Default: ``
- `message` (string, required)
  Error message

---

> API Reference / Functions / Get function details

## GET /projects/{project_id}/branches/{branch_id}/functions/{slug}

Returns the function identified by its slug.

**Note**: This endpoint is currently in Private Beta.


### Parameters

- `project_id` (string, path, required)
  The Neon project ID
- `branch_id` (string, path, required)
  The Neon branch ID
- `slug` (string, path, required)
  The function slug

### Response (200)

- `function` (object, optional)
  - `id` (string, required)
    Opaque, stable function identifier.
  - `slug` (string, required)
    Branch-unique, lowercase DNS-label. Forms the invocation URL's host together with the branch id. Immutable.
  - `name` (string, required)
    Free-form display name.
  - `invocation_url` (string, required)
    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).
  - `current_deployment` (object, optional)
    - `id` (integer, required, format: int32)
      The deployment id, which is the platform version number (monotonic per function).
    - `status` (string, required)
      Build lifecycle status of the deployment.
      Possible values: `pending`, `building`, `completed`, `failed`
    - `memory_mib` (integer, required, format: int32)
    - `runtime` (string, required)
    - `created_at` (string, required)
    - `environment` (array, optional)
      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.
      
    - `error` (string, optional)
      Human-readable reason the deployment build failed. Present only
      when `status` is `failed`.
      
  - `active_deployment` (object, optional)
    - `id` (integer, required, format: int32)
      The deployment id, which is the platform version number (monotonic per function).
    - `status` (string, required)
      Build lifecycle status of the deployment.
      Possible values: `pending`, `building`, `completed`, `failed`
    - `memory_mib` (integer, required, format: int32)
    - `runtime` (string, required)
    - `created_at` (string, required)
    - `environment` (array, optional)
      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.
      
    - `error` (string, optional)
      Human-readable reason the deployment build failed. Present only
      when `status` is `failed`.
      
  - `created_at` (string, required)

### Code examples

```bash
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/functions/$SLUG" \
  -H "Authorization: Bearer $NEON_API_KEY"
```

```typescript
import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.getProjectBranchFunction({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID,
    branch_id: process.env.BRANCH_ID,
    slug: process.env.SLUG
  }
});
```

### Errors

**default**
General 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.

- `request_id` (string, optional)
  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.
  
- `code` (string, required)
  Default: ``
- `message` (string, required)
  Error message

---

> API Reference / Functions / Update a function

## PATCH /projects/{project_id}/branches/{branch_id}/functions/{slug}

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 Private Beta.


### Parameters

- `project_id` (string, path, required)
  The Neon project ID
- `branch_id` (string, path, required)
  The Neon branch ID
- `slug` (string, path, required)
  The function slug

### Request body

- `name` (string, required)
  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.
  

### Response (200)

- `function` (object, optional)
  - `id` (string, required)
    Opaque, stable function identifier.
  - `slug` (string, required)
    Branch-unique, lowercase DNS-label. Forms the invocation URL's host together with the branch id. Immutable.
  - `name` (string, required)
    Free-form display name.
  - `invocation_url` (string, required)
    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).
  - `current_deployment` (object, optional)
    - `id` (integer, required, format: int32)
      The deployment id, which is the platform version number (monotonic per function).
    - `status` (string, required)
      Build lifecycle status of the deployment.
      Possible values: `pending`, `building`, `completed`, `failed`
    - `memory_mib` (integer, required, format: int32)
    - `runtime` (string, required)
    - `created_at` (string, required)
    - `environment` (array, optional)
      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.
      
    - `error` (string, optional)
      Human-readable reason the deployment build failed. Present only
      when `status` is `failed`.
      
  - `active_deployment` (object, optional)
    - `id` (integer, required, format: int32)
      The deployment id, which is the platform version number (monotonic per function).
    - `status` (string, required)
      Build lifecycle status of the deployment.
      Possible values: `pending`, `building`, `completed`, `failed`
    - `memory_mib` (integer, required, format: int32)
    - `runtime` (string, required)
    - `created_at` (string, required)
    - `environment` (array, optional)
      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.
      
    - `error` (string, optional)
      Human-readable reason the deployment build failed. Present only
      when `status` is `failed`.
      
  - `created_at` (string, required)

### Code examples

```bash
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/functions/$SLUG" \
  -X PATCH \
  -H "Authorization: Bearer $NEON_API_KEY"
```

```typescript
import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.updateProjectBranchFunction({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID,
    branch_id: process.env.BRANCH_ID,
    slug: process.env.SLUG
  }
});
```

### Errors

**default**
General 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.

- `request_id` (string, optional)
  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.
  
- `code` (string, required)
  Default: ``
- `message` (string, required)
  Error message

---

> API Reference / Functions / Delete a function on the branch

## DELETE /projects/{project_id}/branches/{branch_id}/functions/{slug}

Deletes the function identified by its slug.

**Note**: This endpoint is currently in Private Beta.


### Parameters

- `project_id` (string, path, required)
  The Neon project ID
- `branch_id` (string, path, required)
  The Neon branch ID
- `slug` (string, path, required)
  The function slug

### Code examples

```bash
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/functions/$SLUG" \
  -X DELETE \
  -H "Authorization: Bearer $NEON_API_KEY"
```

```typescript
import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.deleteProjectBranchFunction({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID,
    branch_id: process.env.BRANCH_ID,
    slug: process.env.SLUG
  }
});
```

### Errors

**default**
General 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.

- `request_id` (string, optional)
  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.
  
- `code` (string, required)
  Default: ``
- `message` (string, required)
  Error message

---

> API Reference / Functions / Deploy code to a function

## POST /projects/{project_id}/branches/{branch_id}/functions/{slug}/deployments

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 Private Beta.


### Parameters

- `project_id` (string, path, required)
  The Neon project ID
- `branch_id` (string, path, required)
  The Neon branch ID
- `slug` (string, path, required)
  The function slug

### Request body


### Response (201)

- `deployment` (object, optional)
  - `id` (integer, required, format: int32)
    The deployment id, which is the platform version number (monotonic per function).
  - `status` (string, required)
    Build lifecycle status of the deployment.
    Possible values: `pending`, `building`, `completed`, `failed`
  - `memory_mib` (integer, required, format: int32)
  - `runtime` (string, required)
  - `created_at` (string, required)
  - `environment` (array, optional)
    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.
    
  - `error` (string, optional)
    Human-readable reason the deployment build failed. Present only
    when `status` is `failed`.
    

### Code examples

```bash
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/functions/$SLUG/deployments" \
  -X POST \
  -H "Authorization: Bearer $NEON_API_KEY"
```

```typescript
import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.createProjectBranchFunctionDeployment({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID,
    branch_id: process.env.BRANCH_ID,
    slug: process.env.SLUG
  }
});
```

### Errors

**default**
General 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.

- `request_id` (string, optional)
  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.
  
- `code` (string, required)
  Default: ``
- `message` (string, required)
  Error message