/projects/{project_id}/endpoints/{endpoint_id}Update compute endpoint
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.
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.
Quick start
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}}'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
}
}
});Parameters
project_idThe Neon project ID
endpoint_idThe endpoint ID
Request body
No field is required.
endpointResponse
200Updated the specified compute endpoint
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.