Return All Projects Available for Migration

GET /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects

Digest auth

Return all projects that you can migrate to the specified organization.

Path parameters

orgId string Required

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.

Query parameters

envelope boolean

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.

Default value is false.
pretty boolean

Flag that indicates whether the response body should be in the prettyprint format.

Default value is false.

Responses

200 application/vnd.atlas.2023-01-01+json

OK
Hide response attributes Show response attributes object
- deployments array[object]
  
  List of clusters that can be migrated to MongoDB Cloud.
  
  Deployments that can be migrated to MongoDB Atlas.
  
  Hide deployments attributes Show deployments attributes object
  
  agentVersion string
  
  Version of MongoDB Agent that monitors/manages the cluster.
  
  clusterId string
  
  Unique 24-hexadecimal digit string that identifies the cluster.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  dbSizeBytes integer(int64)
  
  Size of this database on disk at the time of the request expressed in bytes.
  
  featureCompatibilityVersion string Required
  
  Version of MongoDB features that this cluster supports.
  
  managed boolean Required
  
  Flag that indicates whether Automation manages this cluster.
  
  mongoDBVersion string Required
  
  Version of MongoDB that this cluster runs.
  
  name string Required
  
  Human-readable label that identifies this cluster.
  
  oplogSizeMB integer(int32)
  
  Size of the Oplog on disk at the time of the request expressed in MB.
  
  sharded boolean Required
  
  Flag that indicates whether someone configured this cluster as a sharded cluster.
  
  If true, this cluster serves as a sharded cluster.
  
  If false, this cluster serves as a replica set.
  
  shardsSize integer(int32)
  
  Number of shards that comprise this cluster.
  
  tlsEnabled boolean Required
  
  Flag that indicates whether someone enabled TLS for this cluster.
- migrationHosts array[string]
  
  Hostname of MongoDB Agent list that you configured to perform a migration.
- name string Required
  
  Human-readable label that identifies this project.
  
  Minimum length is 1, maximum length is 64.
- projectId string Required
  
  Unique 24-hexadecimal digit string that identifies the project to be migrated.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
400 application/json

Bad Request.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
404 application/json

Not Found.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
500 application/json

Internal Server Error.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.

GET /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects

atlas api cloudMigrationService listSourceProjects --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230101001/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.ListSourceProjectsApiParams{}
	sdkResp, httpResp, err := client.CloudMigrationServiceApi.
		ListSourceProjectsWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true"

Response examples (200)

[
  {
    "deployments": [
      {
        "agentVersion": "string",
        "clusterId": "32b6e34b3d91647abb20e7b8",
        "dbSizeBytes": 8192,
        "featureCompatibilityVersion": "string",
        "managed": true,
        "mongoDBVersion": "string",
        "name": "Project X sharded cluster",
        "oplogSizeMB": 3,
        "sharded": true,
        "shardsSize": 3,
        "tlsEnabled": true
      }
    ],
    "migrationHosts": [
      "string"
    ],
    "name": "string",
    "projectId": "32b6e34b3d91647abb20e7b8"
  }
]

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (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"
}

Response examples (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"
}