/projects/{project_id}/endpointsCreate compute endpoint
Creates a compute endpoint for the specified branch. A compute endpoint is a Neon compute instance. There is a maximum of one read-write compute endpoint per branch. If the specified branch already has a read-write compute endpoint, the operation fails. A branch can have multiple read-only compute endpoints.
For more information about compute endpoints, see Manage computes.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/endpoints" \
-X POST \
-H "Authorization: Bearer $NEON_API_KEY" \
-H "Content-Type: application/json" \
-d '{"endpoint":{"branch_id":"br-floral-mountain-251143","type":"read_write"}}'neon branches add-compute <id|name>Parameters
project_idThe Neon project ID
Request body
2 required Required: endpoint.branch_id, endpoint.type.
endpointResponse
201Created a 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.