Create a project transfer request

POST /projects/{project_id}/transfer_requests

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.

Markdown for AI context

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 { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.createProjectTransferRequest({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID
  }
});

Project ID

project_id

string

The Neon project ID

No field is required. Send an empty body to use sensible defaults.

Ttl seconds

ttl_seconds

integerdefault: 86400

Number of seconds the transfer request stays valid before it expires. Defaults to 86400 (24 hours).

201

Project transfer request created successfully

"id": (string),requuid

"project_id": (string),req

"created_at": (string),reqdate-time

"expires_at": (string),reqdate-time

default

General error

This endpoint can return the standard Neon API error response.

Response fields

• message Required. Human-readable error message.
• code Required. Machine-readable error code.
• request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

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.