MOmongodb
Projects

Migrate One Project to Another Organization

Migrates a project from its current organization to another organization. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations.

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

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request body

destinationOrgIdstring

Unique 24-hexadecimal digit string that identifies the organization to move the specified project to.

destinationOrgPrivateApiKeystring

Unique string that identifies the private part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.

destinationOrgPublicApiKeystring

Unique string that identifies the public part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.

Example request

{
  "destinationOrgId": "32b6e34b3d91647abb20e7b8",
  "destinationOrgPrivateApiKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  "destinationOrgPublicApiKey": "zmmrboas"
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.