Migrar um projeto para outra organização

POSTAR /api/atlas/v2/groups/{groupId}:migrate

Migra um projeto da sua organização atual para outra organização. Todos os usuários do projeto e suas funções serão copiados para o mesmo projeto na organização de destino. Você deve incluir uma chave de API da organização com a função "Proprietário da organização" da organização de destino para verificar o acesso à organização de destino ao se autenticar com chaves de API programáticas. Caso contrário, o usuário solicitante deve ter a função de proprietário da organização em ambas as organizações. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário da organização.

parâmetros de caminho

  • groupId string Obrigatório

    Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.

    AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

parâmetros de query

  • envelope booleano

    Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

    O valor padrão é false.

application/vnd.atlas.2024-05-30+json

corpo, corpo Obrigatório

Migra um projeto da sua organização atual para outra organização.

  • destinationOrgId string

    String de 24 caracteres hexadecimais exclusiva que identifica a organização para a qual mover o projeto especificado.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

  • destinationOrgPrivateApiKey string

    String exclusiva que identifica a parte privada da chave de API usada para verificar o acesso à organização de destino. Esse parâmetro é necessário somente quando você se autentica com chaves de API programáticas.

    Conceder acesso programático ao Atlas
  • destinationOrgPublicApiKey string

    String exclusiva que identifica a parte pública da chave de API usada para verificar o acesso à organização de destino. Esse parâmetro é necessário somente quando você se autentica com chaves de API programáticas.

    O comprimento mínimo é 8, o comprimento máximo é 8.

    Conceder acesso programático ao Atlas

Respostas

  • 200 application/vnd.atlas.2024-05-30+json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • clusterCount integer(int64) Obrigatório

      Quantidade de clusters do MongoDB Cloud distribuídos neste projeto.

    • Criado string(data-hora) Obrigatório

      Data e hora em que o MongoDB Cloud criou esse projeto. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

    • id string

      String exclusiva de 24dígitos hexadecimais que identifica o projeto da MongoDB Cloud.

      O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

    • name string Obrigatório

      Etiqueta legível por humanos que identifica o projeto incluído na organização MongoDB Cloud.

      O formato deve corresponder ao seguinte padrão: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$.

    • orgId string Obrigatório

      String exclusiva de 24 dígitos hexadecimais que identifica a organização MongoDB Cloud à qual o projeto pertence.

      O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

    • regionUsageRestrictions string

      Aplica-se apenas ao Atlas for Government.

      No Atlas Comercial, esse campo será rejeitado nas solicitações e estará ausente nas respostas.

      Este campo define restrições em regiões disponíveis no projeto.

      COMMERCIAL_FEDRAMP_REGIONS_ONLY: Permite apenas implantações em regiões FedRAMP moderadas.

      GOV_REGIONS_ONLY: Permite apenas implantações em regiões GovCloud.

      Os valores são COMMERCIAL_FEDRAMP_REGIONS_ONLY ou GOV_REGIONS_ONLY. O valor padrão é COMMERCIAL_FEDRAMP_REGIONS_ONLY.

      Documentação externa
    • tags array[objeto]

      Lista que contém pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o projeto.

      Par de valores-chave que marca e categoriza uma organização, projeto ou cluster do MongoDB Cloud. Por exemplo, environment : production.

      Resource Tags
      Hide tags attributes Mostrar atributos das tags objeto
      • chave string Obrigatório

        Constante que define o conjunto da tag. Por exemplo, environment na marcação environment : production .

        O comprimento mínimo é 1, o comprimento máximo é 255.

      • valor string Obrigatório

        Variável que pertence ao conjunto da tag. Por exemplo, production na marcação environment : production .

        O comprimento mínimo é 1, o comprimento máximo é 255.

    • withDefaultAlertsSettings booleano

      Sinalizador que indica se o projeto deve ser criado com as configurações de alerta padrão. Esta configuração não pode ser atualizada após a criação do projeto .

      O valor padrão é true.

  • 401 aplicação/json

    Não autorizado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 403 aplicação/json

    Forbidden.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 404 aplicação/json

    Não encontrado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 500 aplicação/json

    Erro interno do servidor.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

POST /API/atlas/v2/groups/{groupId}:migrate
atlas api projects migrateGroup --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250219001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.MigrateGroupApiParams{}
	sdkResp, httpResp, err := client.ProjectsApi.
		MigrateGroupWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate" \
  -d '{ <Payload> }'
Exemplos de solicitação
{
  "destinationOrgId": "32b6e34b3d91647abb20e7b8",
  "destinationOrgPrivateApiKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  "destinationOrgPublicApiKey": "zmmrboas"
}
Exemplos de resposta (200)
{
  "clusterCount": 42,
  "created": "2025-05-04T09:42:00Z",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "name": "string",
  "orgId": "32b6e34b3d91647abb20e7b8",
  "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "withDefaultAlertsSettings": true
}
Exemplos de resposta (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Exemplos de resposta (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Exemplos de resposta (404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Exemplos de resposta (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}