--- operationId: "updateProjectEndpoint" method: "PATCH" path: "/projects/{project_id}/endpoints/{endpoint_id}" tag: "endpoints" interfaces: ["api", "sdk", "console"] --- > API Reference / Endpoints / Update compute endpoint ## PATCH /projects/{project_id}/endpoints/{endpoint_id} Updates the specified compute endpoint. An `endpoint_id` has an `ep-` prefix. A `branch_id` has a `br-` prefix. For more information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/). If the returned list of operations is not empty, the compute endpoint is not ready to use. The client must wait for the last operation to finish before using the compute endpoint. If the compute endpoint was idle before the update, it becomes active for a short period of time, and the control plane suspends it again after the update. ### Parameters - `project_id` (string, path, required) The Neon project ID - `endpoint_id` (string, path, required) The endpoint ID ### Request body - `endpoint` (object, required) - `branch_id` (string, optional, deprecated) DEPRECATED: This field will be removed in a future release. The destination branch ID. The destination branch must not have an existing read-write endpoint. - `autoscaling_limit_min_cu` (number, optional) The minimum number of Compute Units. The minimum value is `0.25`. See [Compute size and Autoscaling configuration](https://neon.com/docs/manage/endpoints#compute-size-and-autoscaling-configuration) for more information. - `autoscaling_limit_max_cu` (number, optional) The maximum number of Compute Units. See [Compute size and Autoscaling configuration](https://neon.com/docs/manage/endpoints#compute-size-and-autoscaling-configuration) for more information. - `provisioner` (string, optional) The Neon compute provisioner. Specify the `k8s-neonvm` provisioner to create a compute endpoint that supports Autoscaling. Provisioner can be one of the following values: * k8s-pod * k8s-neonvm * serverless-platform Clients must expect, that any string value that is not documented in the description above should be treated as a error. UNKNOWN value if safe to treat as an error too. - `settings` (object, optional) A collection of settings for a compute endpoint - `pg_settings` (object, optional) A raw representation of Postgres settings - `pgbouncer_settings` (object, optional, deprecated) DEPRECATED. PgBouncer settings for the compute endpoint. This field is deprecated and will be removed after 2026-06-20. - `preload_libraries` (object, optional) The shared libraries to preload into the project's compute instances. - `use_defaults` (boolean, optional) - `enabled_libraries` (array, optional) - `pooler_enabled` (boolean, optional, deprecated) DEPRECATED. Whether to enable connection pooling for the compute endpoint. The recommended way to enable connection pooling is to append `-pooler` to the endpoint ID in the connection string. See [How to use connection pooling](https://neon.com/docs/connect/connection-pooling#how-to-use-connection-pooling) - `pooler_mode` (string, optional, deprecated) DEPRECATED. The connection pooler mode. This field is deprecated and will be removed after 2026-06-20. Possible values: `transaction` - `disabled` (boolean, optional) Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action. However, the compute endpoint is periodically enabled by check_availability operations. - `passwordless_access` (boolean, optional) NOT YET IMPLEMENTED. Whether to permit passwordless access to the compute endpoint. - `suspend_timeout_seconds` (integer, optional, format: int64) Duration of inactivity in seconds after which the compute endpoint is automatically suspended. The value `0` means use the default value. The value `-1` means never suspend. The default value is `300` seconds (5 minutes). The minimum value is `60` seconds (1 minute). The maximum value is `604800` seconds (1 week). For more information, see [Scale to zero configuration](https://neon.com/docs/manage/endpoints#scale-to-zero-configuration). - `name` (string, optional) Optional name of the compute endpoint ```json { "endpoint": { "suspend_timeout_seconds": 300 } } ``` ### Response (200) ```json { "endpoint": { "host": "ep-cool-darkness-a5b6c7d8.c-3.us-east-2.aws.neon.tech", "hosts": { "read_only_host": "ep-cool-darkness-a5b6c7d8.c-3.us-east-2.aws.neon.tech", "read_only_pooled_host": "ep-cool-darkness-a5b6c7d8-pooler.c-3.us-east-2.aws.neon.tech" }, "id": "ep-cool-darkness-a5b6c7d8", "slug": "ep-cool-darkness-a5b6c7d8", "branch_slug": "br-young-forest-a5b6c7d8", "project_slug": "aged-wildflower-123456", "project_id": "aged-wildflower-123456", "branch_id": "br-young-forest-a5b6c7d8", "autoscaling_limit_min_cu": 1, "autoscaling_limit_max_cu": 1, "region_id": "aws-us-east-2", "type": "read_only", "current_state": "idle", "group": { "size": { "min": 1, "max": 1 }, "allow_readable_secondaries": true, "computes": [ { "binding_id": "ygk", "current_state": "idle", "role": "read_only", "compute_host": "ep-cool-darkness-a5b6c7d8-ygk.c-3.us-east-2.aws.neon.tech", "compute_pooled_host": "ep-cool-darkness-a5b6c7d8-ygk-pooler.c-3.us-east-2.aws.neon.tech", "created_at": "2025-01-15T10:30:00Z", "updated_at": "2025-01-15T10:30:00Z" } ] }, "settings": { "pg_settings": {} }, "pooler_enabled": false, "pooler_mode": "transaction", "disabled": false, "passwordless_access": true, "last_active": "2025-01-15T10:30:00Z", "creation_source": "console", "created_at": "2025-01-15T10:30:00Z", "updated_at": "2025-01-15T10:30:00Z", "proxy_host": "c-3.us-east-2.aws.neon.tech", "suspend_timeout_seconds": 0, "provisioner": "k8s-neonvm" }, "operations": [] } ``` ### Code examples ```bash curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/endpoints/$ENDPOINT_ID" \ -X PATCH \ -H "Authorization: Bearer $NEON_API_KEY" \ -H "Content-Type: application/json" \ -d '{"endpoint":{"suspend_timeout_seconds":300}}' ``` ```typescript import { createNeonClient, raw } from '@neon/sdk'; const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY }); const { data } = await raw.updateProjectEndpoint({ client: neon.client, path: { project_id: process.env.PROJECT_ID, endpoint_id: process.env.ENDPOINT_ID }, body: { endpoint: { suspend_timeout_seconds: 300 } } }); ``` ### Console Console path: Projects → Branches → Computes ### 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