Skip to main content
Neon Docs

Search documentation

Type to search this documentation.

List functions on the branch

GET/projects/{project_id}/branches/{branch_id}/functionsList functions on the branch

Lists functions on the specified branch.

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}$

cursorstringquery

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.

limitintegerquery

Specify a value from 1 to 1000 to limit number of functions in the response

maximum 1000 · minimum 1

Responses

200The list of functionsapplication/json
value
allOf · 2 options
Option 1objectNeonFunctionsListResponse
functionsarray of objectrequired
Show child attributes
Show array items
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.

Option 2objectCursorPaginationResponse
paginationobject

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.

Show child attributes
nextstring

Cursor for the next page of results. Pass it as the `cursor` query parameter on the next request. Absent on the last page.

sort_bystring

Field by which the results were sorted, echoing the request's sort_by parameter.

sort_orderstring

Sort order active for this page. Pass back as `sort_order` in the next request to maintain consistent ordering. Valid values are `asc` and `desc`.

Example response
{
  "functions": [
    {
      "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"
    }
  ],
  "pagination": {
    "next": "string",
    "sort_by": "string",
    "sort_order": "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"
}
Documentation menu