アプリ構成ファイルの取得

GET /groups/{groupId}/apps/{appId}/pull
tokenAuth

現在のアプリ構成をダウンロードします。次の 2 種類から形式を選択して、ダウンロードできます。

  • 構成ファイルのディレクトリを含む圧縮済み zip ファイル。CLI、バージョン管理システム、別のファイル システムのいずれかを基盤とする環境で作業している場合に最も便利です。

  • 構成全体を含む単一のの JSON オブジェクト。APIを操作している場合や、JSON の解析が可能な別の環境で作業している場合に最も便利です。

ダウンロード時にファイル形式を指定するには、Accept ヘッダーを設定します。

path パラメータ

応答

  • 200

    プル成功

    応答属性の非表示 応答属性の表示 オブジェクト
    • name string 必須

      アプリ名。

    • provider_region string 必須

      次の 1 つ：
      AwsDeploymentRegion string AzureDeploymentRegion string GcpDeploymentRegion string

      値は、aws-us-east-1、aws-us-west-2、aws-us-east-2、aws-eu-central-1、aws-eu-west-1、aws-eu-west-2、aws-ap-southeast-1、aws-ap-southeast-2、aws-ap-south-1、または aws-sa-east-1 です。

      値は、azure-eastus2、azure-westus、azure-westeurope、azure-eastasia、または azure-southeastasia です。

      値は、gcp-us-central1、gcp-us-east4、gcp-us-west1、gcp-europe-west1、または gcp-asia-south1 です。

    • deployment_model string 必須

      アプリケーションの配置モデル。

      値は GLOBAL または LOCAL です。

    • environment string

      アプリケーションの環境。

      値は、development、testing、qa、または production です。

    • auth_providers array[オブジェクト] 必須
      次のいずれか:
      オブジェクト-2 オブジェクト オブジェクト-2 オブジェクト オブジェクト-2 オブジェクト オブジェクト-2 オブジェクト オブジェクト-2 オブジェクト AppleAuthProvider オブジェクト GoogleAuthProvider オブジェクト FacebookAuthProvider オブジェクト
    • custom_user_data オブジェクト| null
      custom_user_data 属性を非表示にする custom_user_data 属性の表示 オブジェクト| null
      • database_name string

        カスタム ユーザー データが含まれるデータベースの名前。

      • collection_name string

        カスタム ユーザー データが含まれるコレクションの名前。

      • user_id_field string

        すべてのカスタム ユーザー データ ドキュメントに表示され、各ドキュメントに対応するユーザーのユーザー アカウント ID が含まれるフィールドの名前。

      • enabled ブール値

        true の場合、カスタム ユーザー データが有効になります。

      • mongo_service_name string 必須

        カスタム ユーザー データを含むリンクされたMongoDBデータソースの名前。

      • on_user_creation_function_name string

        新しいユーザーが登録されるたびに実行される ユーザー作成関数 の名前。

    • data_api_config オブジェクト| null
      data_api_config 属性を非表示にする data_api_config 属性を表示 オブジェクト| null
      • disabled ブール値 必須
      • バージョン array[string] 必須

        データAPIのサポートされているバージョン。

        値は v1 です。

      • return_type string 必須

        データAPIとカスタム エンドポイントによってサポートされているデータ形式。

        値は JSON または EJSON です。

      • create_user_on_auth ブール値
      • run_as_user_id string

        アプリケーション ユーザーのアカウントID。定義されている場合、エンドポイントは常に指定されたユーザーとして実行されます。

      • run_as_user_id_script_source string

        アプリケーション ユーザーのアカウント ID を返す関数の文字列化されたソースコード。定義されている場合、エンドポイントはリクエストごとに関数を実行し、関数から返された ID を持つユーザーとして実行されます。

      • validation_method string 必須

        値は NO_VALIDATION、SECRET_AS_QUERY_PARAM、または VERIFY_PAYLOAD です。

      • secret_name string

        validation_method が "SECRET_AS_QUERY_PARAM" または "VERIFY_PAYLOAD" に設定されている場合、これはリクエストを承認するシークレット の name です。

      • can_evaluate オブジェクト

        受信リクエストへの応答としてエンドポイントの実行が許可されている場合に true と評価される JSON 式。

    • data_sources array[オブジェクト] 必須
      次の 1 つ：
      オブジェクト-2 オブジェクト AtlasFederatedInstanceConstructor オブジェクト
    • エンドポイント array[オブジェクト] 必須
      エンドポイント属性の非表示 エンドポイント属性の表示 オブジェクト
      • route string 必須
      • http_method string 必須

        値は、GET、POST、PUT、PATCH、DELETE、または * です。

      • function_id string 必須
      • validation_method string 必須

        値は NO_VALIDATION、SECRET_AS_QUERY_PARAM、または VERIFY_PAYLOAD です。

      • secret_id string

        validation_method が "SECRET_AS_QUERY_PARAM" または "VERIFY_PAYLOAD" に設定されている場合、これはリクエストを承認するシークレット の _id です。

      • return_type string 必須

        データAPIとカスタム エンドポイントによってサポートされているデータ形式。

        値は JSON または EJSON です。

      • respond_result ブール値 必須
      • fetch_custom_user_data ブール値
      • create_user_on_auth ブール値
      • disabled ブール値 必須
      • function_name string 必須

        エンドポイント関数の名前。

    • 環境 オブジェクト 必須
      環境属性を非表示 環境属性の表示 オブジェクト
      • values オブジェクト

        可能なそれぞれの環境名を、その環境で使用可能な環境値の定義にマッピングするオブジェクト。

        Hide values attributes 値属性を表示する オブジェクト
        • なし オブジェクト
          属性を非表示にする 属性を表示しない オブジェクト
          • values オブジェクト
        • 開発 オブジェクト
          開発属性を非表示 開発属性の表示 オブジェクト
          • values オブジェクト
        • テスト オブジェクト
          テスト属性を非表示にする テスト属性を表示 オブジェクト
          • values オブジェクト
        • qa オブジェクト
          Hide qa attribute 属性を表示 オブジェクト
          • values オブジェクト
        • 本番環境 オブジェクト
          本番属性を非表示 本番環境属性の表示 オブジェクト
          • values オブジェクト
    • 関数 array[オブジェクト] 必須
      関数の属性を非表示にする 関数の属性を表示する オブジェクト
      • can_evaluate オブジェクト

        受信リクエストに応じて関数の実行が許可されている場合にtrueと評価される JSON 式。

      • name string 必須

        関数のユニークな名前。

      • private ブール値 必須

        true の場合、関数はクライアント アプリケーションから非表示になります。受信 Webhook や Triggers などの JSON 式やその他の関数からプライベート関数を呼び出すこともできます。

      • ソース string 必須

        関数の文字列化されたソースコード。コードは有効な ES6 である必要があります。

      • run_as_system ブール値

        true の場合、関数はすべてのサービスに対するルールをバイパスして完全な権限で実行されます。

      • run_as_user_id string

        アプリケーション ユーザーのアカウントID。定義されている場合、エンドポイントは常に指定されたユーザーとして実行されます。run_as_user_id_script_source とは併用できません。

      • run_as_user_id_script_source string

        アプリケーションユーザーのアカウントIDを返す関数の文字列化されたソースコード。定義されている場合、エンドポイントはリクエストごとに関数を実行し、関数から返されたIDを持つユーザーとして実行されます。run_as_user_id とは併用できません。

    • GraphQL オブジェクト 必須
      GraphQL属性を非表示にする GraphQL属性の表示 オブジェクト
      • config オブジェクト 必須
        設定属性を非表示にする コンフィギュレーション属性を表示 オブジェクト
        • use_natural_pluralization ブール値

          true の場合、生成されたスキーマ型名では、可能な限り一般的な英語の複数形が使用されます。

          false の場合、または自然な複数形を決定できない場合、複数形の型では、末尾に "s" が追加された単数形の型名が使用されます。

          アプリを作成した後、この値を変更することはできません。この値は、すべての新しいアプリでは true です。

        • disable_schema_introspection ブール値

          true の場合、GraphQL API はクライアントからの イントロスペクション クエリ をブロックします。

      • validation_settings オブジェクト 必須
        validation_settings 属性を非表示にする validation_settings 属性を表示 オブジェクト
        • read_validation_action string

          値は ERROR または WARN です。

        • read_validation_level string

          値は STRICT または OFF です。

        • write_validation_action string

          値は ERROR または WARN です。

        • write_validation_level string

          値は STRICT または OFF です。

      • custom_resolvers array[オブジェクト] 必須
        custom_resolvers 属性を非表示にする custom_resolvers 属性の表示 オブジェクト
        • on_type string 必須

          リゾルバの親型の名前。これは、"Query"、"Mutation"、または計算プロパティの場合は生成された型の名前になります。

        • field_name string 必須

          GraphQL スキーマに表示されるカスタム リゾルバ フィールドの名前。

        • input_type string |オブジェクト

          カスタム リゾルバの input パラメーターの型。これは、スカラー、既存の生成された型の名前、またはカスタム JSON スキーマ オブジェクトにすることができます。未定義の場合、リゾルバは入力を受け入れません。

          次の 1 つ：
          string-1 string オブジェクト-2 オブジェクト
        • input_type_format string

          カスタム リゾルバが使用する入力タイプの種類。この値は、次の値と一致する必要があります input_type

          • スカラー入力型は "scalar" または "scalar-list" を使用する必要があります
          • 生成された入力タイプでは、"generated" または "generated-list" を使用する必要があります。
          • カスタム入力型では、 "custom"

          未定義の場合、リゾルバは入力を受け入れません。

          値は、scalar、scalar-list、generated、generated-list、または custom です。

        • payload_type string |オブジェクト

          カスタム リゾルバによって返される値の型。これは、スカラー、既存の生成された型の名前、またはカスタム JSON スキーマ オブジェクトにすることができます。

          未定義の場合、リゾルバは DefaultPayload オブジェクトを返します。

          type DefaultPayload {
  status: String!
}
          次の 1 つ：
          string-1 string オブジェクト-2 オブジェクト
        • payload_type_format string

          カスタム リゾルバが使用するペイロード型の種類。この値は、次の値と一致する必要があります payload_type

          • スカラーペイロード型は "scalar" または "scalar-list" を使用する必要があります
          • 生成されたペイロード型では "generated" または "generated-list" を使用する必要があります
          • カスタムペイロード型では、 "custom"

          未定義の場合、リゾルバは DefaultPayload オブジェクトを返します。

          値は、scalar、scalar-list、generated、generated-list、または custom です。

        • function_name string 必須

          リゾルバ 関数の名前。

    • ホスティング オブジェクト 必須
      ホスティング属性を非表示にする ホスティング属性を表示する オブジェクト
      • enabled ブール値 必須
      • custom_domain string
      • default_error_path string
      • default_error_code string
    • https_endpoints array[オブジェクト] 必須

      [非推奨] レガシー HTTP サービス一覧。下位互換性の確保のみを目的としたリストです。

      https_endpoints 属性を非表示にする https_endpoints 属性を表示 オブジェクト
      • name string

        サービス名

      • タイプ string

        サービスの種類

        値は、aws、twilio、github、gcm、または http です。

      • incoming_webhooks array[オブジェクト]
        incoming_webhooks 属性を非表示にする incoming_webhooks 属性の表示 オブジェクト
        • name string 必須
        • function_source string 必須
        • respond_result ブール値 必須
        • options オブジェクト
          オプション属性を非表示にする オプション属性の表示 オブジェクト
          • 秘密 string
          • secretAsQueryParameterm ブール値
      • バージョン integer
    • log_forwarders array[オブジェクト] 必須
      log_forwarders 属性を非表示にする log_forwarders 属性の表示 オブジェクト
      • name string 必須
      • disabled ブール値 必須
      • log_types array[string] 必須

        値は、auth、endpoint、function、graphql、push、schema、service、sync、trigger、または trigger_error_handler です。

      • log_statuses array[string] 必須

        値は error または success です。

      • policy オブジェクト 必須
        ポリシー属性を非表示 ポリシー属性を表示 オブジェクト
        • タイプ string

          値は single または batch です。

      • アクション オブジェクト 必須
        アクション属性の非表示 属性アクションの表示 オブジェクト
        • タイプ string

          値は collection または function です。

        • name string
        • data_source string
        • database string
        • コレクション string
    • schemas array[オブジェクト] 必須
      スキーマ属性を非表示にする スキーマ属性の表示 オブジェクト
      • metadata オブジェクト

        スキーマが適用される、リンクされたコレクションを記述するメタデータ。

        Hide metadata attributes メタデータ属性の表示 オブジェクト
        • data_source string

          データソース名。

        • database string

          データベース名。

        • コレクション string

          コレクション名。

      • スキーマ オブジェクト

        コレクションに対する有効なスキーマ。

        スキーマ属性の非表示 スキーマ属性の表示 オブジェクト
        • bsonType string

          フィールドのBSON type。

          値は object、array、string、number、int、long、double、decimal、date、timestamp、bool、null、 regex、objectId、binary、uuid、function、javascript、symbol、minKey、または maxKey 。

        • title string

          スキーマの人間が判読可能なタイトル。

        • 必須 array[string]

          object スキーマの場合、オブジェクトのインスタンスに必要なフィールド名の配列。

        • properties オブジェクト

          各フィールド名がスキーマ内のプロパティであるオブジェクト。対応する値は、そのフィールドのスキーマ定義です。

          プロパティ属性を非表示 プロパティ属性を表示 オブジェクト
          • * オブジェクト

            コレクションに対する有効なスキーマ。

      • relationships オブジェクト

        外部コレクションとの関係。各フィールド名はスキーマ内のプロパティです。対応する値は、そのフィールドの関係の定義です。

        関係属性を非表示 関係属性の表示 オブジェクト
        • * オブジェクト additionalProperties

          関係の定義。

          * 属性を非表示 * 属性を表示 オブジェクト
          • 参照 string

            外部コレクションの参照列。

          • foreign_key string

            関係がポイントする外部コレクション内のフィールドの名前。

          • is_list ブール値

            true場合:

            • その関係は多くの外部ドキュメントを点場合があります。
            • ローカルフィールドは、コレクションスキーマ内で配列として定義する必要があります。
    • サービス array[オブジェクト] 必須

      [非推奨] レガシー サードパーティー製非 HTTP サービス一覧。下位互換性の確保のみを目的としたリストです。

      サービス属性の非表示 サービス属性の表示 オブジェクト
      • name string

        サービス名

      • タイプ string

        サービスの種類

        値は、aws、twilio、github、gcm、または http です。

      • incoming_webhooks array[オブジェクト]
        incoming_webhooks 属性を非表示にする incoming_webhooks 属性の表示 オブジェクト
        • name string 必須
        • function_source string 必須
        • respond_result ブール値 必須
        • options オブジェクト
          オプション属性を非表示にする オプション属性の表示 オブジェクト
          • 秘密 string
          • secretAsQueryParameterm ブール値
      • バージョン integer
    • 同期 オブジェクト 必須
      同期属性の非表示 同期属性の表示 オブジェクト
      • 状態 string 必須

        同期サービスの状態（同期が構成されていない場合は、"enabled"、"disabled"、または空）。

      • database_name string

        App Services が開発モード でデータを保存する同期されたクラスター内のデータベースの名前。App Services は、同期された各型のスキーマを自動的に生成し、各オブジェクト型をデータベース内のコレクションにマッピングします。

      • queryable_fields_names array[string]

        任意のコレクションのクエリ可能なフィールド名の配列。

      • Indexed_queryable_fields_names array[string]

        インデックス付きクエリ可能なフィールドとして使用するフィールド名のリスト。このプロパティは配列ですが、Sync は現在、インデックス付きクエリ可能なフィールド の1 つのみをサポートしています。したがって、この配列には最大 1 つの要素を含めることができます。

        インデックス付きクエリ可能なフィールドはスキーマ内に存在し、同期するすべてのコレクションで同じ適格なフィールド型である必要があります。このはグローバルなクエリ可能なフィールドであるため、インデックス付きクエリ可能なフィールド名は queryable_fields_names にも表示される必要があります。

      • collection_queryable_fields_names オブジェクト

        指定されたコレクションのクエリ可能なフィールド名の配列。

        collection_queryable_fields_names 属性を非表示にする collection_queryable_fields_names 属性を表示 オブジェクト
        • * オブジェクト additionalProperties
          * 属性を非表示 * 属性を表示 オブジェクト
          • * string additionalProperties

            クエリ可能なフィールドの名前。

      • 権限 オブジェクト

        非推奨

      • last_disabled string

        同期 が最後に無効になった時刻は、UNIX エポックからの秒数により表示されます。

      • client_max_OFFline_days integer

        クライアントリセットが必要になるまでにクライアントがオフラインになることができる日数。

      • is_recury_mode_disabled ブール値

        クライアントリセットモードを無効にするかどうかを指定します。デフォルトでは 、クライアントリセットモードが有効になっており、この値は false です。

      • asymmetric_tables array[string]

        Data Ingestで非対称として定義されているコレクションの名前の配列。クライアントはデータを書込むことができますが、読み取りはできません。

    • Triggers array[オブジェクト] 必須
      次の 1 つ：
      オブジェクト-2 オブジェクト オブジェクト-2 オブジェクト オブジェクト-2 オブジェクト
    • values array[オブジェクト] 必須
      Hide values attributes 値属性を表示する オブジェクト
      • name string 必須
      • private ブール値 必須
      • from_secret ブール値 必須

        true の場合、値は Secret への名前による参照です。

    アプリ構成ファイルのディレクトリを含む圧縮ファイル
  • 400

    Invalid request

  • 500

    構成のプル中にエラーが発生しました

