/projects/{project_id}Update projectUpdates the specified project. Configurable properties include the project name, default compute settings, history retention period, and IP allowlist.
Parameters
project_idstringpathrequiredThe Neon project ID
Request body
requiredapplication/json
projectobjectrequiredShow child attributes
default_endpoint_settingsobjectA collection of settings for a Neon endpoint
Show child attributes
autoscaling_limit_max_cunumberautoscaling_limit_min_cunumberpg_settingsobjectA raw representation of Postgres settings
pgbouncer_settingsobjectDeprecated. A raw representation of PgBouncer settings. Removal scheduled for June 20, 2026.
suspend_timeout_secondsinteger · int64Duration 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).
history_retention_secondsinteger · int32History window (point-in-time restore range) for all branches, in seconds. `0` disables it. Default 1 day (Free: 6 hours). Maximum depends on plan: Free 6 hours (21600), Launch 7 days (604800), Scale 30 days (2592000).
namestringThe project name
settingsobjectShow child attributes
allowed_ipsobjectA list of IP addresses that are allowed to connect to the compute endpoint. If the list is empty or not set, all IP addresses are allowed. If protected_branches_only is true, the list will be applied only to protected branches.
Show child attributes
ipsarray of stringA list of IP addresses that are allowed to connect to the endpoint.
Show child attributes
protected_branches_onlybooleanIf true, the list will be applied only to protected branches.
audit_log_levelstringblock_public_connectionsbooleanWhen set, connections from the public internet are disallowed. This supersedes the AllowedIPs list. This parameter is under active development and its semantics may change in the future.
block_vpc_connectionsbooleanWhen set, connections using VPC endpoints are disallowed. This parameter is under active development and its semantics may change in the future.
enable_logical_replicationbooleanSets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled.
hipaabooleanEnables HIPAA compliance mode for the project, including audit logging.
maintenance_windowobjectA maintenance window is a time period during which Neon may perform maintenance on the project's infrastructure. During this time, the project's compute endpoints may be unavailable and existing connections can be interrupted.
Show child attributes
end_timestringrequiredEnd time of the maintenance window, in the format of "HH:MM". Uses UTC.
start_timestringrequiredStart time of the maintenance window, in the format of "HH:MM". Uses UTC.
weekdaysarray of integerrequiredA list of weekdays when the maintenance window is active. Encoded as ints, where 1 - Monday, and 7 - Sunday.
Show child attributes
preload_librariesobjectThe shared libraries to preload into the project's compute instances.
Show child attributes
enabled_librariesarray of stringNames of shared preload libraries to enable for the project.
Show child attributes
use_defaultsbooleanWhen true, the project's preload libraries include the platform default set in addition to any libraries listed in `enabled_libraries`.
quotaobjectPer-project consumption quotas. If a quota is exceeded, all active computes are automatically suspended and cannot be started via API calls or incoming connections. The exception is `logical_size_bytes`, which is enforced per branch. If a branch exceeds its `logical_size_bytes` quota, computes can still be started, but write operations will fail—allowing data to be deleted to free up space. Computes on other branches are not affected. Setting `logical_size_bytes` overrides any lower value set by the `neon.max_cluster_size` Postgres setting. Quotas are enforced using per-project consumption metrics with the same names. These metrics reset at the start of each billing period. `logical_size_bytes` is also an exception—it reflects the total data stored in a branch and does not reset. A zero or empty quota value means “unlimited.”
Show child attributes
active_time_secondsinteger · int64The total amount of wall-clock time allowed to be spent by the project's compute endpoints.
compute_time_secondsinteger · int64The total amount of CPU seconds allowed to be spent by the project's compute endpoints.
data_transfer_bytesinteger · int64Total amount of data transferred from all of a project's branches using the proxy.
logical_size_bytesinteger · int64Limit on the logical size of every project's branch. If a branch exceeds its `logical_size_bytes` quota, computes can still be started, but write operations will fail—allowing data to be deleted to free up space. Computes on other branches are not affected. Setting `logical_size_bytes` overrides any lower value set by the `neon.max_cluster_size` Postgres setting.
written_data_bytesinteger · int64Total amount of data written to all of a project's branches.
{
"project": {
"name": "myproject"
}
}Responses
allOf · 2 options
projectobjectrequiredShow child attributes
active_time_secondsinteger · int64requiredSeconds. Control plane observed endpoints of this project being active this amount of wall-clock time. The value has some lag. The value is reset at the beginning of each billing period.
branch_logical_size_limitinteger · int64requiredThe logical size limit for a branch. The value is in MiB.
branch_logical_size_limit_bytesinteger · int64requiredThe logical size limit for a branch. The value is in B.
compute_last_active_atstring · date-timeThe most recent time when any endpoint of this project was active. Omitted when observed no activity for endpoints of this project.
compute_time_secondsinteger · int64requiredSeconds. The number of CPU seconds used by the project's compute endpoints, including compute endpoints that have been deleted. The value has some lag. The value is reset at the beginning of each billing period. Examples: 1. An endpoint that uses 1 CPU for 1 second is equal to `compute_time=1`. 2. An endpoint that uses 2 CPUs simultaneously for 1 second is equal to `compute_time=2`.
consumption_period_endstring · date-timerequiredA date-time indicating when Neon Cloud plans to stop measuring consumption for current consumption period.
consumption_period_startstring · date-timerequiredA date-time indicating when Neon Cloud started measuring consumption for current consumption period.
cpu_used_secinteger · int64requiredDeprecated. Use `compute_time_seconds` instead.
created_atstring · date-timerequiredA timestamp indicating when the project was created
creation_sourcestringrequiredThe project creation source
data_storage_bytes_hourinteger · int64requiredBytes-Hour. Project consumed that much Postgres storage hourly during the billing period. The value has some lag. The value is reset at the beginning of each billing period.
data_transfer_bytesinteger · int64requiredBytes. Egress traffic from the Neon cloud to the client for given project over the billing period. Includes deleted endpoints. The value has some lag. The value is reset at the beginning of each billing period.
A collection of settings for a Neon endpoint
effective_project_permissionvalueShow child attributes
anyOf · 2 options
allOf · 1 option
The caller's effective permission for a project when per-project permissions are enabled. `VIEWER` grants read access, `EDITOR` adds update access, and `ADMIN` grants full management. Omitted for personal projects, flag-off organizations, and non-user subjects.
hipaa_enabled_atstring · date-timeA timestamp indicating when HIPAA was enabled for this project
history_retention_secondsinteger · int32requiredThe number of seconds to retain the shared history for all branches in this project.
idstringrequiredThe Neon project ID. Use as the `project_id` path parameter in other endpoints.
maintenance_scheduled_forstring · date-timeA timestamp indicating when project update begins. If set, computes might experience a brief restart around this time.
maintenance_starts_atstring · date-timeA timestamp indicating when project maintenance begins. If set, the project is placed into maintenance mode at this time.
namestringrequiredThe project name
org_idstringThe Neon organization ID. Returned as `id` from `GET /users/me/organizations`.
ownerobjectShow child attributes
branches_limitintegerrequiredMaximum number of branches the owner is allowed to create across their projects.
emailstring · emailrequiredEmail address of the project owner.
namestringrequiredDisplay name of the project owner.
subscription_typestringrequiredType of subscription to Neon Cloud. Notice that for users without billing account this will be "UNKNOWN"
owner_idstringrequiredID of the organization that owns the project.
pg_versionintegerrequiredThe major Postgres version number. Supported versions are `14`, `15`, `16`, `17`, and `18`. `19` is rolling out and is accepted only in regions where it is enabled; requesting it elsewhere returns an error.
platform_idstringrequiredThe cloud platform identifier. Currently, only AWS is supported, for which the identifier is `aws`.
provisionerstringrequiredproxy_hoststringrequiredThe proxy host for the project. This value combines the `region_id`, the `platform_id`, and the Neon domain (`neon.tech`).
quota_reset_atstring · date-timeDeprecated. Use the `consumption_period_end` field instead. A timestamp indicating when the project quota resets.
region_idstringrequiredCloud region where the resource's Postgres compute and storage reside (for example, `aws-us-east-1`). Valid values are returned by `GET /regions`.
store_passwordsbooleanrequiredWhether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.
synthetic_storage_sizeinteger · int64The current space occupied by the project in Postgres storage, in bytes. Synthetic Postgres storage size combines the logical data size and Write-Ahead Log (WAL) size for all branches in a project.
updated_atstring · date-timerequiredA timestamp indicating when the project was last updated
written_data_bytesinteger · int64requiredBytes. Amount of WAL that travelled through Postgres storage for given project across all branches. The value has some lag. The value is reset at the beginning of each billing period.
operationsarray of objectrequiredShow child attributes
Show array items
An asynchronous action Neon performs on your resources (for example, starting a compute or creating a branch). Fields such as `action`, `status`, and `total_duration_ms` describe the operation and its progress.
actionstringrequiredThe action performed by the operation
branch_idstringThe ID of the branch this operation ran on.
created_atstring · date-timerequiredA timestamp indicating when the operation was created
endpoint_idstringThe ID of the compute endpoint this operation ran on.
errorstringHuman-readable message describing why the operation failed.
failures_countinteger · int32requiredThe number of times the operation failed
idstring · uuidrequiredThe operation ID
project_idstringrequiredThe ID of the project this operation ran on.
retry_atstring · date-timeA timestamp indicating when the operation was last retried
statusstringrequiredLifecycle state of the operation. `scheduling`: queued, not yet started. `running`: actively executing. `finished`: completed successfully. `failed`: ended with a failure. `error`: ended with a terminal error. `cancelling`: cancellation requested but not yet complete. `cancelled`: stopped before completion. `skipped`: bypassed without executing.
total_duration_msinteger · int32requiredThe total duration of the operation in milliseconds
updated_atstring · date-timerequiredA timestamp indicating when the operation status was last updated
{
"operations": [],
"project": {
"active_time_seconds": 100,
"branch_logical_size_limit": 0,
"branch_logical_size_limit_bytes": 10500,
"compute_time_seconds": 100,
"consumption_period_end": "2023-03-01T00:00:00Z",
"consumption_period_start": "2023-02-01T00:00:00Z",
"cpu_used_sec": 213230,
"created_at": "2022-11-23T17:42:25Z",
"creation_source": "console",
"data_storage_bytes_hour": 1040,
"data_transfer_bytes": 1000000,
"history_retention_seconds": 604800,
"id": "shiny-wind-028834",
"name": "myproject",
"owner_id": "1232111",
"pg_version": 15,
"platform_id": "aws",
"provisioner": "k8s-pod",
"proxy_host": "us-east-2.aws.neon.tech",
"region_id": "aws-us-east-2",
"store_passwords": true,
"updated_at": "2022-12-04T02:39:25Z",
"written_data_bytes": 100800
}
}codestringrequiredmessagestringrequiredError message
request_idstringUnique 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": "",
"message": "string",
"request_id": "string"
}