プロジェクトを 1 つ作成

POST /api/atlas/v2/groups

プロジェクトを 1 つ作成します。プロジェクトは、アプリケーション環境、ワークロード、またはその両方をサポートする論理コレクションにクラスターをグループ化します。各プロジェクトには、独自のユーザー、チーム、セキュリティ、タグ、アラートを設定できます。このリソースを使用するには、リクエスト元のサービスアカウントまたは API キーに読み取り書き込みロールが必要です。

クエリ パラメータ

  • envelope ブール値

    アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

    デフォルト値はfalseです。

  • pretty ブール値

    レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

    デフォルト値はfalseです。

    Prettyprint
  • projectOwnerId string

    指定したプロジェクト上で、プロジェクト所有者ロールを付与するMongoDB Cloud ユーザーを識別する、ユニークな 24 桁の 16 進数の文字列。このパラメータを設定すると、最も古い組織オーナーのデフォルト値が上書きされます。

    形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

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

body 必須

プロジェクトを 1 つ作成します。

  • name string 必須

    MongoDB Cloud の組織に含まれるプロジェクトを識別する、人間が判読可能なラベル。

    形式は次のパターンと一致する必要があります: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

  • orgId string 必須

    プロジェクトが属する MongoDB クラウド組織を識別する、ユニークな 24 桁の 16 進数文字列。

    形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

  • regionUsageRestrictions string

    政府の Atlas にのみ適用されます。

    商用 Atlas では、このフィールドはリクエストで拒否され、応答が欠落します。

    このフィールドは、プロジェクトで利用可能なリージョンの制限を設定します。

    COMMERCIAL_FEDRAMP_REGIONS_ONLY:FedRAMP Moderate リージョンでの配置のみを許可します。

    GOV_REGIONS_ONLY:GovCloud リージョンでの配置のみを許可します。

    値は COMMERCIAL_FEDRAMP_REGIONS_ONLY または GOV_REGIONS_ONLY です。デフォルト値は COMMERCIAL_FEDRAMP_REGIONS_ONLY です。

    外部ドキュメント
  • tags array[オブジェクト]

    プロジェクトのタグ付けと分類に使用する、長さが 1 ~ 255 文字のキーと値のペアを含むリスト。

    MongoDB Cloud の組織、プロジェクト、または クラスター をタグ付けして分類するキーと値のペア。例、environment : production

    Resource Tags
    Hide tags attributes タグ属性の表示 オブジェクト
    • キー string 必須

      タグのセットを定義する定数。 たとえば、 environment : productionタグ内のenvironment

      最小長は 1、最大長は 255 です。

    • 価値 string 必須

      タグのセットに属する 変数 。 たとえば、 environment : productionタグ内のproduction

      最小長は 1、最大長は 255 です。

  • withDefaultAlertsSettings ブール値

    デフォルトのアラート設定でプロジェクトを作成するかどうかを示すフラグ。この設定は、プロジェクト作成後に更新することはできません。

    デフォルト値はtrueです。

応答

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

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • clusterCount integer(int64) 必須

      このプロジェクトに配置されたMongoDB Cloud クラスターの量。

    • 作成済み string(date-time) 必須

      MongoDB Cloud が このプロジェクトを作成した日時。 このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

    • id string

      MongoDB Cloudプロジェクトを識別する一意の 24 桁の 16 進数文字列。

      形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

    • name string 必須

      MongoDB Cloud の組織に含まれるプロジェクトを識別する、人間が判読可能なラベル。

      形式は次のパターンと一致する必要があります: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

    • orgId string 必須

      プロジェクトが属する MongoDB クラウド組織を識別する、ユニークな 24 桁の 16 進数文字列。

      形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

    • regionUsageRestrictions string

      政府の Atlas にのみ適用されます。

      商用 Atlas では、このフィールドはリクエストで拒否され、応答が欠落します。

      このフィールドは、プロジェクトで利用可能なリージョンの制限を設定します。

      COMMERCIAL_FEDRAMP_REGIONS_ONLY:FedRAMP Moderate リージョンでの配置のみを許可します。

      GOV_REGIONS_ONLY:GovCloud リージョンでの配置のみを許可します。

      値は COMMERCIAL_FEDRAMP_REGIONS_ONLY または GOV_REGIONS_ONLY です。デフォルト値は COMMERCIAL_FEDRAMP_REGIONS_ONLY です。

      外部ドキュメント
    • tags array[オブジェクト]

      プロジェクトのタグ付けと分類に使用する、長さが 1 ~ 255 文字のキーと値のペアを含むリスト。

      MongoDB Cloud の組織、プロジェクト、または クラスター をタグ付けして分類するキーと値のペア。例、environment : production

      Resource Tags
      Hide tags attributes タグ属性の表示 オブジェクト
      • キー string 必須

        タグのセットを定義する定数。 たとえば、 environment : productionタグ内のenvironment

        最小長は 1、最大長は 255 です。

      • 価値 string 必須

        タグのセットに属する 変数 。 たとえば、 environment : productionタグ内のproduction

        最小長は 1、最大長は 255 です。

    • withDefaultAlertsSettings ブール値

      デフォルトのアラート設定でプロジェクトを作成するかどうかを示すフラグ。この設定は、プロジェクト作成後に更新することはできません。

      デフォルト値はtrueです。

  • 400 application/ JSON

    無効なリクエストです。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 401 application/ JSON

    許可されていません。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 403 application/ JSON

    Forbidden.

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 404 application/ JSON

    見つかりません。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 409 application/ JSON

    競合。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 500 application/ JSON

    内部サーバーエラー。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

atlas api projects createGroup --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.CreateGroupApiParams{}
	sdkResp, httpResp, err := client.ProjectsApi.
		CreateGroupWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \
  -d '{ <Payload> }'
リクエスト例
{
  "name": "string",
  "orgId": "32b6e34b3d91647abb20e7b8",
  "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "withDefaultAlertsSettings": true
}
応答の例(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
}
応答の例(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"
}
応答の例(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"
}
応答の例(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"
}
応答の例(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"
}
応答の例(409)
{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}
応答の例(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"
}