mongodb-mcp-server 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/CODEOWNERS +0 -2
- package/.github/ISSUE_TEMPLATE/bug_report.yml +8 -0
- package/.github/workflows/{lint.yml → check.yml} +22 -1
- package/.github/workflows/code_health.yaml +0 -22
- package/.github/workflows/code_health_fork.yaml +7 -63
- package/.vscode/extensions.json +9 -0
- package/.vscode/settings.json +11 -0
- package/README.md +39 -22
- package/dist/common/atlas/apiClient.js +141 -34
- package/dist/common/atlas/apiClient.js.map +1 -1
- package/dist/common/atlas/apiClientError.js +38 -5
- package/dist/common/atlas/apiClientError.js.map +1 -1
- package/dist/common/atlas/cluster.js +66 -0
- package/dist/common/atlas/cluster.js.map +1 -0
- package/dist/common/atlas/generatePassword.js +9 -0
- package/dist/common/atlas/generatePassword.js.map +1 -0
- package/dist/helpers/EJsonTransport.js +38 -0
- package/dist/helpers/EJsonTransport.js.map +1 -0
- package/dist/helpers/connectionOptions.js +10 -0
- package/dist/helpers/connectionOptions.js.map +1 -0
- package/dist/{packageInfo.js → helpers/packageInfo.js} +1 -1
- package/dist/helpers/packageInfo.js.map +1 -0
- package/dist/index.js +6 -3
- package/dist/index.js.map +1 -1
- package/dist/logger.js +2 -0
- package/dist/logger.js.map +1 -1
- package/dist/server.js +15 -11
- package/dist/server.js.map +1 -1
- package/dist/session.js +8 -3
- package/dist/session.js.map +1 -1
- package/dist/telemetry/constants.js +1 -3
- package/dist/telemetry/constants.js.map +1 -1
- package/dist/telemetry/eventCache.js.map +1 -1
- package/dist/telemetry/telemetry.js +46 -4
- package/dist/telemetry/telemetry.js.map +1 -1
- package/dist/tools/atlas/atlasTool.js +38 -0
- package/dist/tools/atlas/atlasTool.js.map +1 -1
- package/dist/tools/atlas/create/createDBUser.js +19 -2
- package/dist/tools/atlas/create/createDBUser.js.map +1 -1
- package/dist/tools/atlas/metadata/connectCluster.js +5 -22
- package/dist/tools/atlas/metadata/connectCluster.js.map +1 -1
- package/dist/tools/atlas/read/inspectCluster.js +4 -24
- package/dist/tools/atlas/read/inspectCluster.js.map +1 -1
- package/dist/tools/atlas/read/listClusters.js +9 -18
- package/dist/tools/atlas/read/listClusters.js.map +1 -1
- package/dist/tools/mongodb/tools.js +2 -4
- package/dist/tools/mongodb/tools.js.map +1 -1
- package/eslint.config.js +2 -1
- package/{jest.config.ts → jest.config.cjs} +1 -1
- package/package.json +4 -2
- package/scripts/apply.ts +4 -1
- package/scripts/filter.ts +4 -0
- package/src/common/atlas/apiClient.ts +179 -37
- package/src/common/atlas/apiClientError.ts +58 -7
- package/src/common/atlas/cluster.ts +95 -0
- package/src/common/atlas/generatePassword.ts +10 -0
- package/src/common/atlas/openapi.d.ts +438 -15
- package/src/helpers/EJsonTransport.ts +47 -0
- package/src/helpers/connectionOptions.ts +20 -0
- package/src/{packageInfo.ts → helpers/packageInfo.ts} +1 -1
- package/src/index.ts +7 -3
- package/src/logger.ts +2 -0
- package/src/server.ts +22 -14
- package/src/session.ts +8 -4
- package/src/telemetry/constants.ts +2 -3
- package/src/telemetry/eventCache.ts +1 -1
- package/src/telemetry/telemetry.ts +72 -6
- package/src/telemetry/types.ts +0 -1
- package/src/tools/atlas/atlasTool.ts +47 -1
- package/src/tools/atlas/create/createDBUser.ts +22 -2
- package/src/tools/atlas/metadata/connectCluster.ts +5 -27
- package/src/tools/atlas/read/inspectCluster.ts +4 -40
- package/src/tools/atlas/read/listClusters.ts +19 -36
- package/src/tools/mongodb/tools.ts +2 -4
- package/src/types/mongodb-connection-string-url.d.ts +69 -0
- package/tests/integration/helpers.ts +18 -2
- package/tests/integration/telemetry.test.ts +28 -0
- package/tests/integration/tools/atlas/dbUsers.test.ts +57 -32
- package/tests/integration/tools/mongodb/metadata/connect.test.ts +2 -6
- package/tests/integration/tools/mongodb/mongodbHelpers.ts +15 -24
- package/tests/integration/tools/mongodb/read/find.test.ts +28 -0
- package/tests/unit/EJsonTransport.test.ts +71 -0
- package/tests/unit/apiClient.test.ts +193 -0
- package/tests/unit/session.test.ts +65 -0
- package/tests/unit/telemetry.test.ts +165 -71
- package/tsconfig.build.json +1 -1
- package/dist/packageInfo.js.map +0 -1
- package/dist/telemetry/device-id.js +0 -20
- package/dist/telemetry/device-id.js.map +0 -1
- package/src/telemetry/device-id.ts +0 -21
|
@@ -216,6 +216,54 @@ export interface paths {
|
|
|
216
216
|
patch?: never;
|
|
217
217
|
trace?: never;
|
|
218
218
|
};
|
|
219
|
+
"/api/atlas/v2/groups/{groupId}/flexClusters": {
|
|
220
|
+
parameters: {
|
|
221
|
+
query?: never;
|
|
222
|
+
header?: never;
|
|
223
|
+
path?: never;
|
|
224
|
+
cookie?: never;
|
|
225
|
+
};
|
|
226
|
+
/**
|
|
227
|
+
* Return All Flex Clusters from One Project
|
|
228
|
+
* @description Returns details for all flex clusters in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.
|
|
229
|
+
*/
|
|
230
|
+
get: operations["listFlexClusters"];
|
|
231
|
+
put?: never;
|
|
232
|
+
/**
|
|
233
|
+
* Create One Flex Cluster in One Project
|
|
234
|
+
* @description Creates one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role.
|
|
235
|
+
*/
|
|
236
|
+
post: operations["createFlexCluster"];
|
|
237
|
+
delete?: never;
|
|
238
|
+
options?: never;
|
|
239
|
+
head?: never;
|
|
240
|
+
patch?: never;
|
|
241
|
+
trace?: never;
|
|
242
|
+
};
|
|
243
|
+
"/api/atlas/v2/groups/{groupId}/flexClusters/{name}": {
|
|
244
|
+
parameters: {
|
|
245
|
+
query?: never;
|
|
246
|
+
header?: never;
|
|
247
|
+
path?: never;
|
|
248
|
+
cookie?: never;
|
|
249
|
+
};
|
|
250
|
+
/**
|
|
251
|
+
* Return One Flex Cluster from One Project
|
|
252
|
+
* @description Returns details for one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.
|
|
253
|
+
*/
|
|
254
|
+
get: operations["getFlexCluster"];
|
|
255
|
+
put?: never;
|
|
256
|
+
post?: never;
|
|
257
|
+
/**
|
|
258
|
+
* Remove One Flex Cluster from One Project
|
|
259
|
+
* @description Removes one flex cluster from the specified project. The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role.
|
|
260
|
+
*/
|
|
261
|
+
delete: operations["deleteFlexCluster"];
|
|
262
|
+
options?: never;
|
|
263
|
+
head?: never;
|
|
264
|
+
patch?: never;
|
|
265
|
+
trace?: never;
|
|
266
|
+
};
|
|
219
267
|
"/api/atlas/v2/orgs": {
|
|
220
268
|
parameters: {
|
|
221
269
|
query?: never;
|
|
@@ -715,7 +763,7 @@ export interface components {
|
|
|
715
763
|
* @description Azure region to which MongoDB Cloud deployed this network peering container.
|
|
716
764
|
* @enum {string}
|
|
717
765
|
*/
|
|
718
|
-
region: "US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_EAST_2_EUAP" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "UAE_NORTH" | "
|
|
766
|
+
region: "US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_EAST_2_EUAP" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "UAE_NORTH" | "GERMANY_WEST_CENTRAL" | "GERMANY_NORTH" | "SWITZERLAND_NORTH" | "SWITZERLAND_WEST" | "SWEDEN_CENTRAL" | "SWEDEN_SOUTH" | "UK_SOUTH" | "UK_WEST" | "INDIA_CENTRAL" | "INDIA_WEST" | "INDIA_SOUTH" | "CHINA_EAST" | "CHINA_NORTH" | "ASIA_EAST" | "JAPAN_EAST" | "JAPAN_WEST" | "ASIA_SOUTH_EAST" | "KOREA_CENTRAL" | "KOREA_SOUTH" | "FRANCE_CENTRAL" | "FRANCE_SOUTH" | "SOUTH_AFRICA_NORTH" | "SOUTH_AFRICA_WEST" | "NORWAY_EAST" | "NORWAY_WEST" | "UAE_CENTRAL" | "QATAR_CENTRAL" | "POLAND_CENTRAL" | "ISRAEL_CENTRAL" | "ITALY_NORTH" | "SPAIN_CENTRAL" | "MEXICO_CENTRAL" | "NEW_ZEALAND_NORTH";
|
|
719
767
|
/** @description Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container. */
|
|
720
768
|
readonly vnetName?: string;
|
|
721
769
|
} & {
|
|
@@ -749,7 +797,7 @@ export interface components {
|
|
|
749
797
|
* @description Microsoft Azure Regions.
|
|
750
798
|
* @enum {string}
|
|
751
799
|
*/
|
|
752
|
-
regionName?: "US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "
|
|
800
|
+
regionName?: "US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "GERMANY_WEST_CENTRAL" | "GERMANY_NORTH" | "SWEDEN_CENTRAL" | "SWEDEN_SOUTH" | "SWITZERLAND_NORTH" | "SWITZERLAND_WEST" | "UK_SOUTH" | "UK_WEST" | "NORWAY_EAST" | "NORWAY_WEST" | "INDIA_CENTRAL" | "INDIA_SOUTH" | "INDIA_WEST" | "CHINA_EAST" | "CHINA_NORTH" | "ASIA_EAST" | "JAPAN_EAST" | "JAPAN_WEST" | "ASIA_SOUTH_EAST" | "KOREA_CENTRAL" | "KOREA_SOUTH" | "FRANCE_CENTRAL" | "FRANCE_SOUTH" | "SOUTH_AFRICA_NORTH" | "SOUTH_AFRICA_WEST" | "UAE_CENTRAL" | "UAE_NORTH" | "QATAR_CENTRAL";
|
|
753
801
|
} & {
|
|
754
802
|
/**
|
|
755
803
|
* @description discriminator enum property added by openapi-typescript
|
|
@@ -1666,7 +1714,7 @@ export interface components {
|
|
|
1666
1714
|
*/
|
|
1667
1715
|
providerName?: "AWS" | "AZURE" | "GCP" | "TENANT";
|
|
1668
1716
|
/** @description Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC. */
|
|
1669
|
-
regionName?: ("US_GOV_WEST_1" | "US_GOV_EAST_1" | "US_EAST_1" | "US_EAST_2" | "US_WEST_1" | "US_WEST_2" | "CA_CENTRAL_1" | "EU_NORTH_1" | "EU_WEST_1" | "EU_WEST_2" | "EU_WEST_3" | "EU_CENTRAL_1" | "EU_CENTRAL_2" | "AP_EAST_1" | "AP_NORTHEAST_1" | "AP_NORTHEAST_2" | "AP_NORTHEAST_3" | "AP_SOUTHEAST_1" | "AP_SOUTHEAST_2" | "AP_SOUTHEAST_3" | "AP_SOUTHEAST_4" | "AP_SOUTH_1" | "AP_SOUTH_2" | "SA_EAST_1" | "CN_NORTH_1" | "CN_NORTHWEST_1" | "ME_SOUTH_1" | "ME_CENTRAL_1" | "AF_SOUTH_1" | "EU_SOUTH_1" | "EU_SOUTH_2" | "IL_CENTRAL_1" | "CA_WEST_1" | "AP_SOUTHEAST_5" | "AP_SOUTHEAST_7" | "MX_CENTRAL_1" | "GLOBAL") | ("US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "
|
|
1717
|
+
regionName?: ("US_GOV_WEST_1" | "US_GOV_EAST_1" | "US_EAST_1" | "US_EAST_2" | "US_WEST_1" | "US_WEST_2" | "CA_CENTRAL_1" | "EU_NORTH_1" | "EU_WEST_1" | "EU_WEST_2" | "EU_WEST_3" | "EU_CENTRAL_1" | "EU_CENTRAL_2" | "AP_EAST_1" | "AP_NORTHEAST_1" | "AP_NORTHEAST_2" | "AP_NORTHEAST_3" | "AP_SOUTHEAST_1" | "AP_SOUTHEAST_2" | "AP_SOUTHEAST_3" | "AP_SOUTHEAST_4" | "AP_SOUTH_1" | "AP_SOUTH_2" | "SA_EAST_1" | "CN_NORTH_1" | "CN_NORTHWEST_1" | "ME_SOUTH_1" | "ME_CENTRAL_1" | "AF_SOUTH_1" | "EU_SOUTH_1" | "EU_SOUTH_2" | "IL_CENTRAL_1" | "CA_WEST_1" | "AP_SOUTHEAST_5" | "AP_SOUTHEAST_7" | "MX_CENTRAL_1" | "GLOBAL") | ("US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "GERMANY_WEST_CENTRAL" | "GERMANY_NORTH" | "SWEDEN_CENTRAL" | "SWEDEN_SOUTH" | "SWITZERLAND_NORTH" | "SWITZERLAND_WEST" | "UK_SOUTH" | "UK_WEST" | "NORWAY_EAST" | "NORWAY_WEST" | "INDIA_CENTRAL" | "INDIA_SOUTH" | "INDIA_WEST" | "CHINA_EAST" | "CHINA_NORTH" | "ASIA_EAST" | "JAPAN_EAST" | "JAPAN_WEST" | "ASIA_SOUTH_EAST" | "KOREA_CENTRAL" | "KOREA_SOUTH" | "FRANCE_CENTRAL" | "FRANCE_SOUTH" | "SOUTH_AFRICA_NORTH" | "SOUTH_AFRICA_WEST" | "UAE_CENTRAL" | "UAE_NORTH" | "QATAR_CENTRAL") | ("EASTERN_US" | "EASTERN_US_AW" | "US_EAST_4" | "US_EAST_4_AW" | "US_EAST_5" | "US_EAST_5_AW" | "US_WEST_2" | "US_WEST_2_AW" | "US_WEST_3" | "US_WEST_3_AW" | "US_WEST_4" | "US_WEST_4_AW" | "US_SOUTH_1" | "US_SOUTH_1_AW" | "CENTRAL_US" | "CENTRAL_US_AW" | "WESTERN_US" | "WESTERN_US_AW" | "NORTH_AMERICA_NORTHEAST_1" | "NORTH_AMERICA_NORTHEAST_2" | "NORTH_AMERICA_SOUTH_1" | "SOUTH_AMERICA_EAST_1" | "SOUTH_AMERICA_WEST_1" | "WESTERN_EUROPE" | "EUROPE_NORTH_1" | "EUROPE_WEST_2" | "EUROPE_WEST_3" | "EUROPE_WEST_4" | "EUROPE_WEST_6" | "EUROPE_WEST_8" | "EUROPE_WEST_9" | "EUROPE_WEST_10" | "EUROPE_WEST_12" | "EUROPE_SOUTHWEST_1" | "EUROPE_CENTRAL_2" | "MIDDLE_EAST_CENTRAL_1" | "MIDDLE_EAST_CENTRAL_2" | "MIDDLE_EAST_WEST_1" | "AUSTRALIA_SOUTHEAST_1" | "AUSTRALIA_SOUTHEAST_2" | "AFRICA_SOUTH_1" | "EASTERN_ASIA_PACIFIC" | "NORTHEASTERN_ASIA_PACIFIC" | "SOUTHEASTERN_ASIA_PACIFIC" | "ASIA_EAST_2" | "ASIA_NORTHEAST_2" | "ASIA_NORTHEAST_3" | "ASIA_SOUTH_1" | "ASIA_SOUTH_2" | "ASIA_SOUTHEAST_2");
|
|
1670
1718
|
} & (components["schemas"]["AWSRegionConfig"] | components["schemas"]["AzureRegionConfig"] | components["schemas"]["GCPRegionConfig"] | components["schemas"]["TenantRegionConfig"]);
|
|
1671
1719
|
/**
|
|
1672
1720
|
* Cloud Service Provider Settings
|
|
@@ -1687,7 +1735,7 @@ export interface components {
|
|
|
1687
1735
|
*/
|
|
1688
1736
|
providerName?: "AWS" | "AZURE" | "GCP" | "TENANT";
|
|
1689
1737
|
/** @description Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC. */
|
|
1690
|
-
regionName?: ("US_GOV_WEST_1" | "US_GOV_EAST_1" | "US_EAST_1" | "US_EAST_2" | "US_WEST_1" | "US_WEST_2" | "CA_CENTRAL_1" | "EU_NORTH_1" | "EU_WEST_1" | "EU_WEST_2" | "EU_WEST_3" | "EU_CENTRAL_1" | "EU_CENTRAL_2" | "AP_EAST_1" | "AP_NORTHEAST_1" | "AP_NORTHEAST_2" | "AP_NORTHEAST_3" | "AP_SOUTHEAST_1" | "AP_SOUTHEAST_2" | "AP_SOUTHEAST_3" | "AP_SOUTHEAST_4" | "AP_SOUTH_1" | "AP_SOUTH_2" | "SA_EAST_1" | "CN_NORTH_1" | "CN_NORTHWEST_1" | "ME_SOUTH_1" | "ME_CENTRAL_1" | "AF_SOUTH_1" | "EU_SOUTH_1" | "EU_SOUTH_2" | "IL_CENTRAL_1" | "CA_WEST_1" | "AP_SOUTHEAST_5" | "AP_SOUTHEAST_7" | "MX_CENTRAL_1" | "GLOBAL") | ("US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "
|
|
1738
|
+
regionName?: ("US_GOV_WEST_1" | "US_GOV_EAST_1" | "US_EAST_1" | "US_EAST_2" | "US_WEST_1" | "US_WEST_2" | "CA_CENTRAL_1" | "EU_NORTH_1" | "EU_WEST_1" | "EU_WEST_2" | "EU_WEST_3" | "EU_CENTRAL_1" | "EU_CENTRAL_2" | "AP_EAST_1" | "AP_NORTHEAST_1" | "AP_NORTHEAST_2" | "AP_NORTHEAST_3" | "AP_SOUTHEAST_1" | "AP_SOUTHEAST_2" | "AP_SOUTHEAST_3" | "AP_SOUTHEAST_4" | "AP_SOUTH_1" | "AP_SOUTH_2" | "SA_EAST_1" | "CN_NORTH_1" | "CN_NORTHWEST_1" | "ME_SOUTH_1" | "ME_CENTRAL_1" | "AF_SOUTH_1" | "EU_SOUTH_1" | "EU_SOUTH_2" | "IL_CENTRAL_1" | "CA_WEST_1" | "AP_SOUTHEAST_5" | "AP_SOUTHEAST_7" | "MX_CENTRAL_1" | "GLOBAL") | ("US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "GERMANY_WEST_CENTRAL" | "GERMANY_NORTH" | "SWEDEN_CENTRAL" | "SWEDEN_SOUTH" | "SWITZERLAND_NORTH" | "SWITZERLAND_WEST" | "UK_SOUTH" | "UK_WEST" | "NORWAY_EAST" | "NORWAY_WEST" | "INDIA_CENTRAL" | "INDIA_SOUTH" | "INDIA_WEST" | "CHINA_EAST" | "CHINA_NORTH" | "ASIA_EAST" | "JAPAN_EAST" | "JAPAN_WEST" | "ASIA_SOUTH_EAST" | "KOREA_CENTRAL" | "KOREA_SOUTH" | "FRANCE_CENTRAL" | "FRANCE_SOUTH" | "SOUTH_AFRICA_NORTH" | "SOUTH_AFRICA_WEST" | "UAE_CENTRAL" | "UAE_NORTH" | "QATAR_CENTRAL") | ("EASTERN_US" | "EASTERN_US_AW" | "US_EAST_4" | "US_EAST_4_AW" | "US_EAST_5" | "US_EAST_5_AW" | "US_WEST_2" | "US_WEST_2_AW" | "US_WEST_3" | "US_WEST_3_AW" | "US_WEST_4" | "US_WEST_4_AW" | "US_SOUTH_1" | "US_SOUTH_1_AW" | "CENTRAL_US" | "CENTRAL_US_AW" | "WESTERN_US" | "WESTERN_US_AW" | "NORTH_AMERICA_NORTHEAST_1" | "NORTH_AMERICA_NORTHEAST_2" | "NORTH_AMERICA_SOUTH_1" | "SOUTH_AMERICA_EAST_1" | "SOUTH_AMERICA_WEST_1" | "WESTERN_EUROPE" | "EUROPE_NORTH_1" | "EUROPE_WEST_2" | "EUROPE_WEST_3" | "EUROPE_WEST_4" | "EUROPE_WEST_6" | "EUROPE_WEST_8" | "EUROPE_WEST_9" | "EUROPE_WEST_10" | "EUROPE_WEST_12" | "EUROPE_SOUTHWEST_1" | "EUROPE_CENTRAL_2" | "MIDDLE_EAST_CENTRAL_1" | "MIDDLE_EAST_CENTRAL_2" | "MIDDLE_EAST_WEST_1" | "AUSTRALIA_SOUTHEAST_1" | "AUSTRALIA_SOUTHEAST_2" | "AFRICA_SOUTH_1" | "EASTERN_ASIA_PACIFIC" | "NORTHEASTERN_ASIA_PACIFIC" | "SOUTHEASTERN_ASIA_PACIFIC" | "ASIA_EAST_2" | "ASIA_NORTHEAST_2" | "ASIA_NORTHEAST_3" | "ASIA_SOUTH_1" | "ASIA_SOUTH_2" | "ASIA_SOUTHEAST_2");
|
|
1691
1739
|
} & (components["schemas"]["AWSRegionConfig20240805"] | components["schemas"]["AzureRegionConfig20240805"] | components["schemas"]["GCPRegionConfig20240805"] | components["schemas"]["TenantRegionConfig20240805"]);
|
|
1692
1740
|
/**
|
|
1693
1741
|
* Cluster Connection Strings
|
|
@@ -1716,7 +1764,7 @@ export interface components {
|
|
|
1716
1764
|
ClusterDescription20240805: {
|
|
1717
1765
|
/**
|
|
1718
1766
|
* Format: date-time
|
|
1719
|
-
* @description If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.
|
|
1767
|
+
* @description If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
1720
1768
|
*/
|
|
1721
1769
|
acceptDataRisksAndForceReplicaSetReconfig?: string;
|
|
1722
1770
|
advancedConfiguration?: components["schemas"]["ApiAtlasClusterAdvancedConfigurationView"];
|
|
@@ -1767,7 +1815,7 @@ export interface components {
|
|
|
1767
1815
|
readonly featureCompatibilityVersion?: string;
|
|
1768
1816
|
/**
|
|
1769
1817
|
* Format: date-time
|
|
1770
|
-
* @description Feature compatibility version expiration date. Will only appear if FCV is pinned.
|
|
1818
|
+
* @description Feature compatibility version expiration date. Will only appear if FCV is pinned. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
1771
1819
|
*/
|
|
1772
1820
|
readonly featureCompatibilityVersionExpirationDate?: string;
|
|
1773
1821
|
/** @description Set this field to configure the Sharding Management Mode when creating a new Global Cluster.
|
|
@@ -2540,7 +2588,7 @@ export interface components {
|
|
|
2540
2588
|
*/
|
|
2541
2589
|
_id: string;
|
|
2542
2590
|
/**
|
|
2543
|
-
* @description The name of the AWS S3 Bucket
|
|
2591
|
+
* @description The name of the AWS S3 Bucket, Azure Storage Container, or Google Cloud Storage Bucket that Snapshots are exported to.
|
|
2544
2592
|
* @example export-bucket
|
|
2545
2593
|
*/
|
|
2546
2594
|
bucketName: string;
|
|
@@ -2548,7 +2596,7 @@ export interface components {
|
|
|
2548
2596
|
* @description Human-readable label that identifies the cloud provider that Snapshots will be exported to.
|
|
2549
2597
|
* @enum {string}
|
|
2550
2598
|
*/
|
|
2551
|
-
cloudProvider: "AWS" | "AZURE";
|
|
2599
|
+
cloudProvider: "AWS" | "AZURE" | "GCP";
|
|
2552
2600
|
/**
|
|
2553
2601
|
* @description Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.
|
|
2554
2602
|
* @example 32b6e34b3d91647abb20e7b8
|
|
@@ -2615,7 +2663,7 @@ export interface components {
|
|
|
2615
2663
|
* @description Human-readable label that identifies the cloud provider that Snapshots are exported to.
|
|
2616
2664
|
* @enum {string}
|
|
2617
2665
|
*/
|
|
2618
|
-
cloudProvider: "AWS" | "AZURE";
|
|
2666
|
+
cloudProvider: "AWS" | "AZURE" | "GCP";
|
|
2619
2667
|
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
2620
2668
|
readonly links?: components["schemas"]["Link"][];
|
|
2621
2669
|
};
|
|
@@ -2627,7 +2675,7 @@ export interface components {
|
|
|
2627
2675
|
*/
|
|
2628
2676
|
_id: string;
|
|
2629
2677
|
/**
|
|
2630
|
-
* @description The name of the AWS S3 Bucket
|
|
2678
|
+
* @description The name of the AWS S3 Bucket, Azure Storage Container, or Google Cloud Storage Bucket that Snapshots are exported to.
|
|
2631
2679
|
* @example export-bucket
|
|
2632
2680
|
*/
|
|
2633
2681
|
bucketName: string;
|
|
@@ -2635,10 +2683,41 @@ export interface components {
|
|
|
2635
2683
|
* @description Human-readable label that identifies the cloud provider that Snapshots will be exported to.
|
|
2636
2684
|
* @enum {string}
|
|
2637
2685
|
*/
|
|
2638
|
-
cloudProvider: "AWS" | "AZURE";
|
|
2686
|
+
cloudProvider: "AWS" | "AZURE" | "GCP";
|
|
2639
2687
|
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
2640
2688
|
readonly links?: components["schemas"]["Link"][];
|
|
2641
2689
|
};
|
|
2690
|
+
DiskBackupSnapshotGCPExportBucketRequest: Omit<WithRequired<components["schemas"]["DiskBackupSnapshotExportBucketRequest"], "cloudProvider">, "cloudProvider"> & {
|
|
2691
|
+
/**
|
|
2692
|
+
* @description Human-readable label that identifies the Google Cloud Storage Bucket that the role is authorized to export to.
|
|
2693
|
+
* @example export-bucket
|
|
2694
|
+
*/
|
|
2695
|
+
bucketName: string;
|
|
2696
|
+
/**
|
|
2697
|
+
* @description Unique 24-hexadecimal digit string that identifies the GCP Cloud Provider Access Role that MongoDB Cloud uses to access the Google Cloud Storage Bucket.
|
|
2698
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
2699
|
+
*/
|
|
2700
|
+
roleId: string;
|
|
2701
|
+
} & {
|
|
2702
|
+
/**
|
|
2703
|
+
* @description discriminator enum property added by openapi-typescript
|
|
2704
|
+
* @enum {string}
|
|
2705
|
+
*/
|
|
2706
|
+
cloudProvider: "GCP";
|
|
2707
|
+
};
|
|
2708
|
+
DiskBackupSnapshotGCPExportBucketResponse: Omit<WithRequired<components["schemas"]["DiskBackupSnapshotExportBucketResponse"], "_id" | "bucketName" | "cloudProvider">, "cloudProvider"> & {
|
|
2709
|
+
/**
|
|
2710
|
+
* @description Unique 24-hexadecimal digit string that identifies the GCP Cloud Provider Access Role that MongoDB Cloud uses to access the Google Cloud Storage Bucket.
|
|
2711
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
2712
|
+
*/
|
|
2713
|
+
roleId: string;
|
|
2714
|
+
} & {
|
|
2715
|
+
/**
|
|
2716
|
+
* @description discriminator enum property added by openapi-typescript
|
|
2717
|
+
* @enum {string}
|
|
2718
|
+
*/
|
|
2719
|
+
cloudProvider: "GCP";
|
|
2720
|
+
};
|
|
2642
2721
|
/** @description Setting that enables disk auto-scaling. */
|
|
2643
2722
|
DiskGBAutoScaling: {
|
|
2644
2723
|
/** @description Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling. */
|
|
@@ -2648,7 +2727,7 @@ export interface components {
|
|
|
2648
2727
|
EmployeeAccessGrantView: {
|
|
2649
2728
|
/**
|
|
2650
2729
|
* Format: date-time
|
|
2651
|
-
* @description Expiration date for the employee access grant.
|
|
2730
|
+
* @description Expiration date for the employee access grant. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
2652
2731
|
*/
|
|
2653
2732
|
expirationTime: string;
|
|
2654
2733
|
/**
|
|
@@ -2666,6 +2745,147 @@ export interface components {
|
|
|
2666
2745
|
field: string;
|
|
2667
2746
|
};
|
|
2668
2747
|
Fields: Record<string, never>;
|
|
2748
|
+
/**
|
|
2749
|
+
* Flex Backup Configuration
|
|
2750
|
+
* @description Flex backup configuration.
|
|
2751
|
+
*/
|
|
2752
|
+
FlexBackupSettings20241113: {
|
|
2753
|
+
/**
|
|
2754
|
+
* @description Flag that indicates whether backups are performed for this flex cluster. Backup uses flex cluster backups.
|
|
2755
|
+
* @default true
|
|
2756
|
+
*/
|
|
2757
|
+
readonly enabled: boolean;
|
|
2758
|
+
};
|
|
2759
|
+
/**
|
|
2760
|
+
* Flex Cluster Description
|
|
2761
|
+
* @description Group of settings that configure a MongoDB Flex cluster.
|
|
2762
|
+
*/
|
|
2763
|
+
FlexClusterDescription20241113: {
|
|
2764
|
+
backupSettings?: components["schemas"]["FlexBackupSettings20241113"];
|
|
2765
|
+
/**
|
|
2766
|
+
* @description Flex cluster topology.
|
|
2767
|
+
* @default REPLICASET
|
|
2768
|
+
* @enum {string}
|
|
2769
|
+
*/
|
|
2770
|
+
readonly clusterType: "REPLICASET";
|
|
2771
|
+
connectionStrings?: components["schemas"]["FlexConnectionStrings20241113"];
|
|
2772
|
+
/**
|
|
2773
|
+
* Format: date-time
|
|
2774
|
+
* @description Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.
|
|
2775
|
+
*/
|
|
2776
|
+
readonly createDate?: string;
|
|
2777
|
+
/**
|
|
2778
|
+
* @description Unique 24-hexadecimal character string that identifies the project.
|
|
2779
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
2780
|
+
*/
|
|
2781
|
+
readonly groupId?: string;
|
|
2782
|
+
/**
|
|
2783
|
+
* @description Unique 24-hexadecimal digit string that identifies the instance.
|
|
2784
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
2785
|
+
*/
|
|
2786
|
+
readonly id?: string;
|
|
2787
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
2788
|
+
readonly links?: components["schemas"]["Link"][];
|
|
2789
|
+
/** @description Version of MongoDB that the instance runs. */
|
|
2790
|
+
readonly mongoDBVersion?: string;
|
|
2791
|
+
/** @description Human-readable label that identifies the instance. */
|
|
2792
|
+
readonly name?: string;
|
|
2793
|
+
providerSettings: components["schemas"]["FlexProviderSettings20241113"];
|
|
2794
|
+
/**
|
|
2795
|
+
* @description Human-readable label that indicates the current operating condition of this instance.
|
|
2796
|
+
* @enum {string}
|
|
2797
|
+
*/
|
|
2798
|
+
readonly stateName?: "IDLE" | "CREATING" | "UPDATING" | "DELETING" | "REPAIRING";
|
|
2799
|
+
/** @description List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance. */
|
|
2800
|
+
tags?: components["schemas"]["ResourceTag"][];
|
|
2801
|
+
/**
|
|
2802
|
+
* @description Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster.
|
|
2803
|
+
* @default false
|
|
2804
|
+
*/
|
|
2805
|
+
terminationProtectionEnabled: boolean;
|
|
2806
|
+
/**
|
|
2807
|
+
* @description Method by which the cluster maintains the MongoDB versions.
|
|
2808
|
+
* @default LTS
|
|
2809
|
+
* @enum {string}
|
|
2810
|
+
*/
|
|
2811
|
+
readonly versionReleaseSystem: "LTS";
|
|
2812
|
+
};
|
|
2813
|
+
/**
|
|
2814
|
+
* Flex Cluster Description Create
|
|
2815
|
+
* @description Settings that you can specify when you create a flex cluster.
|
|
2816
|
+
*/
|
|
2817
|
+
FlexClusterDescriptionCreate20241113: {
|
|
2818
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
2819
|
+
readonly links?: components["schemas"]["Link"][];
|
|
2820
|
+
/** @description Human-readable label that identifies the instance. */
|
|
2821
|
+
name: string;
|
|
2822
|
+
providerSettings: components["schemas"]["FlexProviderSettingsCreate20241113"];
|
|
2823
|
+
/** @description List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance. */
|
|
2824
|
+
tags?: components["schemas"]["ResourceTag"][];
|
|
2825
|
+
/**
|
|
2826
|
+
* @description Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster.
|
|
2827
|
+
* @default false
|
|
2828
|
+
*/
|
|
2829
|
+
terminationProtectionEnabled: boolean;
|
|
2830
|
+
};
|
|
2831
|
+
/**
|
|
2832
|
+
* Flex Cluster Connection Strings
|
|
2833
|
+
* @description Collection of Uniform Resource Locators that point to the MongoDB database.
|
|
2834
|
+
*/
|
|
2835
|
+
FlexConnectionStrings20241113: {
|
|
2836
|
+
/** @description Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol. */
|
|
2837
|
+
readonly standard?: string;
|
|
2838
|
+
/** @description Public connection string that you can use to connect to this flex cluster. This connection string uses the `mongodb+srv://` protocol. */
|
|
2839
|
+
readonly standardSrv?: string;
|
|
2840
|
+
};
|
|
2841
|
+
/**
|
|
2842
|
+
* Cloud Service Provider Settings for a Flex Cluster
|
|
2843
|
+
* @description Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
|
|
2844
|
+
*/
|
|
2845
|
+
FlexProviderSettings20241113: {
|
|
2846
|
+
/**
|
|
2847
|
+
* @description Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
|
|
2848
|
+
* @enum {string}
|
|
2849
|
+
*/
|
|
2850
|
+
readonly backingProviderName?: "AWS" | "AZURE" | "GCP";
|
|
2851
|
+
/**
|
|
2852
|
+
* Format: double
|
|
2853
|
+
* @description Storage capacity available to the flex cluster expressed in gigabytes.
|
|
2854
|
+
*/
|
|
2855
|
+
readonly diskSizeGB?: number;
|
|
2856
|
+
/**
|
|
2857
|
+
* @description Human-readable label that identifies the provider type.
|
|
2858
|
+
* @default FLEX
|
|
2859
|
+
* @enum {string}
|
|
2860
|
+
*/
|
|
2861
|
+
readonly providerName: "FLEX";
|
|
2862
|
+
/** @description Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). */
|
|
2863
|
+
readonly regionName?: string;
|
|
2864
|
+
};
|
|
2865
|
+
/**
|
|
2866
|
+
* Cloud Service Provider Settings for a Flex Cluster
|
|
2867
|
+
* @description Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
|
|
2868
|
+
*/
|
|
2869
|
+
FlexProviderSettingsCreate20241113: {
|
|
2870
|
+
/**
|
|
2871
|
+
* @description Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
|
|
2872
|
+
* @enum {string}
|
|
2873
|
+
*/
|
|
2874
|
+
backingProviderName: "AWS" | "AZURE" | "GCP";
|
|
2875
|
+
/**
|
|
2876
|
+
* Format: double
|
|
2877
|
+
* @description Storage capacity available to the flex cluster expressed in gigabytes.
|
|
2878
|
+
*/
|
|
2879
|
+
readonly diskSizeGB?: number;
|
|
2880
|
+
/**
|
|
2881
|
+
* @description Human-readable label that identifies the provider type.
|
|
2882
|
+
* @default FLEX
|
|
2883
|
+
* @enum {string}
|
|
2884
|
+
*/
|
|
2885
|
+
readonly providerName: "FLEX";
|
|
2886
|
+
/** @description Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). */
|
|
2887
|
+
regionName: string;
|
|
2888
|
+
};
|
|
2669
2889
|
/**
|
|
2670
2890
|
* Tenant
|
|
2671
2891
|
* @description Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.
|
|
@@ -3379,6 +3599,17 @@ export interface components {
|
|
|
3379
3599
|
*/
|
|
3380
3600
|
readonly totalCount?: number;
|
|
3381
3601
|
};
|
|
3602
|
+
PaginatedFlexClusters20241113: {
|
|
3603
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
3604
|
+
readonly links?: components["schemas"]["Link"][];
|
|
3605
|
+
/** @description List of returned documents that MongoDB Cloud provides when completing this request. */
|
|
3606
|
+
readonly results?: components["schemas"]["FlexClusterDescription20241113"][];
|
|
3607
|
+
/**
|
|
3608
|
+
* Format: int32
|
|
3609
|
+
* @description Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact.
|
|
3610
|
+
*/
|
|
3611
|
+
readonly totalCount?: number;
|
|
3612
|
+
};
|
|
3382
3613
|
PaginatedNetworkAccessView: {
|
|
3383
3614
|
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
3384
3615
|
readonly links?: components["schemas"]["Link"][];
|
|
@@ -3571,7 +3802,7 @@ export interface components {
|
|
|
3571
3802
|
SearchIndexDefinitionVersion: {
|
|
3572
3803
|
/**
|
|
3573
3804
|
* Format: date-time
|
|
3574
|
-
* @description The time at which this index definition was created.
|
|
3805
|
+
* @description The time at which this index definition was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
3575
3806
|
*/
|
|
3576
3807
|
createdAt?: string;
|
|
3577
3808
|
/**
|
|
@@ -3871,12 +4102,16 @@ export interface components {
|
|
|
3871
4102
|
readonly links?: components["schemas"]["Link"][];
|
|
3872
4103
|
/** @description Reserved. Will be used by PRIVATE_LINK connection type. */
|
|
3873
4104
|
name?: string;
|
|
4105
|
+
/** @description Reserved. Will be used by TRANSIT_GATEWAY connection type. */
|
|
4106
|
+
tgwId?: string;
|
|
3874
4107
|
/**
|
|
3875
4108
|
* Networking Access Type
|
|
3876
|
-
* @description Selected networking type. Either PUBLIC, VPC or
|
|
4109
|
+
* @description Selected networking type. Either PUBLIC, VPC, PRIVATE_LINK, or TRANSIT_GATEWAY. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. TRANSIT_GATEWAY support is coming soon.
|
|
3877
4110
|
* @enum {string}
|
|
3878
4111
|
*/
|
|
3879
|
-
type?: "PUBLIC" | "VPC" | "PRIVATE_LINK";
|
|
4112
|
+
type?: "PUBLIC" | "VPC" | "PRIVATE_LINK" | "TRANSIT_GATEWAY";
|
|
4113
|
+
/** @description Reserved. Will be used by TRANSIT_GATEWAY connection type. */
|
|
4114
|
+
vpcCIDR?: string;
|
|
3880
4115
|
};
|
|
3881
4116
|
/** @description Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. */
|
|
3882
4117
|
StreamsKafkaSecurity: {
|
|
@@ -5049,10 +5284,18 @@ export type DiskBackupSnapshotAzureExportBucketRequest = components['schemas']['
|
|
|
5049
5284
|
export type DiskBackupSnapshotAzureExportBucketResponse = components['schemas']['DiskBackupSnapshotAzureExportBucketResponse'];
|
|
5050
5285
|
export type DiskBackupSnapshotExportBucketRequest = components['schemas']['DiskBackupSnapshotExportBucketRequest'];
|
|
5051
5286
|
export type DiskBackupSnapshotExportBucketResponse = components['schemas']['DiskBackupSnapshotExportBucketResponse'];
|
|
5287
|
+
export type DiskBackupSnapshotGcpExportBucketRequest = components['schemas']['DiskBackupSnapshotGCPExportBucketRequest'];
|
|
5288
|
+
export type DiskBackupSnapshotGcpExportBucketResponse = components['schemas']['DiskBackupSnapshotGCPExportBucketResponse'];
|
|
5052
5289
|
export type DiskGbAutoScaling = components['schemas']['DiskGBAutoScaling'];
|
|
5053
5290
|
export type EmployeeAccessGrantView = components['schemas']['EmployeeAccessGrantView'];
|
|
5054
5291
|
export type FieldViolation = components['schemas']['FieldViolation'];
|
|
5055
5292
|
export type Fields = components['schemas']['Fields'];
|
|
5293
|
+
export type FlexBackupSettings20241113 = components['schemas']['FlexBackupSettings20241113'];
|
|
5294
|
+
export type FlexClusterDescription20241113 = components['schemas']['FlexClusterDescription20241113'];
|
|
5295
|
+
export type FlexClusterDescriptionCreate20241113 = components['schemas']['FlexClusterDescriptionCreate20241113'];
|
|
5296
|
+
export type FlexConnectionStrings20241113 = components['schemas']['FlexConnectionStrings20241113'];
|
|
5297
|
+
export type FlexProviderSettings20241113 = components['schemas']['FlexProviderSettings20241113'];
|
|
5298
|
+
export type FlexProviderSettingsCreate20241113 = components['schemas']['FlexProviderSettingsCreate20241113'];
|
|
5056
5299
|
export type FreeComputeAutoScalingRules = components['schemas']['FreeComputeAutoScalingRules'];
|
|
5057
5300
|
export type GcpCloudProviderContainer = components['schemas']['GCPCloudProviderContainer'];
|
|
5058
5301
|
export type GcpComputeAutoScaling = components['schemas']['GCPComputeAutoScaling'];
|
|
@@ -5085,6 +5328,7 @@ export type OrgUserRolesResponse = components['schemas']['OrgUserRolesResponse']
|
|
|
5085
5328
|
export type PaginatedApiAtlasDatabaseUserView = components['schemas']['PaginatedApiAtlasDatabaseUserView'];
|
|
5086
5329
|
export type PaginatedAtlasGroupView = components['schemas']['PaginatedAtlasGroupView'];
|
|
5087
5330
|
export type PaginatedClusterDescription20240805 = components['schemas']['PaginatedClusterDescription20240805'];
|
|
5331
|
+
export type PaginatedFlexClusters20241113 = components['schemas']['PaginatedFlexClusters20241113'];
|
|
5088
5332
|
export type PaginatedNetworkAccessView = components['schemas']['PaginatedNetworkAccessView'];
|
|
5089
5333
|
export type PaginatedOrgGroupView = components['schemas']['PaginatedOrgGroupView'];
|
|
5090
5334
|
export type PaginatedOrganizationView = components['schemas']['PaginatedOrganizationView'];
|
|
@@ -5215,6 +5459,7 @@ export interface operations {
|
|
|
5215
5459
|
};
|
|
5216
5460
|
};
|
|
5217
5461
|
401: components["responses"]["unauthorized"];
|
|
5462
|
+
403: components["responses"]["forbidden"];
|
|
5218
5463
|
500: components["responses"]["internalServerError"];
|
|
5219
5464
|
};
|
|
5220
5465
|
};
|
|
@@ -5248,6 +5493,8 @@ export interface operations {
|
|
|
5248
5493
|
};
|
|
5249
5494
|
};
|
|
5250
5495
|
400: components["responses"]["badRequest"];
|
|
5496
|
+
401: components["responses"]["unauthorized"];
|
|
5497
|
+
403: components["responses"]["forbidden"];
|
|
5251
5498
|
404: components["responses"]["notFound"];
|
|
5252
5499
|
500: components["responses"]["internalServerError"];
|
|
5253
5500
|
};
|
|
@@ -5319,6 +5566,8 @@ export interface operations {
|
|
|
5319
5566
|
};
|
|
5320
5567
|
};
|
|
5321
5568
|
400: components["responses"]["badRequest"];
|
|
5569
|
+
401: components["responses"]["unauthorized"];
|
|
5570
|
+
403: components["responses"]["forbidden"];
|
|
5322
5571
|
404: components["responses"]["notFound"];
|
|
5323
5572
|
500: components["responses"]["internalServerError"];
|
|
5324
5573
|
};
|
|
@@ -5352,6 +5601,8 @@ export interface operations {
|
|
|
5352
5601
|
};
|
|
5353
5602
|
};
|
|
5354
5603
|
400: components["responses"]["badRequest"];
|
|
5604
|
+
401: components["responses"]["unauthorized"];
|
|
5605
|
+
403: components["responses"]["forbidden"];
|
|
5355
5606
|
404: components["responses"]["notFound"];
|
|
5356
5607
|
409: components["responses"]["conflict"];
|
|
5357
5608
|
500: components["responses"]["internalServerError"];
|
|
@@ -5392,6 +5643,8 @@ export interface operations {
|
|
|
5392
5643
|
};
|
|
5393
5644
|
};
|
|
5394
5645
|
401: components["responses"]["unauthorized"];
|
|
5646
|
+
403: components["responses"]["forbidden"];
|
|
5647
|
+
404: components["responses"]["notFound"];
|
|
5395
5648
|
500: components["responses"]["internalServerError"];
|
|
5396
5649
|
};
|
|
5397
5650
|
};
|
|
@@ -5437,6 +5690,7 @@ export interface operations {
|
|
|
5437
5690
|
400: components["responses"]["badRequest"];
|
|
5438
5691
|
401: components["responses"]["unauthorized"];
|
|
5439
5692
|
403: components["responses"]["forbidden"];
|
|
5693
|
+
404: components["responses"]["notFound"];
|
|
5440
5694
|
500: components["responses"]["internalServerError"];
|
|
5441
5695
|
};
|
|
5442
5696
|
};
|
|
@@ -5474,6 +5728,7 @@ export interface operations {
|
|
|
5474
5728
|
"application/vnd.atlas.2023-01-01+json": unknown;
|
|
5475
5729
|
};
|
|
5476
5730
|
};
|
|
5731
|
+
401: components["responses"]["unauthorized"];
|
|
5477
5732
|
403: components["responses"]["forbidden"];
|
|
5478
5733
|
404: components["responses"]["notFound"];
|
|
5479
5734
|
500: components["responses"]["internalServerError"];
|
|
@@ -5516,6 +5771,8 @@ export interface operations {
|
|
|
5516
5771
|
};
|
|
5517
5772
|
};
|
|
5518
5773
|
401: components["responses"]["unauthorized"];
|
|
5774
|
+
403: components["responses"]["forbidden"];
|
|
5775
|
+
404: components["responses"]["notFound"];
|
|
5519
5776
|
500: components["responses"]["internalServerError"];
|
|
5520
5777
|
};
|
|
5521
5778
|
};
|
|
@@ -5556,6 +5813,7 @@ export interface operations {
|
|
|
5556
5813
|
401: components["responses"]["unauthorized"];
|
|
5557
5814
|
402: components["responses"]["paymentRequired"];
|
|
5558
5815
|
403: components["responses"]["forbidden"];
|
|
5816
|
+
404: components["responses"]["notFound"];
|
|
5559
5817
|
409: components["responses"]["conflict"];
|
|
5560
5818
|
500: components["responses"]["internalServerError"];
|
|
5561
5819
|
};
|
|
@@ -5591,6 +5849,7 @@ export interface operations {
|
|
|
5591
5849
|
};
|
|
5592
5850
|
};
|
|
5593
5851
|
401: components["responses"]["unauthorized"];
|
|
5852
|
+
403: components["responses"]["forbidden"];
|
|
5594
5853
|
404: components["responses"]["notFound"];
|
|
5595
5854
|
409: components["responses"]["conflict"];
|
|
5596
5855
|
500: components["responses"]["internalServerError"];
|
|
@@ -5630,6 +5889,7 @@ export interface operations {
|
|
|
5630
5889
|
};
|
|
5631
5890
|
400: components["responses"]["badRequest"];
|
|
5632
5891
|
401: components["responses"]["unauthorized"];
|
|
5892
|
+
403: components["responses"]["forbidden"];
|
|
5633
5893
|
404: components["responses"]["notFound"];
|
|
5634
5894
|
409: components["responses"]["conflict"];
|
|
5635
5895
|
500: components["responses"]["internalServerError"];
|
|
@@ -5670,6 +5930,8 @@ export interface operations {
|
|
|
5670
5930
|
};
|
|
5671
5931
|
};
|
|
5672
5932
|
401: components["responses"]["unauthorized"];
|
|
5933
|
+
403: components["responses"]["forbidden"];
|
|
5934
|
+
404: components["responses"]["notFound"];
|
|
5673
5935
|
500: components["responses"]["internalServerError"];
|
|
5674
5936
|
};
|
|
5675
5937
|
};
|
|
@@ -5765,6 +6027,165 @@ export interface operations {
|
|
|
5765
6027
|
500: components["responses"]["internalServerError"];
|
|
5766
6028
|
};
|
|
5767
6029
|
};
|
|
6030
|
+
listFlexClusters: {
|
|
6031
|
+
parameters: {
|
|
6032
|
+
query?: {
|
|
6033
|
+
/** @description 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. */
|
|
6034
|
+
envelope?: components["parameters"]["envelope"];
|
|
6035
|
+
/** @description Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. */
|
|
6036
|
+
includeCount?: components["parameters"]["includeCount"];
|
|
6037
|
+
/** @description Number of items that the response returns per page. */
|
|
6038
|
+
itemsPerPage?: components["parameters"]["itemsPerPage"];
|
|
6039
|
+
/** @description Number of the page that displays the current set of the total objects that the response returns. */
|
|
6040
|
+
pageNum?: components["parameters"]["pageNum"];
|
|
6041
|
+
/** @description Flag that indicates whether the response body should be in the prettyprint format. */
|
|
6042
|
+
pretty?: components["parameters"]["pretty"];
|
|
6043
|
+
};
|
|
6044
|
+
header?: never;
|
|
6045
|
+
path: {
|
|
6046
|
+
/** @description Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
|
|
6047
|
+
*
|
|
6048
|
+
* **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. */
|
|
6049
|
+
groupId: components["parameters"]["groupId"];
|
|
6050
|
+
};
|
|
6051
|
+
cookie?: never;
|
|
6052
|
+
};
|
|
6053
|
+
requestBody?: never;
|
|
6054
|
+
responses: {
|
|
6055
|
+
/** @description OK */
|
|
6056
|
+
200: {
|
|
6057
|
+
headers: {
|
|
6058
|
+
[name: string]: unknown;
|
|
6059
|
+
};
|
|
6060
|
+
content: {
|
|
6061
|
+
"application/vnd.atlas.2024-11-13+json": components["schemas"]["PaginatedFlexClusters20241113"];
|
|
6062
|
+
};
|
|
6063
|
+
};
|
|
6064
|
+
401: components["responses"]["unauthorized"];
|
|
6065
|
+
403: components["responses"]["forbidden"];
|
|
6066
|
+
404: components["responses"]["notFound"];
|
|
6067
|
+
409: components["responses"]["conflict"];
|
|
6068
|
+
500: components["responses"]["internalServerError"];
|
|
6069
|
+
};
|
|
6070
|
+
};
|
|
6071
|
+
createFlexCluster: {
|
|
6072
|
+
parameters: {
|
|
6073
|
+
query?: {
|
|
6074
|
+
/** @description 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. */
|
|
6075
|
+
envelope?: components["parameters"]["envelope"];
|
|
6076
|
+
/** @description Flag that indicates whether the response body should be in the prettyprint format. */
|
|
6077
|
+
pretty?: components["parameters"]["pretty"];
|
|
6078
|
+
};
|
|
6079
|
+
header?: never;
|
|
6080
|
+
path: {
|
|
6081
|
+
/** @description Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
|
|
6082
|
+
*
|
|
6083
|
+
* **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. */
|
|
6084
|
+
groupId: components["parameters"]["groupId"];
|
|
6085
|
+
};
|
|
6086
|
+
cookie?: never;
|
|
6087
|
+
};
|
|
6088
|
+
/** @description Create One Flex Cluster in One Project. */
|
|
6089
|
+
requestBody: {
|
|
6090
|
+
content: {
|
|
6091
|
+
"application/vnd.atlas.2024-11-13+json": components["schemas"]["FlexClusterDescriptionCreate20241113"];
|
|
6092
|
+
};
|
|
6093
|
+
};
|
|
6094
|
+
responses: {
|
|
6095
|
+
/** @description Created */
|
|
6096
|
+
201: {
|
|
6097
|
+
headers: {
|
|
6098
|
+
[name: string]: unknown;
|
|
6099
|
+
};
|
|
6100
|
+
content: {
|
|
6101
|
+
"application/vnd.atlas.2024-11-13+json": components["schemas"]["FlexClusterDescription20241113"];
|
|
6102
|
+
};
|
|
6103
|
+
};
|
|
6104
|
+
400: components["responses"]["badRequest"];
|
|
6105
|
+
401: components["responses"]["unauthorized"];
|
|
6106
|
+
402: components["responses"]["paymentRequired"];
|
|
6107
|
+
403: components["responses"]["forbidden"];
|
|
6108
|
+
404: components["responses"]["notFound"];
|
|
6109
|
+
409: components["responses"]["conflict"];
|
|
6110
|
+
500: components["responses"]["internalServerError"];
|
|
6111
|
+
};
|
|
6112
|
+
};
|
|
6113
|
+
getFlexCluster: {
|
|
6114
|
+
parameters: {
|
|
6115
|
+
query?: {
|
|
6116
|
+
/** @description 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. */
|
|
6117
|
+
envelope?: components["parameters"]["envelope"];
|
|
6118
|
+
/** @description Flag that indicates whether the response body should be in the prettyprint format. */
|
|
6119
|
+
pretty?: components["parameters"]["pretty"];
|
|
6120
|
+
};
|
|
6121
|
+
header?: never;
|
|
6122
|
+
path: {
|
|
6123
|
+
/** @description Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
|
|
6124
|
+
*
|
|
6125
|
+
* **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. */
|
|
6126
|
+
groupId: components["parameters"]["groupId"];
|
|
6127
|
+
/** @description Human-readable label that identifies the flex cluster. */
|
|
6128
|
+
name: string;
|
|
6129
|
+
};
|
|
6130
|
+
cookie?: never;
|
|
6131
|
+
};
|
|
6132
|
+
requestBody?: never;
|
|
6133
|
+
responses: {
|
|
6134
|
+
/** @description OK */
|
|
6135
|
+
200: {
|
|
6136
|
+
headers: {
|
|
6137
|
+
[name: string]: unknown;
|
|
6138
|
+
};
|
|
6139
|
+
content: {
|
|
6140
|
+
"application/vnd.atlas.2024-11-13+json": components["schemas"]["FlexClusterDescription20241113"];
|
|
6141
|
+
};
|
|
6142
|
+
};
|
|
6143
|
+
400: components["responses"]["badRequest"];
|
|
6144
|
+
401: components["responses"]["unauthorized"];
|
|
6145
|
+
403: components["responses"]["forbidden"];
|
|
6146
|
+
404: components["responses"]["notFound"];
|
|
6147
|
+
409: components["responses"]["conflict"];
|
|
6148
|
+
500: components["responses"]["internalServerError"];
|
|
6149
|
+
};
|
|
6150
|
+
};
|
|
6151
|
+
deleteFlexCluster: {
|
|
6152
|
+
parameters: {
|
|
6153
|
+
query?: {
|
|
6154
|
+
/** @description 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. */
|
|
6155
|
+
envelope?: components["parameters"]["envelope"];
|
|
6156
|
+
/** @description Flag that indicates whether the response body should be in the prettyprint format. */
|
|
6157
|
+
pretty?: components["parameters"]["pretty"];
|
|
6158
|
+
};
|
|
6159
|
+
header?: never;
|
|
6160
|
+
path: {
|
|
6161
|
+
/** @description Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
|
|
6162
|
+
*
|
|
6163
|
+
* **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. */
|
|
6164
|
+
groupId: components["parameters"]["groupId"];
|
|
6165
|
+
/** @description Human-readable label that identifies the flex cluster. */
|
|
6166
|
+
name: string;
|
|
6167
|
+
};
|
|
6168
|
+
cookie?: never;
|
|
6169
|
+
};
|
|
6170
|
+
requestBody?: never;
|
|
6171
|
+
responses: {
|
|
6172
|
+
/** @description This endpoint does not return a response body. */
|
|
6173
|
+
204: {
|
|
6174
|
+
headers: {
|
|
6175
|
+
[name: string]: unknown;
|
|
6176
|
+
};
|
|
6177
|
+
content: {
|
|
6178
|
+
"application/vnd.atlas.2024-11-13+json": unknown;
|
|
6179
|
+
};
|
|
6180
|
+
};
|
|
6181
|
+
400: components["responses"]["badRequest"];
|
|
6182
|
+
401: components["responses"]["unauthorized"];
|
|
6183
|
+
403: components["responses"]["forbidden"];
|
|
6184
|
+
404: components["responses"]["notFound"];
|
|
6185
|
+
409: components["responses"]["conflict"];
|
|
6186
|
+
500: components["responses"]["internalServerError"];
|
|
6187
|
+
};
|
|
6188
|
+
};
|
|
5768
6189
|
listOrganizations: {
|
|
5769
6190
|
parameters: {
|
|
5770
6191
|
query?: {
|
|
@@ -5798,6 +6219,7 @@ export interface operations {
|
|
|
5798
6219
|
};
|
|
5799
6220
|
400: components["responses"]["badRequest"];
|
|
5800
6221
|
401: components["responses"]["unauthorized"];
|
|
6222
|
+
403: components["responses"]["forbidden"];
|
|
5801
6223
|
404: components["responses"]["notFound"];
|
|
5802
6224
|
409: components["responses"]["conflict"];
|
|
5803
6225
|
500: components["responses"]["internalServerError"];
|
|
@@ -5839,6 +6261,7 @@ export interface operations {
|
|
|
5839
6261
|
};
|
|
5840
6262
|
400: components["responses"]["badRequest"];
|
|
5841
6263
|
401: components["responses"]["unauthorized"];
|
|
6264
|
+
403: components["responses"]["forbidden"];
|
|
5842
6265
|
404: components["responses"]["notFound"];
|
|
5843
6266
|
500: components["responses"]["internalServerError"];
|
|
5844
6267
|
};
|