Transfer projects between organizations

POST/organizations/{source_org_id}/projects/transferTransfer projects between organizations

Transfers selected projects, identified by their IDs, from your organization to another specified organization.

Parameters

source_org_idstringpathrequired

The Neon organization ID (source org, which currently owns the project)

pattern ^[a-z0-9-]{1,60}$

Request body

required

application/json

objectTransferProjectsToOrganizationRequest

destination_org_idstringrequired

The destination organization identifier

pattern ^[a-z0-9-]{1,60}$

project_idsarray of stringrequired

The list of projects ids to transfer. Maximum of 400 project ids

maxItems 400 · minItems 1

Show child attributes

maxItems 400 · minItems 1

Example request

{
  "destination_org_id": "string",
  "project_ids": [
    "string"
  ]
}

Responses

objectEmptyResponse

Empty response.

Example response

{}

objectLimitsUnsatisfiedResponse

limitsarray of objectrequired

Plan limits that were not satisfied by the request.

Show child attributes

Show array items

actualstringrequired

Current value of the named limit, which does not satisfy the required `expected` value.

expectedstringrequired

Required value for the limit named by `name`. Compare with `actual` to determine the shortfall.

namestringrequired

Identifier of the unsatisfied limit. Possible values are: - subscription_type - projects_count - project_region

Example response

{
  "limits": [
    {
      "actual": "2",
      "expected": "1",
      "name": "projects_count"
    },
    {
      "actual": "launch",
      "expected": "scale",
      "name": "subscription_type"
    }
  ]
}

objectProjectsWithIntegrationResponse

projectsarray of objectrequired

Projects that have the requested integration, each including the project details and associated integration metadata.

Show child attributes

Show array items

idstringrequired

The Neon project ID. Use as the `project_id` path parameter in other endpoints.

pattern ^[a-z0-9-]{1,60}$

integrationstringrequired

Name of the external integration associated with the project.

Example response

{
  "projects": [
    {
      "id": "round-frog-53611540",
      "integration": "github"
    },
    {
      "id": "long-leaf-72329067",
      "integration": "vercel"
    }
  ]
}

defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique 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.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

source_org_idrequiredpath parameter

curl -X POST 'https://console.neon.tech/api/v2/organizations/string/projects/transfer' \
  -H 'Content-Type: application/json' \
  -d '{"destination_org_id":"string","project_ids":["string"]}'

const response = await fetch('https://console.neon.tech/api/v2/organizations/string/projects/transfer', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"destination_org_id":"string","project_ids":["string"]}),
});
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/organizations/string/projects/transfer', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"destination_org_id\":\"string\",\"project_ids\":[\"string\"]}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://console.neon.tech/api/v2/organizations/string/projects/transfer",
    headers={"Content-Type": "application/json"},
    data='{"destination_org_id":"string","project_ids":["string"]}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"destination_org_id":"string","project_ids":["string"]}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://console.neon.tech/api/v2/organizations/string/projects/transfer", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/organizations/string/projects/transfer");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"destination_org_id\":\"string\",\"project_ids\":[\"string\"]}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/organizations/string/projects/transfer"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"destination_org_id\":\"string\",\"project_ids\":[\"string\"]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/organizations/string/projects/transfer")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"destination_org_id\":\"string\",\"project_ids\":[\"string\"]}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://console.neon.tech/api/v2/organizations/string/projects/transfer");
request.Content = new StringContent("{\"destination_org_id\":\"string\",\"project_ids\":[\"string\"]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{}

{
  "limits": [
    {
      "actual": "2",
      "expected": "1",
      "name": "projects_count"
    },
    {
      "actual": "launch",
      "expected": "scale",
      "name": "subscription_type"
    }
  ]
}

{
  "projects": [
    {
      "id": "round-frog-53611540",
      "integration": "github"
    },
    {
      "id": "long-leaf-72329067",
      "integration": "vercel"
    }
  ]
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}