GET /groups/{groupId}/apps/{appId}/pull 
curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/pull' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
応答の例（200） 
{
  "name": "string",
  "provider_region": "aws-us-east-1",
  "deployment_model": "GLOBAL",
  "environment": "production",
  "auth_providers": [
    {
      "name": "anon-user",
      "type": "anon-user",
      "disabled": true
    }
  ],
  "custom_user_data": {
    "database_name": "myapp",
    "collection_name": "users",
    "user_id_field": "user_account_id",
    "enabled": true,
    "mongo_service_name": "mongodb-atlas",
    "on_user_creation_function_name": "myFunction"
  },
  "data_api_config": {
    "disabled": true,
    "versions": [
      "v1"
    ],
    "return_type": "JSON",
    "create_user_on_auth": true,
    "run_as_user_id": "string",
    "run_as_user_id_script_source": "string",
    "validation_method": "NO_VALIDATION",
    "secret_name": "string",
    "can_evaluate": {}
  },
  "data_sources": [
    {
      "name": "string",
      "type": "string",
      "config": {
        "clusterName": "Cluster0",
        "readPreference": "primary",
        "readPreferenceTagSets": [
          "server1"
        ],
        "wireProtocolEnabled": true
      },
      "default_rule": {
        "roles": [
          {
            "document_filters": {
              "read": {},
              "write": {}
            },
            "name": "string",
            "apply_when": {},
            "read": {},
            "write": {},
            "insert": {},
            "delete": {},
            "search": {},
            "fields": {},
            "additional_fields": {
              "read": {},
              "write": {}
            }
          }
        ],
        "filters": [
          {
            "name": "string",
            "apply_when": {},
            "query": {},
            "projection": {
              "additionalProperty1": 0,
              "additionalProperty2": 0
            }
          }
        ]
      },
      "rules": [
        {
          "database": "string",
          "collection": "string",
          "roles": [
            {
              "document_filters": {
                "read": {},
                "write": {}
              },
              "name": "string",
              "apply_when": {},
              "read": {},
              "write": {},
              "insert": {},
              "delete": {},
              "search": {},
              "fields": {},
              "additional_fields": {
                "read": {},
                "write": {}
              }
            }
          ],
          "filters": [
            {
              "name": "string",
              "apply_when": {},
              "query": {},
              "projection": {
                "additionalProperty1": 0,
                "additionalProperty2": 0
              }
            }
          ]
        }
      ]
    }
  ],
  "endpoints": [
    {
      "route": "string",
      "http_method": "GET",
      "function_id": "string",
      "validation_method": "NO_VALIDATION",
      "secret_id": "string",
      "return_type": "JSON",
      "respond_result": true,
      "fetch_custom_user_data": true,
      "create_user_on_auth": true,
      "disabled": true,
      "function_name": "string"
    }
  ],
  "environments": {
    "values": {
      "none": {
        "values": {}
      },
      "development": {
        "values": {}
      },
      "testing": {
        "values": {}
      },
      "qa": {
        "values": {}
      },
      "production": {
        "values": {}
      }
    }
  },
  "functions": [
    {
      "can_evaluate": {},
      "name": "string",
      "private": true,
      "source": "string",
      "run_as_system": true,
      "run_as_user_id": "string",
      "run_as_user_id_script_source": "string"
    }
  ],
  "graphql": {
    "config": {
      "use_natural_pluralization": true,
      "disable_schema_introspection": true
    },
    "validation_settings": {
      "read_validation_action": "ERROR",
      "read_validation_level": "STRICT",
      "write_validation_action": "ERROR",
      "write_validation_level": "STRICT"
    },
    "custom_resolvers": [
      {
        "on_type": "string",
        "field_name": "string",
        "input_type": "string",
        "input_type_format": "scalar",
        "payload_type": "string",
        "payload_type_format": "scalar",
        "function_name": "string"
      }
    ]
  },
  "hosting": {
    "enabled": true,
    "custom_domain": "example.com",
    "default_error_path": "/404.html",
    "default_error_code": "404"
  },
  "https_endpoints": [
    {
      "name": "string",
      "type": "aws",
      "incoming_webhooks": [
        {
          "name": "string",
          "function_source": "string",
          "respond_result": true,
          "options": {
            "secret": "string",
            "secretAsQueryParam": true
          }
        }
      ],
      "version": 42
    }
  ],
  "log_forwarders": [
    {
      "name": "string",
      "disabled": true,
      "log_types": [
        "auth"
      ],
      "log_statuses": [
        "error"
      ],
      "policy": {
        "type": "single"
      },
      "action": {
        "type": "collection",
        "name": "string",
        "data_source": "string",
        "database": "string",
        "collection": "string"
      }
    }
  ],
  "schemas": [
    {
      "metadata": {
        "data_source": "string",
        "database": "string",
        "collection": "string"
      },
      "schema": {
        "bsonType": "object",
        "title": "string",
        "required": [
          "string"
        ],
        "properties": {
          "*": {}
        }
      },
      "relationships": {
        "additionalProperty1": {
          "ref": "string",
          "foreign_key": "string",
          "is_list": true
        },
        "additionalProperty2": {
          "ref": "string",
          "foreign_key": "string",
          "is_list": true
        }
      }
    }
  ],
  "services": [
    {
      "name": "string",
      "type": "aws",
      "incoming_webhooks": [
        {
          "name": "string",
          "function_source": "string",
          "respond_result": true,
          "options": {
            "secret": "string",
            "secretAsQueryParam": true
          }
        }
      ],
      "version": 42
    }
  ],
  "sync": {
    "state": "string",
    "database_name": "string",
    "queryable_fields_names": [
      "string"
    ],
    "indexed_queryable_fields_names": [
      "string"
    ],
    "collection_queryable_fields_names": {
      "additionalProperty1": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "additionalProperty2": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      }
    },
    "permissions": {},
    "last_disabled": "string",
    "client_max_offline_days": 42,
    "is_recovery_mode_disabled": true,
    "asymmetric_tables": [
      "string"
    ]
  },
  "triggers": [
    {
      "name": "onNewEmployee",
      "type": "DATABASE",
      "config": {
        "match": {},
        "project": {},
        "database": "HR",
        "collection": "employees",
        "service_id": "5adeb649b8b998486770ae7c",
        "full_document": true,
        "operation_types": [
          "INSERT"
        ]
      },
      "function_id": "5eea9ca4ca0e356e2c2a148a",
      "event_processors": {
        "FUNCTION": {
          "config": {
            "function_id": "6841b8d3e71dc81bed89dbba",
            "function_name": "Atlas_Triggers_DatabaseInsert_1749137618"
          }
        }
      }
    }
  ],
  "values": [
    {
      "name": "string",
      "private": true,
      "from_secret": true
    }
  ]
}