/projects/{project_id}/transfer_requestsCreate a project transfer request
Creates a transfer request for the specified project. The request expires after a set period.
To accept the request, the recipient calls PUT /projects/{project_id}/transfer_requests/{request_id}
or uses the Neon Console claim link.
The optional ru parameter redirects the recipient after acceptance.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/transfer_requests" \
-X POST \
-H "Authorization: Bearer $NEON_API_KEY"Every field below is optional. An empty body works too.
import { createApiClient } from '@neondatabase/api-client';
const api = createApiClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await api.createProjectTransferRequest(process.env.PROJECT_ID);Parameters
project_idThe Neon project ID
Request body
No field is required. Send an empty body to use sensible defaults.
ttl_secondsSpecifies the validity duration of the transfer request in seconds. If not provided, the request will expire after 24 hours (86,400 seconds).
Response
201Project transfer request created successfully
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.