From c15bab79d467576947a4009ca024b166ca36860f Mon Sep 17 00:00:00 2001
From: wtrocki <981838+wtrocki@users.noreply.github.com>
Date: Wed, 5 Feb 2025 08:36:16 +0000
Subject: [PATCH] temp: client update
---
.mockery.yaml | 2 +-
admin/api_access_tracking.go | 8 +-
admin/api_cloud_backups.go | 138 +-
admin/api_clusters.go | 112 +-
admin/api_custom_database_roles.go | 12 +-
admin/api_database_users.go | 12 +-
admin/api_events.go | 8 +-
admin/api_mongo_db_cloud_users.go | 1910 ++++-
admin/api_monitoring_and_logs.go | 4 +-
admin/api_open_api.go | 187 +
admin/api_organizations.go | 78 +-
admin/api_performance_advisor.go | 333 +-
admin/api_projects.go | 141 +-
admin/api_serverless_instances.go | 78 +-
admin/api_serverless_private_endpoints.go | 76 +-
admin/api_shared_tier_restore_jobs.go | 56 +-
admin/api_shared_tier_snapshots.go | 52 +-
admin/api_streams.go | 149 +
admin/api_teams.go | 31 +-
admin/atlas_client.go | 8 +-
admin/client.go | 3 +
admin/model_acknowledge_alert.go | 2 +-
admin/model_add_or_remove_group_role.go | 51 +
admin/model_add_or_remove_org_role.go | 51 +
admin/model_add_or_remove_user_from_team.go | 52 +
admin/model_advanced_compute_auto_scaling.go | 2 +
admin/model_alert_view_for_nds_group.go | 10 +-
...odel_alerts_notification_root_for_group.go | 4 +-
admin/model_api_atlas_resource_policy.go | 36 +
.../model_api_atlas_resource_policy_create.go | 35 +
admin/model_api_atlas_resource_policy_edit.go | 35 +
admin/model_api_search_deployment_request.go | 2 +-
admin/model_api_search_deployment_response.go | 2 +-
admin/model_api_version.go | 59 +
admin/model_awskms_configuration.go | 35 +
admin/model_cloud_region_config20240805.go | 2 +-
admin/model_create_data_process_region.go | 2 +-
...k_backup_snapshot_export_bucket_request.go | 2 +-
..._backup_snapshot_export_bucket_response.go | 2 +-
admin/model_drop_index_suggestions_index.go | 273 +
.../model_drop_index_suggestions_response.go | 132 +
admin/model_event_view_for_nds_group.go | 42 +-
admin/model_event_view_for_org.go | 6 +-
...=> model_flex_cluster_metric_threshold.go} | 54 +-
admin/model_group_alerts_config.go | 20 +-
admin/model_group_role_assignment.go | 94 +
admin/model_group_settings.go | 80 +-
admin/model_group_user_request.go | 80 +
admin/model_group_user_response.go | 464 ++
admin/model_mdb_available_version.go | 1 +
admin/model_org_user_request.go | 114 +
admin/model_org_user_response.go | 498 ++
admin/model_org_user_roles_request.go | 86 +
admin/model_org_user_roles_response.go | 94 +
admin/model_org_user_update_request.go | 94 +
admin/model_paginated_api_versions.go | 132 +
admin/model_paginated_group_user.go | 132 +
...pp_user.go => model_paginated_org_user.go} | 46 +-
admin/model_raw.go | 2 +-
...odel_schema_advisor_item_recommendation.go | 132 +
...model_schema_advisor_namespace_triggers.go | 96 +
admin/model_schema_advisor_response.go | 60 +
admin/model_schema_advisor_trigger_details.go | 96 +
admin/model_serverless_provider_settings.go | 108 +
admin/model_streams_data_process_region.go | 2 +-
.../model_streams_private_link_connection.go | 110 +
admin/model_third_party_integration.go | 2 +-
auth/clientcredentials/clientcredentials.go | 4 +-
.../clientcredentials_test.go | 2 +-
auth/code/device_flow.go | 2 +-
auth/code/oauth.go | 2 +-
auth/code/oauth_test.go | 2 +-
examples/aws_cluster/aws.go | 4 +-
examples/basic/basic.go | 4 +-
examples/db_users/db_users.go | 4 +-
examples/download/downloadLogs.go | 4 +-
examples/errors.go | 2 +-
examples/go.mod | 10 +-
examples/invoice/invoice.go | 4 +-
examples/mock/cluster_test.go | 4 +-
examples/regions/regions.go | 4 +-
examples/retry/retry.go | 2 +-
.../sa_management.go | 2 +-
.../cached_token.go | 6 +-
go.mod | 2 +-
mockadmin/access_tracking_api.go | 2 +-
mockadmin/alert_configurations_api.go | 2 +-
mockadmin/alerts_api.go | 2 +-
mockadmin/atlas_search_api.go | 2 +-
mockadmin/auditing_api.go | 2 +-
mockadmin/aws_clusters_dns_api.go | 2 +-
mockadmin/cloud_backups_api.go | 2 +-
mockadmin/cloud_migration_service_api.go | 2 +-
mockadmin/cloud_provider_access_api.go | 2 +-
mockadmin/cluster_outage_simulation_api.go | 2 +-
mockadmin/clusters_api.go | 2 +-
mockadmin/collection_level_metrics_api.go | 2 +-
mockadmin/custom_database_roles_api.go | 2 +-
mockadmin/data_federation_api.go | 2 +-
mockadmin/data_lake_pipelines_api.go | 2 +-
mockadmin/database_users_api.go | 2 +-
..._rest_using_customer_key_management_api.go | 2 +-
mockadmin/events_api.go | 2 +-
mockadmin/federated_authentication_api.go | 2 +-
mockadmin/flex_clusters_api.go | 2 +-
mockadmin/flex_restore_jobs_api.go | 2 +-
mockadmin/flex_snapshots_api.go | 2 +-
mockadmin/global_clusters_api.go | 2 +-
mockadmin/invoices_api.go | 2 +-
mockadmin/ldap_configuration_api.go | 2 +-
mockadmin/legacy_backup_api.go | 2 +-
mockadmin/maintenance_windows_api.go | 2 +-
mockadmin/mongo_db_cloud_users_api.go | 2101 +++++-
mockadmin/monitoring_and_logs_api.go | 2 +-
mockadmin/network_peering_api.go | 2 +-
mockadmin/online_archive_api.go | 2 +-
mockadmin/open_api_api.go | 200 +
mockadmin/organizations_api.go | 16 +-
mockadmin/performance_advisor_api.go | 361 +-
mockadmin/private_endpoint_services_api.go | 2 +-
mockadmin/programmatic_api_keys_api.go | 2 +-
mockadmin/project_ip_access_list_api.go | 2 +-
mockadmin/projects_api.go | 49 +-
mockadmin/push_based_log_export_api.go | 2 +-
mockadmin/resource_policies_api.go | 2 +-
mockadmin/rolling_index_api.go | 2 +-
mockadmin/root_api.go | 2 +-
mockadmin/serverless_instances_api.go | 2 +-
mockadmin/serverless_private_endpoints_api.go | 2 +-
mockadmin/service_accounts_api.go | 2 +-
mockadmin/shared_tier_restore_jobs_api.go | 2 +-
mockadmin/shared_tier_snapshots_api.go | 2 +-
mockadmin/streams_api.go | 154 +-
mockadmin/teams_api.go | 16 +-
mockadmin/third_party_integrations_api.go | 2 +-
mockadmin/x509_authentication_api.go | 2 +-
openapi/atlas-api-transformed.yaml | 4029 +++++++----
openapi/atlas-api.yaml | 6361 ++++++++++-------
openapi/versions.json | 2 +-
test/example_client_test.go | 2 +-
test/utils_test.go | 2 +-
tools/config/go-templates/api_doc.mustache | 2 +-
.../config/go-templates/atlas_client.mustache | 8 +-
143 files changed, 15577 insertions(+), 4710 deletions(-)
create mode 100644 admin/api_open_api.go
create mode 100644 admin/model_add_or_remove_group_role.go
create mode 100644 admin/model_add_or_remove_org_role.go
create mode 100644 admin/model_add_or_remove_user_from_team.go
create mode 100644 admin/model_api_version.go
create mode 100644 admin/model_drop_index_suggestions_index.go
create mode 100644 admin/model_drop_index_suggestions_response.go
rename admin/{model_serverless_metric_threshold.go => model_flex_cluster_metric_threshold.go} (68%)
create mode 100644 admin/model_group_role_assignment.go
create mode 100644 admin/model_group_user_request.go
create mode 100644 admin/model_group_user_response.go
create mode 100644 admin/model_org_user_request.go
create mode 100644 admin/model_org_user_response.go
create mode 100644 admin/model_org_user_roles_request.go
create mode 100644 admin/model_org_user_roles_response.go
create mode 100644 admin/model_org_user_update_request.go
create mode 100644 admin/model_paginated_api_versions.go
create mode 100644 admin/model_paginated_group_user.go
rename admin/{model_paginated_app_user.go => model_paginated_org_user.go} (69%)
create mode 100644 admin/model_schema_advisor_item_recommendation.go
create mode 100644 admin/model_schema_advisor_namespace_triggers.go
create mode 100644 admin/model_schema_advisor_response.go
create mode 100644 admin/model_schema_advisor_trigger_details.go
create mode 100644 mockadmin/open_api_api.go
diff --git a/.mockery.yaml b/.mockery.yaml
index b37e9f71a..02cb53dca 100644
--- a/.mockery.yaml
+++ b/.mockery.yaml
@@ -6,6 +6,6 @@ filename: "{{ .InterfaceName | snakecase }}.go"
mockname: "{{.InterfaceName}}"
packages:
- go.mongodb.org/atlas-sdk/v20241113004/admin:
+ github.com/mongodb/atlas-sdk-go/admin:
config:
include-regex: ".*Api"
diff --git a/admin/api_access_tracking.go b/admin/api_access_tracking.go
index e05e21ae2..2bcbd0352 100644
--- a/admin/api_access_tracking.go
+++ b/admin/api_access_tracking.go
@@ -15,7 +15,7 @@ type AccessTrackingApi interface {
/*
ListAccessLogsByClusterName Return Database Access History for One Cluster using Its Cluster Name
- Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role.
+ Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -39,7 +39,7 @@ type AccessTrackingApi interface {
/*
ListAccessLogsByHostname Return Database Access History for One Cluster using Its Hostname
- Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role.
+ Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -137,7 +137,7 @@ func (r ListAccessLogsByClusterNameApiRequest) Execute() (*MongoDBAccessLogsList
/*
ListAccessLogsByClusterName Return Database Access History for One Cluster using Its Cluster Name
-Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role.
+Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -318,7 +318,7 @@ func (r ListAccessLogsByHostnameApiRequest) Execute() (*MongoDBAccessLogsList, *
/*
ListAccessLogsByHostname Return Database Access History for One Cluster using Its Hostname
-Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role.
+Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
diff --git a/admin/api_cloud_backups.go b/admin/api_cloud_backups.go
index 40dee4009..96827cc88 100644
--- a/admin/api_cloud_backups.go
+++ b/admin/api_cloud_backups.go
@@ -15,7 +15,7 @@ type CloudBackupsApi interface {
/*
CancelBackupRestoreJob Cancel One Restore Job of One Cluster
- Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+ Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -67,7 +67,7 @@ type CloudBackupsApi interface {
Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot.
- To use this resource, the requesting API Key must have the Project Owner role.
+ To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -114,15 +114,17 @@ type CloudBackupsApi interface {
CreateExportBucketExecute(r CreateExportBucketApiRequest) (*DiskBackupSnapshotExportBucketResponse, *http.Response, error)
/*
- CreateServerlessBackupRestoreJob Restore One Snapshot of One Serverless Instance
+ CreateServerlessBackupRestoreJob Restore One Snapshot of One Serverless Instance
- Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+ Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param clusterName Human-readable label that identifies the serverless instance whose snapshot you want to restore.
- @param serverlessBackupRestoreJob Restores one snapshot of one serverless instance from the specified project.
- @return CreateServerlessBackupRestoreJobApiRequest
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the createFlexBackupRestoreJob endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param clusterName Human-readable label that identifies the serverless instance whose snapshot you want to restore.
+ @param serverlessBackupRestoreJob Restores one snapshot of one serverless instance from the specified project.
+ @return CreateServerlessBackupRestoreJobApiRequest
*/
CreateServerlessBackupRestoreJob(ctx context.Context, groupId string, clusterName string, serverlessBackupRestoreJob *ServerlessBackupRestoreJob) CreateServerlessBackupRestoreJobApiRequest
/*
@@ -165,7 +167,7 @@ type CloudBackupsApi interface {
/*
DeleteExportBucket Delete One Snapshot Export Bucket
- Deletes an Export Bucket. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting API Key must have the Project Owner role.
+ Deletes an Export Bucket. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -189,7 +191,7 @@ type CloudBackupsApi interface {
/*
DeleteReplicaSetBackup Remove One Replica Set Cloud Backup
- Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Owner role.
+ Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -214,7 +216,7 @@ type CloudBackupsApi interface {
/*
DeleteShardedClusterBackup Remove One Sharded Cluster Cloud Backup
- Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+ Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -287,7 +289,7 @@ type CloudBackupsApi interface {
/*
GetBackupRestoreJob Return One Restore Job of One Cluster
- Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+ Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -383,7 +385,7 @@ type CloudBackupsApi interface {
/*
GetReplicaSetBackup Return One Replica Set Cloud Backup
- Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role.
+ Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role or Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -406,15 +408,17 @@ type CloudBackupsApi interface {
GetReplicaSetBackupExecute(r GetReplicaSetBackupApiRequest) (*DiskBackupReplicaSet, *http.Response, error)
/*
- GetServerlessBackup Return One Snapshot of One Serverless Instance
+ GetServerlessBackup Return One Snapshot of One Serverless Instance
- Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+ Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param clusterName Human-readable label that identifies the serverless instance.
- @param snapshotId Unique 24-hexadecimal digit string that identifies the desired snapshot.
- @return GetServerlessBackupApiRequest
+ This endpoint can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) API or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackup endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param clusterName Human-readable label that identifies the serverless instance.
+ @param snapshotId Unique 24-hexadecimal digit string that identifies the desired snapshot.
+ @return GetServerlessBackupApiRequest
*/
GetServerlessBackup(ctx context.Context, groupId string, clusterName string, snapshotId string) GetServerlessBackupApiRequest
/*
@@ -431,15 +435,17 @@ type CloudBackupsApi interface {
GetServerlessBackupExecute(r GetServerlessBackupApiRequest) (*ServerlessBackupSnapshot, *http.Response, error)
/*
- GetServerlessBackupRestoreJob Return One Restore Job for One Serverless Instance
+ GetServerlessBackupRestoreJob Return One Restore Job for One Serverless Instance
- Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+ Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param clusterName Human-readable label that identifies the serverless instance.
- @param restoreJobId Unique 24-hexadecimal digit string that identifies the restore job to return.
- @return GetServerlessBackupRestoreJobApiRequest
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackupRestoreJob endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param clusterName Human-readable label that identifies the serverless instance.
+ @param restoreJobId Unique 24-hexadecimal digit string that identifies the restore job to return.
+ @return GetServerlessBackupRestoreJobApiRequest
*/
GetServerlessBackupRestoreJob(ctx context.Context, groupId string, clusterName string, restoreJobId string) GetServerlessBackupRestoreJobApiRequest
/*
@@ -458,7 +464,7 @@ type CloudBackupsApi interface {
/*
GetShardedClusterBackup Return One Sharded Cluster Cloud Backup
- Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+ Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role or Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -507,7 +513,7 @@ type CloudBackupsApi interface {
/*
ListBackupRestoreJobs Return All Restore Jobs for One Cluster
- Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+ Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -554,7 +560,7 @@ type CloudBackupsApi interface {
/*
ListReplicaSetBackups Return All Replica Set Cloud Backups
- Returns all snapshots of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+ Returns all snapshots of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role or Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -576,14 +582,16 @@ type CloudBackupsApi interface {
ListReplicaSetBackupsExecute(r ListReplicaSetBackupsApiRequest) (*PaginatedCloudBackupReplicaSet, *http.Response, error)
/*
- ListServerlessBackupRestoreJobs Return All Restore Jobs for One Serverless Instance
+ ListServerlessBackupRestoreJobs Return All Restore Jobs for One Serverless Instance
- Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+ Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param clusterName Human-readable label that identifies the serverless instance.
- @return ListServerlessBackupRestoreJobsApiRequest
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackupRestoreJobs endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param clusterName Human-readable label that identifies the serverless instance.
+ @return ListServerlessBackupRestoreJobsApiRequest
*/
ListServerlessBackupRestoreJobs(ctx context.Context, groupId string, clusterName string) ListServerlessBackupRestoreJobsApiRequest
/*
@@ -600,14 +608,16 @@ type CloudBackupsApi interface {
ListServerlessBackupRestoreJobsExecute(r ListServerlessBackupRestoreJobsApiRequest) (*PaginatedApiAtlasServerlessBackupRestoreJob, *http.Response, error)
/*
- ListServerlessBackups Return All Snapshots of One Serverless Instance
+ ListServerlessBackups Return All Snapshots of One Serverless Instance
- Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+ Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param clusterName Human-readable label that identifies the serverless instance.
- @return ListServerlessBackupsApiRequest
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackups endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param clusterName Human-readable label that identifies the serverless instance.
+ @return ListServerlessBackupsApiRequest
*/
ListServerlessBackups(ctx context.Context, groupId string, clusterName string) ListServerlessBackupsApiRequest
/*
@@ -626,7 +636,7 @@ type CloudBackupsApi interface {
/*
ListShardedClusterBackups Return All Sharded Cluster Cloud Backups
- Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+ Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role or Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -652,7 +662,7 @@ type CloudBackupsApi interface {
Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot.
- To use this resource, the requesting API Key must have the Project Owner role.
+ To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -726,7 +736,7 @@ type CloudBackupsApi interface {
/*
UpdateSnapshotRetention Change Expiration Date for One Cloud Backup
- Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.
+ Changes the expiration date for one cloud backup snapshot for one cluster in the specified project, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -784,7 +794,7 @@ func (r CancelBackupRestoreJobApiRequest) Execute() (any, *http.Response, error)
/*
CancelBackupRestoreJob Cancel One Restore Job of One Cluster
-Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -1035,7 +1045,7 @@ CreateBackupRestoreJob Restore One Snapshot of One Cluster
Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot.
- To use this resource, the requesting API Key must have the Project Owner role.
+ To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -1283,6 +1293,8 @@ CreateServerlessBackupRestoreJob Restore One Snapshot of One Serverless Instance
Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the createFlexBackupRestoreJob endpoint instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param clusterName Human-readable label that identifies the serverless instance whose snapshot you want to restore.
@@ -1521,7 +1533,7 @@ func (r DeleteExportBucketApiRequest) Execute() (any, *http.Response, error) {
/*
DeleteExportBucket Delete One Snapshot Export Bucket
-Deletes an Export Bucket. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting API Key must have the Project Owner role.
+Deletes an Export Bucket. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -1641,7 +1653,7 @@ func (r DeleteReplicaSetBackupApiRequest) Execute() (any, *http.Response, error)
/*
DeleteReplicaSetBackup Remove One Replica Set Cloud Backup
-Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Owner role.
+Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -1764,7 +1776,7 @@ func (r DeleteShardedClusterBackupApiRequest) Execute() (any, *http.Response, er
/*
DeleteShardedClusterBackup Remove One Sharded Cluster Cloud Backup
-Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -2121,7 +2133,7 @@ func (r GetBackupRestoreJobApiRequest) Execute() (*DiskBackupSnapshotRestoreJob,
/*
GetBackupRestoreJob Return One Restore Job of One Cluster
-Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -2589,7 +2601,7 @@ func (r GetReplicaSetBackupApiRequest) Execute() (*DiskBackupReplicaSet, *http.R
/*
GetReplicaSetBackup Return One Replica Set Cloud Backup
-Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role.
+Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role or Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -2714,6 +2726,8 @@ GetServerlessBackup Return One Snapshot of One Serverless Instance
Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+This endpoint can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) API or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackup endpoint instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param clusterName Human-readable label that identifies the serverless instance.
@@ -2837,6 +2851,8 @@ GetServerlessBackupRestoreJob Return One Restore Job for One Serverless Instance
Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackupRestoreJob endpoint instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param clusterName Human-readable label that identifies the serverless instance.
@@ -2958,7 +2974,7 @@ func (r GetShardedClusterBackupApiRequest) Execute() (*DiskBackupShardedClusterS
/*
GetShardedClusterBackup Return One Sharded Cluster Cloud Backup
-Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role or Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -3270,7 +3286,7 @@ func (r ListBackupRestoreJobsApiRequest) Execute() (*PaginatedCloudBackupRestore
/*
ListBackupRestoreJobs Return All Restore Jobs for One Cluster
-Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -3594,7 +3610,7 @@ func (r ListReplicaSetBackupsApiRequest) Execute() (*PaginatedCloudBackupReplica
/*
ListReplicaSetBackups Return All Replica Set Cloud Backups
-Returns all snapshots of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+Returns all snapshots of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role or Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -3761,6 +3777,8 @@ ListServerlessBackupRestoreJobs Return All Restore Jobs for One Serverless Insta
Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackupRestoreJobs endpoint instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param clusterName Human-readable label that identifies the serverless instance.
@@ -3926,6 +3944,8 @@ ListServerlessBackups Return All Snapshots of One Serverless Instance
Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackups endpoint instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param clusterName Human-readable label that identifies the serverless instance.
@@ -4062,7 +4082,7 @@ func (r ListShardedClusterBackupsApiRequest) Execute() (*PaginatedCloudBackupSha
/*
ListShardedClusterBackups Return All Sharded Cluster Cloud Backups
-Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role or Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -4184,7 +4204,7 @@ TakeSnapshot Take One On-Demand Snapshot
Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot.
- To use this resource, the requesting API Key must have the Project Owner role.
+ To use this resource, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -4575,7 +4595,7 @@ func (r UpdateSnapshotRetentionApiRequest) Execute() (*DiskBackupReplicaSet, *ht
/*
UpdateSnapshotRetention Change Expiration Date for One Cloud Backup
-Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.
+Changes the expiration date for one cloud backup snapshot for one cluster in the specified project, the requesting API Key must have the Project Backup Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
diff --git a/admin/api_clusters.go b/admin/api_clusters.go
index 0f5dd19a3..edcb25a5e 100644
--- a/admin/api_clusters.go
+++ b/admin/api_clusters.go
@@ -14,14 +14,16 @@ import (
type ClustersApi interface {
/*
- CreateCluster Create One Cluster from One Project
+ CreateCluster Create One Cluster from One Project
- Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. Deprecated versions: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}
+ Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param clusterDescription20240805 Cluster to create in this project.
- @return CreateClusterApiRequest
+ Please note that using an instanceSize of M2 or M5 will create a Flex cluster instead. Support for the instanceSize of M2 or M5 will be discontinued in January 2026. We recommend using the createFlexCluster API for such configurations moving forward. Deprecated versions: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param clusterDescription20240805 Cluster to create in this project.
+ @return CreateClusterApiRequest
*/
CreateCluster(ctx context.Context, groupId string, clusterDescription20240805 *ClusterDescription20240805) CreateClusterApiRequest
/*
@@ -38,14 +40,16 @@ type ClustersApi interface {
CreateClusterExecute(r CreateClusterApiRequest) (*ClusterDescription20240805, *http.Response, error)
/*
- DeleteCluster Remove One Cluster from One Project
+ DeleteCluster Remove One Cluster from One Project
- Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-01-01}
+ Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param clusterName Human-readable label that identifies the cluster.
- @return DeleteClusterApiRequest
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the deleteFlexCluster endpoint for Flex clusters instead. Deprecated versions: v2-{2023-01-01}
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param clusterName Human-readable label that identifies the cluster.
+ @return DeleteClusterApiRequest
*/
DeleteCluster(ctx context.Context, groupId string, clusterName string) DeleteClusterApiRequest
/*
@@ -62,14 +66,16 @@ type ClustersApi interface {
DeleteClusterExecute(r DeleteClusterApiRequest) (*http.Response, error)
/*
- GetCluster Return One Cluster from One Project
+ GetCluster Return One Cluster from One Project
- Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}
+ Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param clusterName Human-readable label that identifies this cluster.
- @return GetClusterApiRequest
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the getFlexCluster endpoint for Flex clusters instead. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param clusterName Human-readable label that identifies this cluster.
+ @return GetClusterApiRequest
*/
GetCluster(ctx context.Context, groupId string, clusterName string) GetClusterApiRequest
/*
@@ -206,13 +212,15 @@ type ClustersApi interface {
ListCloudProviderRegionsExecute(r ListCloudProviderRegionsApiRequest) (*PaginatedApiAtlasProviderRegions, *http.Response, error)
/*
- ListClusters Return All Clusters in One Project
+ ListClusters Return All Clusters in One Project
- Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}
+ Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @return ListClustersApiRequest
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the listFlexClusters endpoint for Flex clusters instead. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @return ListClustersApiRequest
*/
ListClusters(ctx context.Context, groupId string) ListClustersApiRequest
/*
@@ -422,14 +430,16 @@ type ClustersApi interface {
UpdateClusterAdvancedConfigurationExecute(r UpdateClusterAdvancedConfigurationApiRequest) (*ClusterDescriptionProcessArgs20240805, *http.Response, error)
/*
- UpgradeSharedCluster Upgrade One Shared-tier Cluster
+ UpgradeSharedCluster Upgrade One Shared-tier Cluster
- Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters.
+ Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param legacyAtlasTenantClusterUpgradeRequest Details of the shared-tier cluster upgrade in the specified project.
- @return UpgradeSharedClusterApiRequest
+ This endpoint can also be used to upgrade Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) API or former M2/M5 clusters that have been migrated to Flex clusters, using instanceSizeName to “M2” or “M5” until January 2026. This functionality will be available until January 2026, after which it will only be available for M0 clusters. Please use the upgradeFlexCluster endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param legacyAtlasTenantClusterUpgradeRequest Details of the shared-tier cluster upgrade in the specified project.
+ @return UpgradeSharedClusterApiRequest
*/
UpgradeSharedCluster(ctx context.Context, groupId string, legacyAtlasTenantClusterUpgradeRequest *LegacyAtlasTenantClusterUpgradeRequest) UpgradeSharedClusterApiRequest
/*
@@ -446,14 +456,18 @@ type ClustersApi interface {
UpgradeSharedClusterExecute(r UpgradeSharedClusterApiRequest) (*LegacyAtlasCluster, *http.Response, error)
/*
- UpgradeSharedClusterToServerless Upgrades One Shared-Tier Cluster to the Serverless Instance
+ UpgradeSharedClusterToServerless Upgrades One Shared-Tier Cluster to the Serverless Instance
- Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role.
+ This endpoint has been deprecated as of February 2025 as we no longer support the creation of new serverless instances. Please use the upgradeFlexCluster endpoint to upgrade Flex clusters.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param serverlessInstanceDescription Details of the shared-tier cluster upgrade in the specified project.
- @return UpgradeSharedClusterToServerlessApiRequest
+ Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param serverlessInstanceDescription Details of the shared-tier cluster upgrade in the specified project.
+ @return UpgradeSharedClusterToServerlessApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for ClustersApi
*/
UpgradeSharedClusterToServerless(ctx context.Context, groupId string, serverlessInstanceDescription *ServerlessInstanceDescription) UpgradeSharedClusterToServerlessApiRequest
/*
@@ -463,6 +477,8 @@ type ClustersApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param UpgradeSharedClusterToServerlessApiParams - Parameters for the request
@return UpgradeSharedClusterToServerlessApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for ClustersApi
*/
UpgradeSharedClusterToServerlessWithParams(ctx context.Context, args *UpgradeSharedClusterToServerlessApiParams) UpgradeSharedClusterToServerlessApiRequest
@@ -501,7 +517,9 @@ func (r CreateClusterApiRequest) Execute() (*ClusterDescription20240805, *http.R
/*
CreateCluster Create One Cluster from One Project
-Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. Deprecated versions: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}
+Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters.
+
+Please note that using an instanceSize of M2 or M5 will create a Flex cluster instead. Support for the instanceSize of M2 or M5 will be discontinued in January 2026. We recommend using the createFlexCluster API for such configurations moving forward. Deprecated versions: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -630,7 +648,9 @@ func (r DeleteClusterApiRequest) Execute() (*http.Response, error) {
/*
DeleteCluster Remove One Cluster from One Project
-Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-01-01}
+Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters.
+
+This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the deleteFlexCluster endpoint for Flex clusters instead. Deprecated versions: v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -733,7 +753,9 @@ func (r GetClusterApiRequest) Execute() (*ClusterDescription20240805, *http.Resp
/*
GetCluster Return One Cluster from One Project
-Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}
+Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters.
+
+This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the getFlexCluster endpoint for Flex clusters instead. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -1547,7 +1569,9 @@ func (r ListClustersApiRequest) Execute() (*PaginatedClusterDescription20240805,
/*
ListClusters Return All Clusters in One Project
-Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}
+Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters.
+
+This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the listFlexClusters endpoint for Flex clusters instead. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -2670,6 +2694,8 @@ UpgradeSharedCluster Upgrade One Shared-tier Cluster
Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters.
+This endpoint can also be used to upgrade Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) API or former M2/M5 clusters that have been migrated to Flex clusters, using instanceSizeName to “M2” or “M5” until January 2026. This functionality will be available until January 2026, after which it will only be available for M0 clusters. Please use the upgradeFlexCluster endpoint instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@return UpgradeSharedClusterApiRequest
@@ -2788,11 +2814,15 @@ func (r UpgradeSharedClusterToServerlessApiRequest) Execute() (*ServerlessInstan
/*
UpgradeSharedClusterToServerless Upgrades One Shared-Tier Cluster to the Serverless Instance
-Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role.
+This endpoint has been deprecated as of February 2025 as we no longer support the creation of new serverless instances. Please use the upgradeFlexCluster endpoint to upgrade Flex clusters.
+
+ Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@return UpgradeSharedClusterToServerlessApiRequest
+
+Deprecated
*/
func (a *ClustersApiService) UpgradeSharedClusterToServerless(ctx context.Context, groupId string, serverlessInstanceDescription *ServerlessInstanceDescription) UpgradeSharedClusterToServerlessApiRequest {
return UpgradeSharedClusterToServerlessApiRequest{
@@ -2806,6 +2836,8 @@ func (a *ClustersApiService) UpgradeSharedClusterToServerless(ctx context.Contex
// UpgradeSharedClusterToServerlessExecute executes the request
//
// @return ServerlessInstanceDescription
+//
+// Deprecated
func (a *ClustersApiService) UpgradeSharedClusterToServerlessExecute(r UpgradeSharedClusterToServerlessApiRequest) (*ServerlessInstanceDescription, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
diff --git a/admin/api_custom_database_roles.go b/admin/api_custom_database_roles.go
index 536b1d31f..637db43f1 100644
--- a/admin/api_custom_database_roles.go
+++ b/admin/api_custom_database_roles.go
@@ -15,7 +15,7 @@ type CustomDatabaseRolesApi interface {
/*
CreateCustomDatabaseRole Create One Custom Role
- Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+ Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -39,7 +39,7 @@ type CustomDatabaseRolesApi interface {
/*
DeleteCustomDatabaseRole Remove One Custom Role from One Project
- Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Atlas Admin role.
+ Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -110,7 +110,7 @@ type CustomDatabaseRolesApi interface {
/*
UpdateCustomDatabaseRole Update One Custom Role in One Project
- Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+ Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -164,7 +164,7 @@ func (r CreateCustomDatabaseRoleApiRequest) Execute() (*UserCustomDBRole, *http.
/*
CreateCustomDatabaseRole Create One Custom Role
-Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -284,7 +284,7 @@ func (r DeleteCustomDatabaseRoleApiRequest) Execute() (*http.Response, error) {
/*
DeleteCustomDatabaseRole Remove One Custom Role from One Project
-Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Atlas Admin role.
+Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -615,7 +615,7 @@ func (r UpdateCustomDatabaseRoleApiRequest) Execute() (*UserCustomDBRole, *http.
/*
UpdateCustomDatabaseRole Update One Custom Role in One Project
-Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
diff --git a/admin/api_database_users.go b/admin/api_database_users.go
index b6e2d63ce..cd4f07c88 100644
--- a/admin/api_database_users.go
+++ b/admin/api_database_users.go
@@ -15,7 +15,7 @@ type DatabaseUsersApi interface {
/*
CreateDatabaseUser Create One Database User in One Project
- Creates one database user in the specified project. This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact [Support](https://cloud.mongodb.com/support). To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.
+ Creates one database user in the specified project. This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact [Support](https://cloud.mongodb.com/support). To use this resource, the requesting API Key must have the Project Owner role, the Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -39,7 +39,7 @@ type DatabaseUsersApi interface {
/*
DeleteDatabaseUser Remove One Database User from One Project
- Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+ Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -112,7 +112,7 @@ type DatabaseUsersApi interface {
/*
UpdateDatabaseUser Update One Database User in One Project
- Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.
+ Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -167,7 +167,7 @@ func (r CreateDatabaseUserApiRequest) Execute() (*CloudDatabaseUser, *http.Respo
/*
CreateDatabaseUser Create One Database User in One Project
-Creates one database user in the specified project. This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact [Support](https://cloud.mongodb.com/support). To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.
+Creates one database user in the specified project. This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact [Support](https://cloud.mongodb.com/support). To use this resource, the requesting API Key must have the Project Owner role, the Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -290,7 +290,7 @@ func (r DeleteDatabaseUserApiRequest) Execute() (any, *http.Response, error) {
/*
DeleteDatabaseUser Remove One Database User from One Project
-Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -698,7 +698,7 @@ func (r UpdateDatabaseUserApiRequest) Execute() (*CloudDatabaseUser, *http.Respo
/*
UpdateDatabaseUser Update One Database User in One Project
-Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.
+Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
diff --git a/admin/api_events.go b/admin/api_events.go
index 542fbbd4e..a683ed44a 100644
--- a/admin/api_events.go
+++ b/admin/api_events.go
@@ -634,13 +634,13 @@ func (r ListOrganizationEventsApiRequest) IncludeRaw(includeRaw bool) ListOrgani
return r
}
-// Date and time from when MongoDB Cloud stops returning events. This parameter uses the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC.
+// Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.
func (r ListOrganizationEventsApiRequest) MaxDate(maxDate time.Time) ListOrganizationEventsApiRequest {
r.maxDate = &maxDate
return r
}
-// Date and time from when MongoDB Cloud starts returning events. This parameter uses the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC.
+// Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.
func (r ListOrganizationEventsApiRequest) MinDate(minDate time.Time) ListOrganizationEventsApiRequest {
r.minDate = &minDate
return r
@@ -869,13 +869,13 @@ func (r ListProjectEventsApiRequest) IncludeRaw(includeRaw bool) ListProjectEven
return r
}
-// Date and time from when MongoDB Cloud stops returning events. This parameter uses the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC.
+// Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.
func (r ListProjectEventsApiRequest) MaxDate(maxDate time.Time) ListProjectEventsApiRequest {
r.maxDate = &maxDate
return r
}
-// Date and time from when MongoDB Cloud starts returning events. This parameter uses the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC.
+// Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.
func (r ListProjectEventsApiRequest) MinDate(minDate time.Time) ListProjectEventsApiRequest {
r.minDate = &minDate
return r
diff --git a/admin/api_mongo_db_cloud_users.go b/admin/api_mongo_db_cloud_users.go
index 121b0731b..8fad931f5 100644
--- a/admin/api_mongo_db_cloud_users.go
+++ b/admin/api_mongo_db_cloud_users.go
@@ -12,6 +12,143 @@ import (
type MongoDBCloudUsersApi interface {
+ /*
+ AddOrganizationRole Add One Organization Role to One MongoDB Cloud User
+
+ Adds one organization-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.
+
+ **Note**: This operation is atomic.
+
+ **Note**: This resource cannot be used to add a role to users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @param userId Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.
+ @param addOrRemoveOrgRole Organization-level role to assign to the MongoDB Cloud user.
+ @return AddOrganizationRoleApiRequest
+ */
+ AddOrganizationRole(ctx context.Context, orgId string, userId string, addOrRemoveOrgRole *AddOrRemoveOrgRole) AddOrganizationRoleApiRequest
+ /*
+ AddOrganizationRole Add One Organization Role to One MongoDB Cloud User
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param AddOrganizationRoleApiParams - Parameters for the request
+ @return AddOrganizationRoleApiRequest
+ */
+ AddOrganizationRoleWithParams(ctx context.Context, args *AddOrganizationRoleApiParams) AddOrganizationRoleApiRequest
+
+ // Method available only for mocking purposes
+ AddOrganizationRoleExecute(r AddOrganizationRoleApiRequest) (*OrgUserResponse, *http.Response, error)
+
+ /*
+ AddProjectRole Add One Project Role to One MongoDB Cloud User
+
+ Adds one project-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has been invited to join the project. To use this resource, the requesting API Key must have the Project Owner role.
+
+ **Note**: This resource cannot be used to add a role to users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param userId Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.
+ @param addOrRemoveGroupRole Project-level role to assign to the MongoDB Cloud user.
+ @return AddProjectRoleApiRequest
+ */
+ AddProjectRole(ctx context.Context, groupId string, userId string, addOrRemoveGroupRole *AddOrRemoveGroupRole) AddProjectRoleApiRequest
+ /*
+ AddProjectRole Add One Project Role to One MongoDB Cloud User
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param AddProjectRoleApiParams - Parameters for the request
+ @return AddProjectRoleApiRequest
+ */
+ AddProjectRoleWithParams(ctx context.Context, args *AddProjectRoleApiParams) AddProjectRoleApiRequest
+
+ // Method available only for mocking purposes
+ AddProjectRoleExecute(r AddProjectRoleApiRequest) (*OrgUserResponse, *http.Response, error)
+
+ /*
+ AddProjectUser Add One MongoDB Cloud User to One Project
+
+ Adds one MongoDB Cloud user to one project. To use this resource, the requesting API Key must have the Project Owner role.
+ - If the user has a pending invitation to join the project's organization, MongoDB Cloud modifies it and grants project access.
+ - If the user doesn't have an invitation to join the organization, MongoDB Cloud sends a new invitation that grants the user organization and project access.
+ - If the user is already active in the project's organization, MongoDB Cloud grants access to the project.
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param groupUserRequest The active or pending MongoDB Cloud user that you want to add to the specified project.
+ @return AddProjectUserApiRequest
+ */
+ AddProjectUser(ctx context.Context, groupId string, groupUserRequest *GroupUserRequest) AddProjectUserApiRequest
+ /*
+ AddProjectUser Add One MongoDB Cloud User to One Project
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param AddProjectUserApiParams - Parameters for the request
+ @return AddProjectUserApiRequest
+ */
+ AddProjectUserWithParams(ctx context.Context, args *AddProjectUserApiParams) AddProjectUserApiRequest
+
+ // Method available only for mocking purposes
+ AddProjectUserExecute(r AddProjectUserApiRequest) (*GroupUserResponse, *http.Response, error)
+
+ /*
+ AddUserToTeam Add One MongoDB Cloud User to One Team
+
+ Adds one MongoDB Cloud user to one team. You can add an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.
+
+ **Note**: This resource cannot be used to add a user invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @param teamId Unique 24-hexadecimal digit string that identifies the team to add the MongoDB Cloud user to.
+ @param addOrRemoveUserFromTeam The active or pending MongoDB Cloud user that you want to add to the specified team.
+ @return AddUserToTeamApiRequest
+ */
+ AddUserToTeam(ctx context.Context, orgId string, teamId string, addOrRemoveUserFromTeam *AddOrRemoveUserFromTeam) AddUserToTeamApiRequest
+ /*
+ AddUserToTeam Add One MongoDB Cloud User to One Team
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param AddUserToTeamApiParams - Parameters for the request
+ @return AddUserToTeamApiRequest
+ */
+ AddUserToTeamWithParams(ctx context.Context, args *AddUserToTeamApiParams) AddUserToTeamApiRequest
+
+ // Method available only for mocking purposes
+ AddUserToTeamExecute(r AddUserToTeamApiRequest) (*OrgUserResponse, *http.Response, error)
+
+ /*
+ CreateOrganizationUser Add One MongoDB Cloud User to One Organization
+
+ Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting API Key must have the Organization Owner role.
+
+ **Note**: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @param orgUserRequest Represents the MongoDB Cloud user to be created within the organization.
+ @return CreateOrganizationUserApiRequest
+ */
+ CreateOrganizationUser(ctx context.Context, orgId string, orgUserRequest *OrgUserRequest) CreateOrganizationUserApiRequest
+ /*
+ CreateOrganizationUser Add One MongoDB Cloud User to One Organization
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param CreateOrganizationUserApiParams - Parameters for the request
+ @return CreateOrganizationUserApiRequest
+ */
+ CreateOrganizationUserWithParams(ctx context.Context, args *CreateOrganizationUserApiParams) CreateOrganizationUserApiRequest
+
+ // Method available only for mocking purposes
+ CreateOrganizationUserExecute(r CreateOrganizationUserApiRequest) (*OrgUserResponse, *http.Response, error)
+
/*
CreateUser Create One MongoDB Cloud User
@@ -24,6 +161,8 @@ type MongoDBCloudUsersApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param cloudAppUser MongoDB Cloud user account to create.
@return CreateUserApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for MongoDBCloudUsersApi
*/
CreateUser(ctx context.Context, cloudAppUser *CloudAppUser) CreateUserApiRequest
/*
@@ -33,12 +172,70 @@ type MongoDBCloudUsersApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param CreateUserApiParams - Parameters for the request
@return CreateUserApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for MongoDBCloudUsersApi
*/
CreateUserWithParams(ctx context.Context, args *CreateUserApiParams) CreateUserApiRequest
// Method available only for mocking purposes
CreateUserExecute(r CreateUserApiRequest) (*CloudAppUser, *http.Response, error)
+ /*
+ GetOrganizationUser Return One MongoDB Cloud User in One Organization
+
+ Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting API Key must have the Organization Member role.
+
+ **Note**: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint.
+
+ **Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @param userId Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.
+ @return GetOrganizationUserApiRequest
+ */
+ GetOrganizationUser(ctx context.Context, orgId string, userId string) GetOrganizationUserApiRequest
+ /*
+ GetOrganizationUser Return One MongoDB Cloud User in One Organization
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param GetOrganizationUserApiParams - Parameters for the request
+ @return GetOrganizationUserApiRequest
+ */
+ GetOrganizationUserWithParams(ctx context.Context, args *GetOrganizationUserApiParams) GetOrganizationUserApiRequest
+
+ // Method available only for mocking purposes
+ GetOrganizationUserExecute(r GetOrganizationUserApiRequest) (*OrgUserResponse, *http.Response, error)
+
+ /*
+ GetProjectUser Return One MongoDB Cloud User in One Project
+
+ Returns information about the specified MongoDB Cloud user within the context of the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+
+ **Note**: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint.
+
+ **Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param userId Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.
+ @return GetProjectUserApiRequest
+ */
+ GetProjectUser(ctx context.Context, groupId string, userId string) GetProjectUserApiRequest
+ /*
+ GetProjectUser Return One MongoDB Cloud User in One Project
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param GetProjectUserApiParams - Parameters for the request
+ @return GetProjectUserApiRequest
+ */
+ GetProjectUserWithParams(ctx context.Context, args *GetProjectUserApiParams) GetProjectUserApiRequest
+
+ // Method available only for mocking purposes
+ GetProjectUserExecute(r GetProjectUserApiRequest) (*GroupUserResponse, *http.Response, error)
+
/*
GetUser Return One MongoDB Cloud User using Its ID
@@ -47,6 +244,8 @@ type MongoDBCloudUsersApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId Unique 24-hexadecimal digit string that identifies this user.
@return GetUserApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for MongoDBCloudUsersApi
*/
GetUser(ctx context.Context, userId string) GetUserApiRequest
/*
@@ -56,6 +255,8 @@ type MongoDBCloudUsersApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param GetUserApiParams - Parameters for the request
@return GetUserApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for MongoDBCloudUsersApi
*/
GetUserWithParams(ctx context.Context, args *GetUserApiParams) GetUserApiRequest
@@ -70,6 +271,8 @@ type MongoDBCloudUsersApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userName Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.
@return GetUserByUsernameApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for MongoDBCloudUsersApi
*/
GetUserByUsername(ctx context.Context, userName string) GetUserByUsernameApiRequest
/*
@@ -79,85 +282,211 @@ type MongoDBCloudUsersApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param GetUserByUsernameApiParams - Parameters for the request
@return GetUserByUsernameApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for MongoDBCloudUsersApi
*/
GetUserByUsernameWithParams(ctx context.Context, args *GetUserByUsernameApiParams) GetUserByUsernameApiRequest
// Method available only for mocking purposes
GetUserByUsernameExecute(r GetUserByUsernameApiRequest) (*CloudAppUser, *http.Response, error)
+
+ /*
+ RemoveOrganizationRole Remove One Organization Role from One MongoDB Cloud User
+
+ Removes one organization-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Organization Owner role.
+
+ **Note**: This operation is atomic.
+
+ **Note**: This resource cannot be used to remove a role from users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @param userId Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.
+ @param addOrRemoveOrgRole Organization-level role to remove from the MongoDB Cloud user.
+ @return RemoveOrganizationRoleApiRequest
+ */
+ RemoveOrganizationRole(ctx context.Context, orgId string, userId string, addOrRemoveOrgRole *AddOrRemoveOrgRole) RemoveOrganizationRoleApiRequest
+ /*
+ RemoveOrganizationRole Remove One Organization Role from One MongoDB Cloud User
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param RemoveOrganizationRoleApiParams - Parameters for the request
+ @return RemoveOrganizationRoleApiRequest
+ */
+ RemoveOrganizationRoleWithParams(ctx context.Context, args *RemoveOrganizationRoleApiParams) RemoveOrganizationRoleApiRequest
+
+ // Method available only for mocking purposes
+ RemoveOrganizationRoleExecute(r RemoveOrganizationRoleApiRequest) (*OrgUserResponse, *http.Response, error)
+
+ /*
+ RemoveProjectRole Remove One Project Role from One MongoDB Cloud User
+
+ Removes one project-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has been invited to join the project. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Project Owner role.
+
+ **Note**: This resource cannot be used to remove a role from users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param userId Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.
+ @param addOrRemoveGroupRole Project-level role to remove from the MongoDB Cloud user.
+ @return RemoveProjectRoleApiRequest
+ */
+ RemoveProjectRole(ctx context.Context, groupId string, userId string, addOrRemoveGroupRole *AddOrRemoveGroupRole) RemoveProjectRoleApiRequest
+ /*
+ RemoveProjectRole Remove One Project Role from One MongoDB Cloud User
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param RemoveProjectRoleApiParams - Parameters for the request
+ @return RemoveProjectRoleApiRequest
+ */
+ RemoveProjectRoleWithParams(ctx context.Context, args *RemoveProjectRoleApiParams) RemoveProjectRoleApiRequest
+
+ // Method available only for mocking purposes
+ RemoveProjectRoleExecute(r RemoveProjectRoleApiRequest) (*OrgUserResponse, *http.Response, error)
+
+ /*
+ RemoveUserFromTeam Remove One MongoDB Cloud User from One Team
+
+ Removes one MongoDB Cloud user from one team. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.
+
+ **Note**: This resource cannot be used to remove a user invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @param teamId Unique 24-hexadecimal digit string that identifies the team to remove the MongoDB user from.
+ @param addOrRemoveUserFromTeam The id of the active or pending MongoDB Cloud user that you want to remove from the specified team.
+ @return RemoveUserFromTeamApiRequest
+ */
+ RemoveUserFromTeam(ctx context.Context, orgId string, teamId string, addOrRemoveUserFromTeam *AddOrRemoveUserFromTeam) RemoveUserFromTeamApiRequest
+ /*
+ RemoveUserFromTeam Remove One MongoDB Cloud User from One Team
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param RemoveUserFromTeamApiParams - Parameters for the request
+ @return RemoveUserFromTeamApiRequest
+ */
+ RemoveUserFromTeamWithParams(ctx context.Context, args *RemoveUserFromTeamApiParams) RemoveUserFromTeamApiRequest
+
+ // Method available only for mocking purposes
+ RemoveUserFromTeamExecute(r RemoveUserFromTeamApiRequest) (*OrgUserResponse, *http.Response, error)
+
+ /*
+ UpdateOrganizationUser Update One MongoDB Cloud User in One Organization
+
+ Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.
+
+ **Note**: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user.
+
+ **Note**: This resource cannot be used to update pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @param userId Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.
+ @param orgUserUpdateRequest Represents the roles and teams to assign the MongoDB Cloud user.
+ @return UpdateOrganizationUserApiRequest
+ */
+ UpdateOrganizationUser(ctx context.Context, orgId string, userId string, orgUserUpdateRequest *OrgUserUpdateRequest) UpdateOrganizationUserApiRequest
+ /*
+ UpdateOrganizationUser Update One MongoDB Cloud User in One Organization
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param UpdateOrganizationUserApiParams - Parameters for the request
+ @return UpdateOrganizationUserApiRequest
+ */
+ UpdateOrganizationUserWithParams(ctx context.Context, args *UpdateOrganizationUserApiParams) UpdateOrganizationUserApiRequest
+
+ // Method available only for mocking purposes
+ UpdateOrganizationUserExecute(r UpdateOrganizationUserApiRequest) (*OrgUserResponse, *http.Response, error)
}
// MongoDBCloudUsersApiService MongoDBCloudUsersApi service
type MongoDBCloudUsersApiService service
-type CreateUserApiRequest struct {
- ctx context.Context
- ApiService MongoDBCloudUsersApi
- cloudAppUser *CloudAppUser
+type AddOrganizationRoleApiRequest struct {
+ ctx context.Context
+ ApiService MongoDBCloudUsersApi
+ orgId string
+ userId string
+ addOrRemoveOrgRole *AddOrRemoveOrgRole
}
-type CreateUserApiParams struct {
- CloudAppUser *CloudAppUser
+type AddOrganizationRoleApiParams struct {
+ OrgId string
+ UserId string
+ AddOrRemoveOrgRole *AddOrRemoveOrgRole
}
-func (a *MongoDBCloudUsersApiService) CreateUserWithParams(ctx context.Context, args *CreateUserApiParams) CreateUserApiRequest {
- return CreateUserApiRequest{
- ApiService: a,
- ctx: ctx,
- cloudAppUser: args.CloudAppUser,
+func (a *MongoDBCloudUsersApiService) AddOrganizationRoleWithParams(ctx context.Context, args *AddOrganizationRoleApiParams) AddOrganizationRoleApiRequest {
+ return AddOrganizationRoleApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: args.OrgId,
+ userId: args.UserId,
+ addOrRemoveOrgRole: args.AddOrRemoveOrgRole,
}
}
-func (r CreateUserApiRequest) Execute() (*CloudAppUser, *http.Response, error) {
- return r.ApiService.CreateUserExecute(r)
+func (r AddOrganizationRoleApiRequest) Execute() (*OrgUserResponse, *http.Response, error) {
+ return r.ApiService.AddOrganizationRoleExecute(r)
}
/*
-CreateUser Create One MongoDB Cloud User
+AddOrganizationRole Add One Organization Role to One MongoDB Cloud User
-Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.
+Adds one organization-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.
- MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization.
+**Note**: This operation is atomic.
- To use this resource, the requesting API Key can have any role.
+**Note**: This resource cannot be used to add a role to users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @return CreateUserApiRequest
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @param userId Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.
+ @return AddOrganizationRoleApiRequest
*/
-func (a *MongoDBCloudUsersApiService) CreateUser(ctx context.Context, cloudAppUser *CloudAppUser) CreateUserApiRequest {
- return CreateUserApiRequest{
- ApiService: a,
- ctx: ctx,
- cloudAppUser: cloudAppUser,
+func (a *MongoDBCloudUsersApiService) AddOrganizationRole(ctx context.Context, orgId string, userId string, addOrRemoveOrgRole *AddOrRemoveOrgRole) AddOrganizationRoleApiRequest {
+ return AddOrganizationRoleApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: orgId,
+ userId: userId,
+ addOrRemoveOrgRole: addOrRemoveOrgRole,
}
}
-// CreateUserExecute executes the request
+// AddOrganizationRoleExecute executes the request
//
-// @return CloudAppUser
-func (a *MongoDBCloudUsersApiService) CreateUserExecute(r CreateUserApiRequest) (*CloudAppUser, *http.Response, error) {
+// @return OrgUserResponse
+func (a *MongoDBCloudUsersApiService) AddOrganizationRoleExecute(r AddOrganizationRoleApiRequest) (*OrgUserResponse, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody any
formFiles []formFile
- localVarReturnValue *CloudAppUser
+ localVarReturnValue *OrgUserResponse
)
- localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.CreateUser")
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.AddOrganizationRole")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
- localVarPath := localBasePath + "/api/atlas/v2/users"
+ localVarPath := localBasePath + "/api/atlas/v2/orgs/{orgId}/users/{userId}:addRole"
+ localVarPath = strings.Replace(localVarPath, "{"+"orgId"+"}", url.PathEscape(r.orgId), -1)
+ localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", url.PathEscape(r.userId), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
- if r.cloudAppUser == nil {
- return localVarReturnValue, nil, reportError("cloudAppUser is required and must be specified")
+ if r.addOrRemoveOrgRole == nil {
+ return localVarReturnValue, nil, reportError("addOrRemoveOrgRole is required and must be specified")
}
// to determine the Content-Type header
- localVarHTTPContentTypes := []string{"application/vnd.atlas.2023-01-01+json"}
+ localVarHTTPContentTypes := []string{"application/vnd.atlas.2043-01-01+json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
@@ -166,7 +495,7 @@ func (a *MongoDBCloudUsersApiService) CreateUserExecute(r CreateUserApiRequest)
}
// to determine the Accept header (only first one)
- localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2023-01-01+json"}
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
@@ -174,7 +503,7 @@ func (a *MongoDBCloudUsersApiService) CreateUserExecute(r CreateUserApiRequest)
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
- localVarPostBody = r.cloudAppUser
+ localVarPostBody = r.addOrRemoveOrgRole
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
@@ -207,70 +536,85 @@ func (a *MongoDBCloudUsersApiService) CreateUserExecute(r CreateUserApiRequest)
return localVarReturnValue, localVarHTTPResponse, nil
}
-type GetUserApiRequest struct {
- ctx context.Context
- ApiService MongoDBCloudUsersApi
- userId string
+type AddProjectRoleApiRequest struct {
+ ctx context.Context
+ ApiService MongoDBCloudUsersApi
+ groupId string
+ userId string
+ addOrRemoveGroupRole *AddOrRemoveGroupRole
}
-type GetUserApiParams struct {
- UserId string
+type AddProjectRoleApiParams struct {
+ GroupId string
+ UserId string
+ AddOrRemoveGroupRole *AddOrRemoveGroupRole
}
-func (a *MongoDBCloudUsersApiService) GetUserWithParams(ctx context.Context, args *GetUserApiParams) GetUserApiRequest {
- return GetUserApiRequest{
- ApiService: a,
- ctx: ctx,
- userId: args.UserId,
+func (a *MongoDBCloudUsersApiService) AddProjectRoleWithParams(ctx context.Context, args *AddProjectRoleApiParams) AddProjectRoleApiRequest {
+ return AddProjectRoleApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ groupId: args.GroupId,
+ userId: args.UserId,
+ addOrRemoveGroupRole: args.AddOrRemoveGroupRole,
}
}
-func (r GetUserApiRequest) Execute() (*CloudAppUser, *http.Response, error) {
- return r.ApiService.GetUserExecute(r)
+func (r AddProjectRoleApiRequest) Execute() (*OrgUserResponse, *http.Response, error) {
+ return r.ApiService.AddProjectRoleExecute(r)
}
/*
-GetUser Return One MongoDB Cloud User using Its ID
+AddProjectRole Add One Project Role to One MongoDB Cloud User
-Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. You can't use this endpoint to return information on an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting API Key can have any role.
+Adds one project-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has been invited to join the project. To use this resource, the requesting API Key must have the Project Owner role.
+
+**Note**: This resource cannot be used to add a role to users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param userId Unique 24-hexadecimal digit string that identifies this user.
- @return GetUserApiRequest
+ @param groupId 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. **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.
+ @param userId Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.
+ @return AddProjectRoleApiRequest
*/
-func (a *MongoDBCloudUsersApiService) GetUser(ctx context.Context, userId string) GetUserApiRequest {
- return GetUserApiRequest{
- ApiService: a,
- ctx: ctx,
- userId: userId,
+func (a *MongoDBCloudUsersApiService) AddProjectRole(ctx context.Context, groupId string, userId string, addOrRemoveGroupRole *AddOrRemoveGroupRole) AddProjectRoleApiRequest {
+ return AddProjectRoleApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ groupId: groupId,
+ userId: userId,
+ addOrRemoveGroupRole: addOrRemoveGroupRole,
}
}
-// GetUserExecute executes the request
+// AddProjectRoleExecute executes the request
//
-// @return CloudAppUser
-func (a *MongoDBCloudUsersApiService) GetUserExecute(r GetUserApiRequest) (*CloudAppUser, *http.Response, error) {
+// @return OrgUserResponse
+func (a *MongoDBCloudUsersApiService) AddProjectRoleExecute(r AddProjectRoleApiRequest) (*OrgUserResponse, *http.Response, error) {
var (
- localVarHTTPMethod = http.MethodGet
+ localVarHTTPMethod = http.MethodPost
localVarPostBody any
formFiles []formFile
- localVarReturnValue *CloudAppUser
+ localVarReturnValue *OrgUserResponse
)
- localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.GetUser")
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.AddProjectRole")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
- localVarPath := localBasePath + "/api/atlas/v2/users/{userId}"
+ localVarPath := localBasePath + "/api/atlas/v2/groups/{groupId}/users/{userId}:addRole"
+ localVarPath = strings.Replace(localVarPath, "{"+"groupId"+"}", url.PathEscape(r.groupId), -1)
localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", url.PathEscape(r.userId), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
+ if r.addOrRemoveGroupRole == nil {
+ return localVarReturnValue, nil, reportError("addOrRemoveGroupRole is required and must be specified")
+ }
// to determine the Content-Type header
- localVarHTTPContentTypes := []string{}
+ localVarHTTPContentTypes := []string{"application/vnd.atlas.2043-01-01+json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
@@ -279,13 +623,15 @@ func (a *MongoDBCloudUsersApiService) GetUserExecute(r GetUserApiRequest) (*Clou
}
// to determine the Accept header (only first one)
- localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2023-01-01+json"}
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
+ // body params
+ localVarPostBody = r.addOrRemoveGroupRole
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
@@ -318,70 +664,1182 @@ func (a *MongoDBCloudUsersApiService) GetUserExecute(r GetUserApiRequest) (*Clou
return localVarReturnValue, localVarHTTPResponse, nil
}
-type GetUserByUsernameApiRequest struct {
- ctx context.Context
- ApiService MongoDBCloudUsersApi
- userName string
+type AddProjectUserApiRequest struct {
+ ctx context.Context
+ ApiService MongoDBCloudUsersApi
+ groupId string
+ groupUserRequest *GroupUserRequest
}
-type GetUserByUsernameApiParams struct {
- UserName string
+type AddProjectUserApiParams struct {
+ GroupId string
+ GroupUserRequest *GroupUserRequest
}
-func (a *MongoDBCloudUsersApiService) GetUserByUsernameWithParams(ctx context.Context, args *GetUserByUsernameApiParams) GetUserByUsernameApiRequest {
- return GetUserByUsernameApiRequest{
- ApiService: a,
- ctx: ctx,
- userName: args.UserName,
+func (a *MongoDBCloudUsersApiService) AddProjectUserWithParams(ctx context.Context, args *AddProjectUserApiParams) AddProjectUserApiRequest {
+ return AddProjectUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ groupId: args.GroupId,
+ groupUserRequest: args.GroupUserRequest,
}
}
-func (r GetUserByUsernameApiRequest) Execute() (*CloudAppUser, *http.Response, error) {
- return r.ApiService.GetUserByUsernameExecute(r)
+func (r AddProjectUserApiRequest) Execute() (*GroupUserResponse, *http.Response, error) {
+ return r.ApiService.AddProjectUserExecute(r)
}
/*
-GetUserByUsername Return One MongoDB Cloud User using Their Username
+AddProjectUser Add One MongoDB Cloud User to One Project
-Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. To use this resource, the requesting API Key can have any role.
+Adds one MongoDB Cloud user to one project. To use this resource, the requesting API Key must have the Project Owner role.
+- If the user has a pending invitation to join the project's organization, MongoDB Cloud modifies it and grants project access.
+- If the user doesn't have an invitation to join the organization, MongoDB Cloud sends a new invitation that grants the user organization and project access.
+- If the user is already active in the project's organization, MongoDB Cloud grants access to the project.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param userName Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.
- @return GetUserByUsernameApiRequest
+ @param groupId 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. **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.
+ @return AddProjectUserApiRequest
*/
-func (a *MongoDBCloudUsersApiService) GetUserByUsername(ctx context.Context, userName string) GetUserByUsernameApiRequest {
- return GetUserByUsernameApiRequest{
- ApiService: a,
- ctx: ctx,
+func (a *MongoDBCloudUsersApiService) AddProjectUser(ctx context.Context, groupId string, groupUserRequest *GroupUserRequest) AddProjectUserApiRequest {
+ return AddProjectUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ groupId: groupId,
+ groupUserRequest: groupUserRequest,
+ }
+}
+
+// AddProjectUserExecute executes the request
+//
+// @return GroupUserResponse
+func (a *MongoDBCloudUsersApiService) AddProjectUserExecute(r AddProjectUserApiRequest) (*GroupUserResponse, *http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodPost
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue *GroupUserResponse
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.AddProjectUser")
+ if err != nil {
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/groups/{groupId}/users"
+ localVarPath = strings.Replace(localVarPath, "{"+"groupId"+"}", url.PathEscape(r.groupId), -1)
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+ if r.groupUserRequest == nil {
+ return localVarReturnValue, nil, reportError("groupUserRequest is required and must be specified")
+ }
+
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{"application/vnd.atlas.2043-01-01+json"}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header (only first one)
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ // body params
+ localVarPostBody = r.groupUserRequest
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
+
+type AddUserToTeamApiRequest struct {
+ ctx context.Context
+ ApiService MongoDBCloudUsersApi
+ orgId string
+ teamId string
+ addOrRemoveUserFromTeam *AddOrRemoveUserFromTeam
+}
+
+type AddUserToTeamApiParams struct {
+ OrgId string
+ TeamId string
+ AddOrRemoveUserFromTeam *AddOrRemoveUserFromTeam
+}
+
+func (a *MongoDBCloudUsersApiService) AddUserToTeamWithParams(ctx context.Context, args *AddUserToTeamApiParams) AddUserToTeamApiRequest {
+ return AddUserToTeamApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: args.OrgId,
+ teamId: args.TeamId,
+ addOrRemoveUserFromTeam: args.AddOrRemoveUserFromTeam,
+ }
+}
+
+func (r AddUserToTeamApiRequest) Execute() (*OrgUserResponse, *http.Response, error) {
+ return r.ApiService.AddUserToTeamExecute(r)
+}
+
+/*
+AddUserToTeam Add One MongoDB Cloud User to One Team
+
+Adds one MongoDB Cloud user to one team. You can add an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.
+
+**Note**: This resource cannot be used to add a user invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @param teamId Unique 24-hexadecimal digit string that identifies the team to add the MongoDB Cloud user to.
+ @return AddUserToTeamApiRequest
+*/
+func (a *MongoDBCloudUsersApiService) AddUserToTeam(ctx context.Context, orgId string, teamId string, addOrRemoveUserFromTeam *AddOrRemoveUserFromTeam) AddUserToTeamApiRequest {
+ return AddUserToTeamApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: orgId,
+ teamId: teamId,
+ addOrRemoveUserFromTeam: addOrRemoveUserFromTeam,
+ }
+}
+
+// AddUserToTeamExecute executes the request
+//
+// @return OrgUserResponse
+func (a *MongoDBCloudUsersApiService) AddUserToTeamExecute(r AddUserToTeamApiRequest) (*OrgUserResponse, *http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodPost
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue *OrgUserResponse
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.AddUserToTeam")
+ if err != nil {
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser"
+ localVarPath = strings.Replace(localVarPath, "{"+"orgId"+"}", url.PathEscape(r.orgId), -1)
+ localVarPath = strings.Replace(localVarPath, "{"+"teamId"+"}", url.PathEscape(r.teamId), -1)
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+ if r.addOrRemoveUserFromTeam == nil {
+ return localVarReturnValue, nil, reportError("addOrRemoveUserFromTeam is required and must be specified")
+ }
+
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{"application/vnd.atlas.2043-01-01+json"}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header (only first one)
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ // body params
+ localVarPostBody = r.addOrRemoveUserFromTeam
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
+
+type CreateOrganizationUserApiRequest struct {
+ ctx context.Context
+ ApiService MongoDBCloudUsersApi
+ orgId string
+ orgUserRequest *OrgUserRequest
+}
+
+type CreateOrganizationUserApiParams struct {
+ OrgId string
+ OrgUserRequest *OrgUserRequest
+}
+
+func (a *MongoDBCloudUsersApiService) CreateOrganizationUserWithParams(ctx context.Context, args *CreateOrganizationUserApiParams) CreateOrganizationUserApiRequest {
+ return CreateOrganizationUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: args.OrgId,
+ orgUserRequest: args.OrgUserRequest,
+ }
+}
+
+func (r CreateOrganizationUserApiRequest) Execute() (*OrgUserResponse, *http.Response, error) {
+ return r.ApiService.CreateOrganizationUserExecute(r)
+}
+
+/*
+CreateOrganizationUser Add One MongoDB Cloud User to One Organization
+
+Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting API Key must have the Organization Owner role.
+
+**Note**: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @return CreateOrganizationUserApiRequest
+*/
+func (a *MongoDBCloudUsersApiService) CreateOrganizationUser(ctx context.Context, orgId string, orgUserRequest *OrgUserRequest) CreateOrganizationUserApiRequest {
+ return CreateOrganizationUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: orgId,
+ orgUserRequest: orgUserRequest,
+ }
+}
+
+// CreateOrganizationUserExecute executes the request
+//
+// @return OrgUserResponse
+func (a *MongoDBCloudUsersApiService) CreateOrganizationUserExecute(r CreateOrganizationUserApiRequest) (*OrgUserResponse, *http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodPost
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue *OrgUserResponse
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.CreateOrganizationUser")
+ if err != nil {
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/orgs/{orgId}/users"
+ localVarPath = strings.Replace(localVarPath, "{"+"orgId"+"}", url.PathEscape(r.orgId), -1)
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+ if r.orgUserRequest == nil {
+ return localVarReturnValue, nil, reportError("orgUserRequest is required and must be specified")
+ }
+
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{"application/vnd.atlas.2043-01-01+json"}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header (only first one)
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ // body params
+ localVarPostBody = r.orgUserRequest
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
+
+type CreateUserApiRequest struct {
+ ctx context.Context
+ ApiService MongoDBCloudUsersApi
+ cloudAppUser *CloudAppUser
+}
+
+type CreateUserApiParams struct {
+ CloudAppUser *CloudAppUser
+}
+
+func (a *MongoDBCloudUsersApiService) CreateUserWithParams(ctx context.Context, args *CreateUserApiParams) CreateUserApiRequest {
+ return CreateUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ cloudAppUser: args.CloudAppUser,
+ }
+}
+
+func (r CreateUserApiRequest) Execute() (*CloudAppUser, *http.Response, error) {
+ return r.ApiService.CreateUserExecute(r)
+}
+
+/*
+CreateUser Create One MongoDB Cloud User
+
+Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.
+
+ MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization.
+
+ To use this resource, the requesting API Key can have any role.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @return CreateUserApiRequest
+
+Deprecated
+*/
+func (a *MongoDBCloudUsersApiService) CreateUser(ctx context.Context, cloudAppUser *CloudAppUser) CreateUserApiRequest {
+ return CreateUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ cloudAppUser: cloudAppUser,
+ }
+}
+
+// CreateUserExecute executes the request
+//
+// @return CloudAppUser
+//
+// Deprecated
+func (a *MongoDBCloudUsersApiService) CreateUserExecute(r CreateUserApiRequest) (*CloudAppUser, *http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodPost
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue *CloudAppUser
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.CreateUser")
+ if err != nil {
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/users"
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+ if r.cloudAppUser == nil {
+ return localVarReturnValue, nil, reportError("cloudAppUser is required and must be specified")
+ }
+
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{"application/vnd.atlas.2023-01-01+json"}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header (only first one)
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2023-01-01+json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ // body params
+ localVarPostBody = r.cloudAppUser
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
+
+type GetOrganizationUserApiRequest struct {
+ ctx context.Context
+ ApiService MongoDBCloudUsersApi
+ orgId string
+ userId string
+}
+
+type GetOrganizationUserApiParams struct {
+ OrgId string
+ UserId string
+}
+
+func (a *MongoDBCloudUsersApiService) GetOrganizationUserWithParams(ctx context.Context, args *GetOrganizationUserApiParams) GetOrganizationUserApiRequest {
+ return GetOrganizationUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: args.OrgId,
+ userId: args.UserId,
+ }
+}
+
+func (r GetOrganizationUserApiRequest) Execute() (*OrgUserResponse, *http.Response, error) {
+ return r.ApiService.GetOrganizationUserExecute(r)
+}
+
+/*
+GetOrganizationUser Return One MongoDB Cloud User in One Organization
+
+Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting API Key must have the Organization Member role.
+
+**Note**: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint.
+
+**Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @param userId Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.
+ @return GetOrganizationUserApiRequest
+*/
+func (a *MongoDBCloudUsersApiService) GetOrganizationUser(ctx context.Context, orgId string, userId string) GetOrganizationUserApiRequest {
+ return GetOrganizationUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: orgId,
+ userId: userId,
+ }
+}
+
+// GetOrganizationUserExecute executes the request
+//
+// @return OrgUserResponse
+func (a *MongoDBCloudUsersApiService) GetOrganizationUserExecute(r GetOrganizationUserApiRequest) (*OrgUserResponse, *http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodGet
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue *OrgUserResponse
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.GetOrganizationUser")
+ if err != nil {
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/orgs/{orgId}/users/{userId}"
+ localVarPath = strings.Replace(localVarPath, "{"+"orgId"+"}", url.PathEscape(r.orgId), -1)
+ localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", url.PathEscape(r.userId), -1)
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header (only first one)
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
+
+type GetProjectUserApiRequest struct {
+ ctx context.Context
+ ApiService MongoDBCloudUsersApi
+ groupId string
+ userId string
+}
+
+type GetProjectUserApiParams struct {
+ GroupId string
+ UserId string
+}
+
+func (a *MongoDBCloudUsersApiService) GetProjectUserWithParams(ctx context.Context, args *GetProjectUserApiParams) GetProjectUserApiRequest {
+ return GetProjectUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ groupId: args.GroupId,
+ userId: args.UserId,
+ }
+}
+
+func (r GetProjectUserApiRequest) Execute() (*GroupUserResponse, *http.Response, error) {
+ return r.ApiService.GetProjectUserExecute(r)
+}
+
+/*
+GetProjectUser Return One MongoDB Cloud User in One Project
+
+Returns information about the specified MongoDB Cloud user within the context of the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+
+**Note**: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint.
+
+**Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param userId Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.
+ @return GetProjectUserApiRequest
+*/
+func (a *MongoDBCloudUsersApiService) GetProjectUser(ctx context.Context, groupId string, userId string) GetProjectUserApiRequest {
+ return GetProjectUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ groupId: groupId,
+ userId: userId,
+ }
+}
+
+// GetProjectUserExecute executes the request
+//
+// @return GroupUserResponse
+func (a *MongoDBCloudUsersApiService) GetProjectUserExecute(r GetProjectUserApiRequest) (*GroupUserResponse, *http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodGet
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue *GroupUserResponse
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.GetProjectUser")
+ if err != nil {
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/groups/{groupId}/users/{userId}"
+ localVarPath = strings.Replace(localVarPath, "{"+"groupId"+"}", url.PathEscape(r.groupId), -1)
+ localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", url.PathEscape(r.userId), -1)
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header (only first one)
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
+
+type GetUserApiRequest struct {
+ ctx context.Context
+ ApiService MongoDBCloudUsersApi
+ userId string
+}
+
+type GetUserApiParams struct {
+ UserId string
+}
+
+func (a *MongoDBCloudUsersApiService) GetUserWithParams(ctx context.Context, args *GetUserApiParams) GetUserApiRequest {
+ return GetUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ userId: args.UserId,
+ }
+}
+
+func (r GetUserApiRequest) Execute() (*CloudAppUser, *http.Response, error) {
+ return r.ApiService.GetUserExecute(r)
+}
+
+/*
+GetUser Return One MongoDB Cloud User using Its ID
+
+Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. You can't use this endpoint to return information on an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting API Key can have any role.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param userId Unique 24-hexadecimal digit string that identifies this user.
+ @return GetUserApiRequest
+
+Deprecated
+*/
+func (a *MongoDBCloudUsersApiService) GetUser(ctx context.Context, userId string) GetUserApiRequest {
+ return GetUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ userId: userId,
+ }
+}
+
+// GetUserExecute executes the request
+//
+// @return CloudAppUser
+//
+// Deprecated
+func (a *MongoDBCloudUsersApiService) GetUserExecute(r GetUserApiRequest) (*CloudAppUser, *http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodGet
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue *CloudAppUser
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.GetUser")
+ if err != nil {
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/users/{userId}"
+ localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", url.PathEscape(r.userId), -1)
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header (only first one)
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2023-01-01+json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
+
+type GetUserByUsernameApiRequest struct {
+ ctx context.Context
+ ApiService MongoDBCloudUsersApi
+ userName string
+}
+
+type GetUserByUsernameApiParams struct {
+ UserName string
+}
+
+func (a *MongoDBCloudUsersApiService) GetUserByUsernameWithParams(ctx context.Context, args *GetUserByUsernameApiParams) GetUserByUsernameApiRequest {
+ return GetUserByUsernameApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ userName: args.UserName,
+ }
+}
+
+func (r GetUserByUsernameApiRequest) Execute() (*CloudAppUser, *http.Response, error) {
+ return r.ApiService.GetUserByUsernameExecute(r)
+}
+
+/*
+GetUserByUsername Return One MongoDB Cloud User using Their Username
+
+Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. To use this resource, the requesting API Key can have any role.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param userName Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.
+ @return GetUserByUsernameApiRequest
+
+Deprecated
+*/
+func (a *MongoDBCloudUsersApiService) GetUserByUsername(ctx context.Context, userName string) GetUserByUsernameApiRequest {
+ return GetUserByUsernameApiRequest{
+ ApiService: a,
+ ctx: ctx,
userName: userName,
}
}
-// GetUserByUsernameExecute executes the request
+// GetUserByUsernameExecute executes the request
+//
+// @return CloudAppUser
+//
+// Deprecated
+func (a *MongoDBCloudUsersApiService) GetUserByUsernameExecute(r GetUserByUsernameApiRequest) (*CloudAppUser, *http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodGet
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue *CloudAppUser
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.GetUserByUsername")
+ if err != nil {
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/users/byName/{userName}"
+ localVarPath = strings.Replace(localVarPath, "{"+"userName"+"}", url.PathEscape(r.userName), -1)
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header (only first one)
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2023-01-01+json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
+
+type RemoveOrganizationRoleApiRequest struct {
+ ctx context.Context
+ ApiService MongoDBCloudUsersApi
+ orgId string
+ userId string
+ addOrRemoveOrgRole *AddOrRemoveOrgRole
+}
+
+type RemoveOrganizationRoleApiParams struct {
+ OrgId string
+ UserId string
+ AddOrRemoveOrgRole *AddOrRemoveOrgRole
+}
+
+func (a *MongoDBCloudUsersApiService) RemoveOrganizationRoleWithParams(ctx context.Context, args *RemoveOrganizationRoleApiParams) RemoveOrganizationRoleApiRequest {
+ return RemoveOrganizationRoleApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: args.OrgId,
+ userId: args.UserId,
+ addOrRemoveOrgRole: args.AddOrRemoveOrgRole,
+ }
+}
+
+func (r RemoveOrganizationRoleApiRequest) Execute() (*OrgUserResponse, *http.Response, error) {
+ return r.ApiService.RemoveOrganizationRoleExecute(r)
+}
+
+/*
+RemoveOrganizationRole Remove One Organization Role from One MongoDB Cloud User
+
+Removes one organization-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Organization Owner role.
+
+**Note**: This operation is atomic.
+
+**Note**: This resource cannot be used to remove a role from users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @param userId Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.
+ @return RemoveOrganizationRoleApiRequest
+*/
+func (a *MongoDBCloudUsersApiService) RemoveOrganizationRole(ctx context.Context, orgId string, userId string, addOrRemoveOrgRole *AddOrRemoveOrgRole) RemoveOrganizationRoleApiRequest {
+ return RemoveOrganizationRoleApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: orgId,
+ userId: userId,
+ addOrRemoveOrgRole: addOrRemoveOrgRole,
+ }
+}
+
+// RemoveOrganizationRoleExecute executes the request
+//
+// @return OrgUserResponse
+func (a *MongoDBCloudUsersApiService) RemoveOrganizationRoleExecute(r RemoveOrganizationRoleApiRequest) (*OrgUserResponse, *http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodPost
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue *OrgUserResponse
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.RemoveOrganizationRole")
+ if err != nil {
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole"
+ localVarPath = strings.Replace(localVarPath, "{"+"orgId"+"}", url.PathEscape(r.orgId), -1)
+ localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", url.PathEscape(r.userId), -1)
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+ if r.addOrRemoveOrgRole == nil {
+ return localVarReturnValue, nil, reportError("addOrRemoveOrgRole is required and must be specified")
+ }
+
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{"application/vnd.atlas.2043-01-01+json"}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header (only first one)
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ // body params
+ localVarPostBody = r.addOrRemoveOrgRole
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
+
+type RemoveProjectRoleApiRequest struct {
+ ctx context.Context
+ ApiService MongoDBCloudUsersApi
+ groupId string
+ userId string
+ addOrRemoveGroupRole *AddOrRemoveGroupRole
+}
+
+type RemoveProjectRoleApiParams struct {
+ GroupId string
+ UserId string
+ AddOrRemoveGroupRole *AddOrRemoveGroupRole
+}
+
+func (a *MongoDBCloudUsersApiService) RemoveProjectRoleWithParams(ctx context.Context, args *RemoveProjectRoleApiParams) RemoveProjectRoleApiRequest {
+ return RemoveProjectRoleApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ groupId: args.GroupId,
+ userId: args.UserId,
+ addOrRemoveGroupRole: args.AddOrRemoveGroupRole,
+ }
+}
+
+func (r RemoveProjectRoleApiRequest) Execute() (*OrgUserResponse, *http.Response, error) {
+ return r.ApiService.RemoveProjectRoleExecute(r)
+}
+
+/*
+RemoveProjectRole Remove One Project Role from One MongoDB Cloud User
+
+Removes one project-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has been invited to join the project. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Project Owner role.
+
+**Note**: This resource cannot be used to remove a role from users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param userId Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.
+ @return RemoveProjectRoleApiRequest
+*/
+func (a *MongoDBCloudUsersApiService) RemoveProjectRole(ctx context.Context, groupId string, userId string, addOrRemoveGroupRole *AddOrRemoveGroupRole) RemoveProjectRoleApiRequest {
+ return RemoveProjectRoleApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ groupId: groupId,
+ userId: userId,
+ addOrRemoveGroupRole: addOrRemoveGroupRole,
+ }
+}
+
+// RemoveProjectRoleExecute executes the request
//
-// @return CloudAppUser
-func (a *MongoDBCloudUsersApiService) GetUserByUsernameExecute(r GetUserByUsernameApiRequest) (*CloudAppUser, *http.Response, error) {
+// @return OrgUserResponse
+func (a *MongoDBCloudUsersApiService) RemoveProjectRoleExecute(r RemoveProjectRoleApiRequest) (*OrgUserResponse, *http.Response, error) {
var (
- localVarHTTPMethod = http.MethodGet
+ localVarHTTPMethod = http.MethodPost
localVarPostBody any
formFiles []formFile
- localVarReturnValue *CloudAppUser
+ localVarReturnValue *OrgUserResponse
)
- localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.GetUserByUsername")
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.RemoveProjectRole")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
- localVarPath := localBasePath + "/api/atlas/v2/users/byName/{userName}"
- localVarPath = strings.Replace(localVarPath, "{"+"userName"+"}", url.PathEscape(r.userName), -1)
+ localVarPath := localBasePath + "/api/atlas/v2/groups/{groupId}/users/{userId}:removeRole"
+ localVarPath = strings.Replace(localVarPath, "{"+"groupId"+"}", url.PathEscape(r.groupId), -1)
+ localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", url.PathEscape(r.userId), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
+ if r.addOrRemoveGroupRole == nil {
+ return localVarReturnValue, nil, reportError("addOrRemoveGroupRole is required and must be specified")
+ }
// to determine the Content-Type header
- localVarHTTPContentTypes := []string{}
+ localVarHTTPContentTypes := []string{"application/vnd.atlas.2043-01-01+json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
@@ -390,13 +1848,273 @@ func (a *MongoDBCloudUsersApiService) GetUserByUsernameExecute(r GetUserByUserna
}
// to determine the Accept header (only first one)
- localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2023-01-01+json"}
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ // body params
+ localVarPostBody = r.addOrRemoveGroupRole
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
+
+type RemoveUserFromTeamApiRequest struct {
+ ctx context.Context
+ ApiService MongoDBCloudUsersApi
+ orgId string
+ teamId string
+ addOrRemoveUserFromTeam *AddOrRemoveUserFromTeam
+}
+
+type RemoveUserFromTeamApiParams struct {
+ OrgId string
+ TeamId string
+ AddOrRemoveUserFromTeam *AddOrRemoveUserFromTeam
+}
+
+func (a *MongoDBCloudUsersApiService) RemoveUserFromTeamWithParams(ctx context.Context, args *RemoveUserFromTeamApiParams) RemoveUserFromTeamApiRequest {
+ return RemoveUserFromTeamApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: args.OrgId,
+ teamId: args.TeamId,
+ addOrRemoveUserFromTeam: args.AddOrRemoveUserFromTeam,
+ }
+}
+
+func (r RemoveUserFromTeamApiRequest) Execute() (*OrgUserResponse, *http.Response, error) {
+ return r.ApiService.RemoveUserFromTeamExecute(r)
+}
+
+/*
+RemoveUserFromTeam Remove One MongoDB Cloud User from One Team
+
+Removes one MongoDB Cloud user from one team. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.
+
+**Note**: This resource cannot be used to remove a user invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @param teamId Unique 24-hexadecimal digit string that identifies the team to remove the MongoDB user from.
+ @return RemoveUserFromTeamApiRequest
+*/
+func (a *MongoDBCloudUsersApiService) RemoveUserFromTeam(ctx context.Context, orgId string, teamId string, addOrRemoveUserFromTeam *AddOrRemoveUserFromTeam) RemoveUserFromTeamApiRequest {
+ return RemoveUserFromTeamApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: orgId,
+ teamId: teamId,
+ addOrRemoveUserFromTeam: addOrRemoveUserFromTeam,
+ }
+}
+
+// RemoveUserFromTeamExecute executes the request
+//
+// @return OrgUserResponse
+func (a *MongoDBCloudUsersApiService) RemoveUserFromTeamExecute(r RemoveUserFromTeamApiRequest) (*OrgUserResponse, *http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodPost
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue *OrgUserResponse
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.RemoveUserFromTeam")
+ if err != nil {
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser"
+ localVarPath = strings.Replace(localVarPath, "{"+"orgId"+"}", url.PathEscape(r.orgId), -1)
+ localVarPath = strings.Replace(localVarPath, "{"+"teamId"+"}", url.PathEscape(r.teamId), -1)
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+ if r.addOrRemoveUserFromTeam == nil {
+ return localVarReturnValue, nil, reportError("addOrRemoveUserFromTeam is required and must be specified")
+ }
+
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{"application/vnd.atlas.2043-01-01+json"}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header (only first one)
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ // body params
+ localVarPostBody = r.addOrRemoveUserFromTeam
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
+
+type UpdateOrganizationUserApiRequest struct {
+ ctx context.Context
+ ApiService MongoDBCloudUsersApi
+ orgId string
+ userId string
+ orgUserUpdateRequest *OrgUserUpdateRequest
+}
+
+type UpdateOrganizationUserApiParams struct {
+ OrgId string
+ UserId string
+ OrgUserUpdateRequest *OrgUserUpdateRequest
+}
+
+func (a *MongoDBCloudUsersApiService) UpdateOrganizationUserWithParams(ctx context.Context, args *UpdateOrganizationUserApiParams) UpdateOrganizationUserApiRequest {
+ return UpdateOrganizationUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: args.OrgId,
+ userId: args.UserId,
+ orgUserUpdateRequest: args.OrgUserUpdateRequest,
+ }
+}
+
+func (r UpdateOrganizationUserApiRequest) Execute() (*OrgUserResponse, *http.Response, error) {
+ return r.ApiService.UpdateOrganizationUserExecute(r)
+}
+
+/*
+UpdateOrganizationUser Update One MongoDB Cloud User in One Organization
+
+Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.
+
+**Note**: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user.
+
+**Note**: This resource cannot be used to update pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @param userId Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.
+ @return UpdateOrganizationUserApiRequest
+*/
+func (a *MongoDBCloudUsersApiService) UpdateOrganizationUser(ctx context.Context, orgId string, userId string, orgUserUpdateRequest *OrgUserUpdateRequest) UpdateOrganizationUserApiRequest {
+ return UpdateOrganizationUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: orgId,
+ userId: userId,
+ orgUserUpdateRequest: orgUserUpdateRequest,
+ }
+}
+
+// UpdateOrganizationUserExecute executes the request
+//
+// @return OrgUserResponse
+func (a *MongoDBCloudUsersApiService) UpdateOrganizationUserExecute(r UpdateOrganizationUserApiRequest) (*OrgUserResponse, *http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodPatch
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue *OrgUserResponse
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MongoDBCloudUsersApiService.UpdateOrganizationUser")
+ if err != nil {
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/orgs/{orgId}/users/{userId}"
+ localVarPath = strings.Replace(localVarPath, "{"+"orgId"+"}", url.PathEscape(r.orgId), -1)
+ localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", url.PathEscape(r.userId), -1)
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+ if r.orgUserUpdateRequest == nil {
+ return localVarReturnValue, nil, reportError("orgUserUpdateRequest is required and must be specified")
+ }
+
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{"application/vnd.atlas.2043-01-01+json"}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header (only first one)
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
+ // body params
+ localVarPostBody = r.orgUserUpdateRequest
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
diff --git a/admin/api_monitoring_and_logs.go b/admin/api_monitoring_and_logs.go
index 8567dfad2..9f48658b2 100644
--- a/admin/api_monitoring_and_logs.go
+++ b/admin/api_monitoring_and_logs.go
@@ -252,7 +252,7 @@ type MonitoringAndLogsApi interface {
/*
ListDatabases Return Available Databases for One MongoDB Process
- Returns the list of databases running on the specified host for the specified project. `M0` free clusters, `M2`, `M5`, and serverless clusters have some [operational limits](https://www.mongodb.com/docs/atlas/reference/free-shared-limitations/#operational-limitations). The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting API Key must have the Project Read Only role.
+ Returns the list of databases running on the specified host for the specified project. `M0` free clusters, `M2`, `M5`, serverless, and Flex clusters have some [operational limits](https://www.mongodb.com/docs/atlas/reference/limitations/). The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting API Key must have the Project Read Only role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -1934,7 +1934,7 @@ func (r ListDatabasesApiRequest) Execute() (*PaginatedDatabase, *http.Response,
/*
ListDatabases Return Available Databases for One MongoDB Process
-Returns the list of databases running on the specified host for the specified project. `M0` free clusters, `M2`, `M5`, and serverless clusters have some [operational limits](https://www.mongodb.com/docs/atlas/reference/free-shared-limitations/#operational-limitations). The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting API Key must have the Project Read Only role.
+Returns the list of databases running on the specified host for the specified project. `M0` free clusters, `M2`, `M5`, serverless, and Flex clusters have some [operational limits](https://www.mongodb.com/docs/atlas/reference/limitations/). The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting API Key must have the Project Read Only role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
diff --git a/admin/api_open_api.go b/admin/api_open_api.go
new file mode 100644
index 000000000..dddb1d9a3
--- /dev/null
+++ b/admin/api_open_api.go
@@ -0,0 +1,187 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+import (
+ "context"
+ "io"
+ "net/http"
+ "net/url"
+)
+
+type OpenAPIApi interface {
+
+ /*
+ GetApiVersions Provides a list of versions for a given environment.
+
+ API that provides a list of available versionsfor a given environment.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @return GetApiVersionsApiRequest
+ */
+ GetApiVersions(ctx context.Context) GetApiVersionsApiRequest
+ /*
+ GetApiVersions Provides a list of versions for a given environment.
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param GetApiVersionsApiParams - Parameters for the request
+ @return GetApiVersionsApiRequest
+ */
+ GetApiVersionsWithParams(ctx context.Context, args *GetApiVersionsApiParams) GetApiVersionsApiRequest
+
+ // Method available only for mocking purposes
+ GetApiVersionsExecute(r GetApiVersionsApiRequest) (*PaginatedApiVersions, *http.Response, error)
+}
+
+// OpenAPIApiService OpenAPIApi service
+type OpenAPIApiService service
+
+type GetApiVersionsApiRequest struct {
+ ctx context.Context
+ ApiService OpenAPIApi
+ itemsPerPage *int
+ pageNum *int
+ env *string
+}
+
+type GetApiVersionsApiParams struct {
+ ItemsPerPage *int
+ PageNum *int
+ Env *string
+}
+
+func (a *OpenAPIApiService) GetApiVersionsWithParams(ctx context.Context, args *GetApiVersionsApiParams) GetApiVersionsApiRequest {
+ return GetApiVersionsApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ itemsPerPage: args.ItemsPerPage,
+ pageNum: args.PageNum,
+ env: args.Env,
+ }
+}
+
+// Number of items that the response returns per page.
+func (r GetApiVersionsApiRequest) ItemsPerPage(itemsPerPage int) GetApiVersionsApiRequest {
+ r.itemsPerPage = &itemsPerPage
+ return r
+}
+
+// Number of the page that displays the current set of the total objects that the response returns.
+func (r GetApiVersionsApiRequest) PageNum(pageNum int) GetApiVersionsApiRequest {
+ r.pageNum = &pageNum
+ return r
+}
+
+// The environment to get the versions from. If not provided, it returnsthe versions for the given MongoDB URL. (E.g. prod for cloud.mongodb.com)
+func (r GetApiVersionsApiRequest) Env(env string) GetApiVersionsApiRequest {
+ r.env = &env
+ return r
+}
+
+func (r GetApiVersionsApiRequest) Execute() (*PaginatedApiVersions, *http.Response, error) {
+ return r.ApiService.GetApiVersionsExecute(r)
+}
+
+/*
+GetApiVersions Provides a list of versions for a given environment.
+
+API that provides a list of available versionsfor a given environment.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @return GetApiVersionsApiRequest
+*/
+func (a *OpenAPIApiService) GetApiVersions(ctx context.Context) GetApiVersionsApiRequest {
+ return GetApiVersionsApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ }
+}
+
+// GetApiVersionsExecute executes the request
+//
+// @return PaginatedApiVersions
+func (a *OpenAPIApiService) GetApiVersionsExecute(r GetApiVersionsApiRequest) (*PaginatedApiVersions, *http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodGet
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue *PaginatedApiVersions
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "OpenAPIApiService.GetApiVersions")
+ if err != nil {
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/unauth/openapi/versions"
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+
+ if r.itemsPerPage != nil {
+ parameterAddToHeaderOrQuery(localVarQueryParams, "itemsPerPage", r.itemsPerPage, "")
+ } else {
+ var defaultValue int = 100
+ r.itemsPerPage = &defaultValue
+ parameterAddToHeaderOrQuery(localVarQueryParams, "itemsPerPage", r.itemsPerPage, "")
+ }
+ if r.pageNum != nil {
+ parameterAddToHeaderOrQuery(localVarQueryParams, "pageNum", r.pageNum, "")
+ } else {
+ var defaultValue int = 1
+ r.pageNum = &defaultValue
+ parameterAddToHeaderOrQuery(localVarQueryParams, "pageNum", r.pageNum, "")
+ }
+ if r.env != nil {
+ parameterAddToHeaderOrQuery(localVarQueryParams, "env", r.env, "")
+ }
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header (only first one)
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2024-08-05+json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
diff --git a/admin/api_organizations.go b/admin/api_organizations.go
index 6fbcca175..4632eef48 100644
--- a/admin/api_organizations.go
+++ b/admin/api_organizations.go
@@ -44,6 +44,8 @@ type OrganizationsApi interface {
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@param organizationInvitationRequest Invites one MongoDB Cloud user to join the specified organization.
@return CreateOrganizationInvitationApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for OrganizationsApi
*/
CreateOrganizationInvitation(ctx context.Context, orgId string, organizationInvitationRequest *OrganizationInvitationRequest) CreateOrganizationInvitationApiRequest
/*
@@ -53,6 +55,8 @@ type OrganizationsApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param CreateOrganizationInvitationApiParams - Parameters for the request
@return CreateOrganizationInvitationApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for OrganizationsApi
*/
CreateOrganizationInvitationWithParams(ctx context.Context, args *CreateOrganizationInvitationApiParams) CreateOrganizationInvitationApiRequest
@@ -95,6 +99,8 @@ type OrganizationsApi interface {
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@param invitationId Unique 24-hexadecimal digit string that identifies the invitation.
@return DeleteOrganizationInvitationApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for OrganizationsApi
*/
DeleteOrganizationInvitation(ctx context.Context, orgId string, invitationId string) DeleteOrganizationInvitationApiRequest
/*
@@ -104,6 +110,8 @@ type OrganizationsApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param DeleteOrganizationInvitationApiParams - Parameters for the request
@return DeleteOrganizationInvitationApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for OrganizationsApi
*/
DeleteOrganizationInvitationWithParams(ctx context.Context, args *DeleteOrganizationInvitationApiParams) DeleteOrganizationInvitationApiRequest
@@ -142,6 +150,8 @@ type OrganizationsApi interface {
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@param invitationId Unique 24-hexadecimal digit string that identifies the invitation.
@return GetOrganizationInvitationApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for OrganizationsApi
*/
GetOrganizationInvitation(ctx context.Context, orgId string, invitationId string) GetOrganizationInvitationApiRequest
/*
@@ -151,6 +161,8 @@ type OrganizationsApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param GetOrganizationInvitationApiParams - Parameters for the request
@return GetOrganizationInvitationApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for OrganizationsApi
*/
GetOrganizationInvitationWithParams(ctx context.Context, args *GetOrganizationInvitationApiParams) GetOrganizationInvitationApiRequest
@@ -188,6 +200,8 @@ type OrganizationsApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@return ListOrganizationInvitationsApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for OrganizationsApi
*/
ListOrganizationInvitations(ctx context.Context, orgId string) ListOrganizationInvitationsApiRequest
/*
@@ -197,6 +211,8 @@ type OrganizationsApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ListOrganizationInvitationsApiParams - Parameters for the request
@return ListOrganizationInvitationsApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for OrganizationsApi
*/
ListOrganizationInvitationsWithParams(ctx context.Context, args *ListOrganizationInvitationsApiParams) ListOrganizationInvitationsApiRequest
@@ -236,7 +252,7 @@ type OrganizationsApi interface {
/*
ListOrganizationUsers Return All MongoDB Cloud Users in One Organization
- Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role.
+ Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role. Deprecated versions: v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@@ -254,7 +270,7 @@ type OrganizationsApi interface {
ListOrganizationUsersWithParams(ctx context.Context, args *ListOrganizationUsersApiParams) ListOrganizationUsersApiRequest
// Method available only for mocking purposes
- ListOrganizationUsersExecute(r ListOrganizationUsersApiRequest) (*PaginatedAppUser, *http.Response, error)
+ ListOrganizationUsersExecute(r ListOrganizationUsersApiRequest) (*PaginatedOrgUser, *http.Response, error)
/*
ListOrganizations Return All Organizations
@@ -281,7 +297,7 @@ type OrganizationsApi interface {
/*
RemoveOrganizationUser Remove One MongoDB Cloud User From One Organization
- Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role.
+ Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. Deprecated versions: v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@@ -335,6 +351,8 @@ type OrganizationsApi interface {
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@param organizationInvitationRequest Updates the details of one pending invitation to the specified organization.
@return UpdateOrganizationInvitationApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for OrganizationsApi
*/
UpdateOrganizationInvitation(ctx context.Context, orgId string, organizationInvitationRequest *OrganizationInvitationRequest) UpdateOrganizationInvitationApiRequest
/*
@@ -344,6 +362,8 @@ type OrganizationsApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param UpdateOrganizationInvitationApiParams - Parameters for the request
@return UpdateOrganizationInvitationApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for OrganizationsApi
*/
UpdateOrganizationInvitationWithParams(ctx context.Context, args *UpdateOrganizationInvitationApiParams) UpdateOrganizationInvitationApiRequest
@@ -360,6 +380,8 @@ type OrganizationsApi interface {
@param invitationId Unique 24-hexadecimal digit string that identifies the invitation.
@param organizationInvitationUpdateRequest Updates the details of one pending invitation to the specified organization.
@return UpdateOrganizationInvitationByIdApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for OrganizationsApi
*/
UpdateOrganizationInvitationById(ctx context.Context, orgId string, invitationId string, organizationInvitationUpdateRequest *OrganizationInvitationUpdateRequest) UpdateOrganizationInvitationByIdApiRequest
/*
@@ -369,6 +391,8 @@ type OrganizationsApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param UpdateOrganizationInvitationByIdApiParams - Parameters for the request
@return UpdateOrganizationInvitationByIdApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for OrganizationsApi
*/
UpdateOrganizationInvitationByIdWithParams(ctx context.Context, args *UpdateOrganizationInvitationByIdApiParams) UpdateOrganizationInvitationByIdApiRequest
@@ -385,6 +409,8 @@ type OrganizationsApi interface {
@param userId Unique 24-hexadecimal digit string that identifies the user to modify.
@param updateOrgRolesForUser Roles to update for the specified user.
@return UpdateOrganizationRolesApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for OrganizationsApi
*/
UpdateOrganizationRoles(ctx context.Context, orgId string, userId string, updateOrgRolesForUser *UpdateOrgRolesForUser) UpdateOrganizationRolesApiRequest
/*
@@ -394,6 +420,8 @@ type OrganizationsApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param UpdateOrganizationRolesApiParams - Parameters for the request
@return UpdateOrganizationRolesApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for OrganizationsApi
*/
UpdateOrganizationRolesWithParams(ctx context.Context, args *UpdateOrganizationRolesApiParams) UpdateOrganizationRolesApiRequest
@@ -575,6 +603,8 @@ Invites one MongoDB Cloud user to join the specified organization. The user must
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@return CreateOrganizationInvitationApiRequest
+
+Deprecated
*/
func (a *OrganizationsApiService) CreateOrganizationInvitation(ctx context.Context, orgId string, organizationInvitationRequest *OrganizationInvitationRequest) CreateOrganizationInvitationApiRequest {
return CreateOrganizationInvitationApiRequest{
@@ -588,6 +618,8 @@ func (a *OrganizationsApiService) CreateOrganizationInvitation(ctx context.Conte
// CreateOrganizationInvitationExecute executes the request
//
// @return OrganizationInvitation
+//
+// Deprecated
func (a *OrganizationsApiService) CreateOrganizationInvitationExecute(r CreateOrganizationInvitationApiRequest) (*OrganizationInvitation, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
@@ -812,6 +844,8 @@ Cancels one pending invitation sent to the specified MongoDB Cloud user to join
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@param invitationId Unique 24-hexadecimal digit string that identifies the invitation.
@return DeleteOrganizationInvitationApiRequest
+
+Deprecated
*/
func (a *OrganizationsApiService) DeleteOrganizationInvitation(ctx context.Context, orgId string, invitationId string) DeleteOrganizationInvitationApiRequest {
return DeleteOrganizationInvitationApiRequest{
@@ -825,6 +859,8 @@ func (a *OrganizationsApiService) DeleteOrganizationInvitation(ctx context.Conte
// DeleteOrganizationInvitationExecute executes the request
//
// @return any
+//
+// Deprecated
func (a *OrganizationsApiService) DeleteOrganizationInvitationExecute(r DeleteOrganizationInvitationApiRequest) (any, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodDelete
@@ -1040,6 +1076,8 @@ Returns the details of one pending invitation to the specified organization. To
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@param invitationId Unique 24-hexadecimal digit string that identifies the invitation.
@return GetOrganizationInvitationApiRequest
+
+Deprecated
*/
func (a *OrganizationsApiService) GetOrganizationInvitation(ctx context.Context, orgId string, invitationId string) GetOrganizationInvitationApiRequest {
return GetOrganizationInvitationApiRequest{
@@ -1053,6 +1091,8 @@ func (a *OrganizationsApiService) GetOrganizationInvitation(ctx context.Context,
// GetOrganizationInvitationExecute executes the request
//
// @return OrganizationInvitation
+//
+// Deprecated
func (a *OrganizationsApiService) GetOrganizationInvitationExecute(r GetOrganizationInvitationApiRequest) (*OrganizationInvitation, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
@@ -1273,6 +1313,8 @@ Returns all pending invitations to the specified organization. To use this resou
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@return ListOrganizationInvitationsApiRequest
+
+Deprecated
*/
func (a *OrganizationsApiService) ListOrganizationInvitations(ctx context.Context, orgId string) ListOrganizationInvitationsApiRequest {
return ListOrganizationInvitationsApiRequest{
@@ -1285,6 +1327,8 @@ func (a *OrganizationsApiService) ListOrganizationInvitations(ctx context.Contex
// ListOrganizationInvitationsExecute executes the request
//
// @return []OrganizationInvitation
+//
+// Deprecated
func (a *OrganizationsApiService) ListOrganizationInvitationsExecute(r ListOrganizationInvitationsApiRequest) ([]OrganizationInvitation, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
@@ -1580,14 +1624,14 @@ func (r ListOrganizationUsersApiRequest) PageNum(pageNum int) ListOrganizationUs
return r
}
-func (r ListOrganizationUsersApiRequest) Execute() (*PaginatedAppUser, *http.Response, error) {
+func (r ListOrganizationUsersApiRequest) Execute() (*PaginatedOrgUser, *http.Response, error) {
return r.ApiService.ListOrganizationUsersExecute(r)
}
/*
ListOrganizationUsers Return All MongoDB Cloud Users in One Organization
-Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role.
+Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role. Deprecated versions: v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@@ -1603,13 +1647,13 @@ func (a *OrganizationsApiService) ListOrganizationUsers(ctx context.Context, org
// ListOrganizationUsersExecute executes the request
//
-// @return PaginatedAppUser
-func (a *OrganizationsApiService) ListOrganizationUsersExecute(r ListOrganizationUsersApiRequest) (*PaginatedAppUser, *http.Response, error) {
+// @return PaginatedOrgUser
+func (a *OrganizationsApiService) ListOrganizationUsersExecute(r ListOrganizationUsersApiRequest) (*PaginatedOrgUser, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody any
formFiles []formFile
- localVarReturnValue *PaginatedAppUser
+ localVarReturnValue *PaginatedOrgUser
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "OrganizationsApiService.ListOrganizationUsers")
@@ -1655,7 +1699,7 @@ func (a *OrganizationsApiService) ListOrganizationUsersExecute(r ListOrganizatio
}
// to determine the Accept header (only first one)
- localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2023-01-01+json"}
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
@@ -1887,7 +1931,7 @@ func (r RemoveOrganizationUserApiRequest) Execute() (any, *http.Response, error)
/*
RemoveOrganizationUser Remove One MongoDB Cloud User From One Organization
-Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role.
+Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. Deprecated versions: v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@@ -1937,7 +1981,7 @@ func (a *OrganizationsApiService) RemoveOrganizationUserExecute(r RemoveOrganiza
}
// to determine the Accept header (only first one)
- localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2023-01-01+json"}
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
@@ -2129,6 +2173,8 @@ Updates the details of one pending invitation to the specified organization. To
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@return UpdateOrganizationInvitationApiRequest
+
+Deprecated
*/
func (a *OrganizationsApiService) UpdateOrganizationInvitation(ctx context.Context, orgId string, organizationInvitationRequest *OrganizationInvitationRequest) UpdateOrganizationInvitationApiRequest {
return UpdateOrganizationInvitationApiRequest{
@@ -2142,6 +2188,8 @@ func (a *OrganizationsApiService) UpdateOrganizationInvitation(ctx context.Conte
// UpdateOrganizationInvitationExecute executes the request
//
// @return OrganizationInvitation
+//
+// Deprecated
func (a *OrganizationsApiService) UpdateOrganizationInvitationExecute(r UpdateOrganizationInvitationApiRequest) (*OrganizationInvitation, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPatch
@@ -2253,6 +2301,8 @@ Updates the details of one pending invitation to the specified organization. To
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@param invitationId Unique 24-hexadecimal digit string that identifies the invitation.
@return UpdateOrganizationInvitationByIdApiRequest
+
+Deprecated
*/
func (a *OrganizationsApiService) UpdateOrganizationInvitationById(ctx context.Context, orgId string, invitationId string, organizationInvitationUpdateRequest *OrganizationInvitationUpdateRequest) UpdateOrganizationInvitationByIdApiRequest {
return UpdateOrganizationInvitationByIdApiRequest{
@@ -2267,6 +2317,8 @@ func (a *OrganizationsApiService) UpdateOrganizationInvitationById(ctx context.C
// UpdateOrganizationInvitationByIdExecute executes the request
//
// @return OrganizationInvitation
+//
+// Deprecated
func (a *OrganizationsApiService) UpdateOrganizationInvitationByIdExecute(r UpdateOrganizationInvitationByIdApiRequest) (*OrganizationInvitation, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPatch
@@ -2379,6 +2431,8 @@ Updates the roles of the specified user in the specified organization. To specif
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@param userId Unique 24-hexadecimal digit string that identifies the user to modify.
@return UpdateOrganizationRolesApiRequest
+
+Deprecated
*/
func (a *OrganizationsApiService) UpdateOrganizationRoles(ctx context.Context, orgId string, userId string, updateOrgRolesForUser *UpdateOrgRolesForUser) UpdateOrganizationRolesApiRequest {
return UpdateOrganizationRolesApiRequest{
@@ -2393,6 +2447,8 @@ func (a *OrganizationsApiService) UpdateOrganizationRoles(ctx context.Context, o
// UpdateOrganizationRolesExecute executes the request
//
// @return UpdateOrgRolesForUser
+//
+// Deprecated
func (a *OrganizationsApiService) UpdateOrganizationRolesExecute(r UpdateOrganizationRolesApiRequest) (*UpdateOrgRolesForUser, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPut
diff --git a/admin/api_performance_advisor.go b/admin/api_performance_advisor.go
index d60199fd7..0463a4c22 100644
--- a/admin/api_performance_advisor.go
+++ b/admin/api_performance_advisor.go
@@ -80,12 +80,12 @@ type PerformanceAdvisorApi interface {
GetManagedSlowMsWithParams(ctx context.Context, args *GetManagedSlowMsApiParams) GetManagedSlowMsApiRequest
// Method available only for mocking purposes
- GetManagedSlowMsExecute(r GetManagedSlowMsApiRequest) (*http.Response, error)
+ GetManagedSlowMsExecute(r GetManagedSlowMsApiRequest) (bool, *http.Response, error)
/*
GetServerlessAutoIndexing Return Serverless Auto Indexing Enabled
- Get whether the Serverless Auto Indexing feature is enabled.
+ Get whether the Serverless Auto Indexing feature is enabled. This endpoint returns a value for Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -130,10 +130,58 @@ type PerformanceAdvisorApi interface {
// Method available only for mocking purposes
ListClusterSuggestedIndexesExecute(r ListClusterSuggestedIndexesApiRequest) (*PerformanceAdvisorResponse, *http.Response, error)
+ /*
+ ListDropIndexes Returns Suggested Indexes to Drop
+
+ Returns the indexes that the Performance Advisor suggests to drop. The Performance Advisor suggests dropping unused, redundant, and hidden indexes to improve write performance and increase storage space. To use this resource, the requesting API Key must have the Project Read Only role.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param clusterName Human-readable label that identifies the cluster.
+ @return ListDropIndexesApiRequest
+ */
+ ListDropIndexes(ctx context.Context, groupId string, clusterName string) ListDropIndexesApiRequest
+ /*
+ ListDropIndexes Returns Suggested Indexes to Drop
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param ListDropIndexesApiParams - Parameters for the request
+ @return ListDropIndexesApiRequest
+ */
+ ListDropIndexesWithParams(ctx context.Context, args *ListDropIndexesApiParams) ListDropIndexesApiRequest
+
+ // Method available only for mocking purposes
+ ListDropIndexesExecute(r ListDropIndexesApiRequest) (*DropIndexSuggestionsResponse, *http.Response, error)
+
+ /*
+ ListSchemaAdvice Return Schema Advice
+
+ Returns the schema suggestions that the Performance Advisor detects. The Performance Advisor provides holistic schema recommendations for your cluster by sampling documents in your most active collections and collections with slow-running queries. To use this resource, the requesting API Key must have the Project Read Only role.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param clusterName Human-readable label that identifies the cluster.
+ @return ListSchemaAdviceApiRequest
+ */
+ ListSchemaAdvice(ctx context.Context, groupId string, clusterName string) ListSchemaAdviceApiRequest
+ /*
+ ListSchemaAdvice Return Schema Advice
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param ListSchemaAdviceApiParams - Parameters for the request
+ @return ListSchemaAdviceApiRequest
+ */
+ ListSchemaAdviceWithParams(ctx context.Context, args *ListSchemaAdviceApiParams) ListSchemaAdviceApiRequest
+
+ // Method available only for mocking purposes
+ ListSchemaAdviceExecute(r ListSchemaAdviceApiRequest) (*SchemaAdvisorResponse, *http.Response, error)
+
/*
ListSlowQueries Return Slow Queries
- Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role.
+ Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have any Project Data Access role or the Project Observability Viewer role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -205,7 +253,7 @@ type PerformanceAdvisorApi interface {
/*
SetServerlessAutoIndexing Set Serverless Auto Indexing
- Set whether the Serverless Auto Indexing feature is enabled.
+ Set whether the Serverless Auto Indexing feature is enabled. This endpoint sets a value for Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -436,7 +484,7 @@ func (a *PerformanceAdvisorApiService) GetManagedSlowMsWithParams(ctx context.Co
}
}
-func (r GetManagedSlowMsApiRequest) Execute() (*http.Response, error) {
+func (r GetManagedSlowMsApiRequest) Execute() (bool, *http.Response, error) {
return r.ApiService.GetManagedSlowMsExecute(r)
}
@@ -458,16 +506,19 @@ func (a *PerformanceAdvisorApiService) GetManagedSlowMs(ctx context.Context, gro
}
// GetManagedSlowMsExecute executes the request
-func (a *PerformanceAdvisorApiService) GetManagedSlowMsExecute(r GetManagedSlowMsApiRequest) (*http.Response, error) {
+//
+// @return bool
+func (a *PerformanceAdvisorApiService) GetManagedSlowMsExecute(r GetManagedSlowMsApiRequest) (bool, *http.Response, error) {
var (
- localVarHTTPMethod = http.MethodGet
- localVarPostBody any
- formFiles []formFile
+ localVarHTTPMethod = http.MethodGet
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue bool
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "PerformanceAdvisorApiService.GetManagedSlowMs")
if err != nil {
- return nil, &GenericOpenAPIError{error: err.Error()}
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/atlas/v2/groups/{groupId}/managedSlowMs"
@@ -496,20 +547,34 @@ func (a *PerformanceAdvisorApiService) GetManagedSlowMsExecute(r GetManagedSlowM
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
- return nil, err
+ return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
- return localVarHTTPResponse, err
+ return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
- return localVarHTTPResponse, newErr
+ return localVarReturnValue, localVarHTTPResponse, newErr
}
- return localVarHTTPResponse, nil
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
}
type GetServerlessAutoIndexingApiRequest struct {
@@ -540,7 +605,7 @@ func (r GetServerlessAutoIndexingApiRequest) Execute() (bool, *http.Response, er
/*
GetServerlessAutoIndexing Return Serverless Auto Indexing Enabled
-Get whether the Serverless Auto Indexing feature is enabled.
+Get whether the Serverless Auto Indexing feature is enabled. This endpoint returns a value for Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -802,6 +867,240 @@ func (a *PerformanceAdvisorApiService) ListClusterSuggestedIndexesExecute(r List
return localVarReturnValue, localVarHTTPResponse, nil
}
+type ListDropIndexesApiRequest struct {
+ ctx context.Context
+ ApiService PerformanceAdvisorApi
+ groupId string
+ clusterName string
+}
+
+type ListDropIndexesApiParams struct {
+ GroupId string
+ ClusterName string
+}
+
+func (a *PerformanceAdvisorApiService) ListDropIndexesWithParams(ctx context.Context, args *ListDropIndexesApiParams) ListDropIndexesApiRequest {
+ return ListDropIndexesApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ groupId: args.GroupId,
+ clusterName: args.ClusterName,
+ }
+}
+
+func (r ListDropIndexesApiRequest) Execute() (*DropIndexSuggestionsResponse, *http.Response, error) {
+ return r.ApiService.ListDropIndexesExecute(r)
+}
+
+/*
+ListDropIndexes Returns Suggested Indexes to Drop
+
+Returns the indexes that the Performance Advisor suggests to drop. The Performance Advisor suggests dropping unused, redundant, and hidden indexes to improve write performance and increase storage space. To use this resource, the requesting API Key must have the Project Read Only role.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param clusterName Human-readable label that identifies the cluster.
+ @return ListDropIndexesApiRequest
+*/
+func (a *PerformanceAdvisorApiService) ListDropIndexes(ctx context.Context, groupId string, clusterName string) ListDropIndexesApiRequest {
+ return ListDropIndexesApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ groupId: groupId,
+ clusterName: clusterName,
+ }
+}
+
+// ListDropIndexesExecute executes the request
+//
+// @return DropIndexSuggestionsResponse
+func (a *PerformanceAdvisorApiService) ListDropIndexesExecute(r ListDropIndexesApiRequest) (*DropIndexSuggestionsResponse, *http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodGet
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue *DropIndexSuggestionsResponse
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "PerformanceAdvisorApiService.ListDropIndexes")
+ if err != nil {
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions"
+ localVarPath = strings.Replace(localVarPath, "{"+"groupId"+"}", url.PathEscape(r.groupId), -1)
+ localVarPath = strings.Replace(localVarPath, "{"+"clusterName"+"}", url.PathEscape(r.clusterName), -1)
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header (only first one)
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2024-08-05+json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
+
+type ListSchemaAdviceApiRequest struct {
+ ctx context.Context
+ ApiService PerformanceAdvisorApi
+ groupId string
+ clusterName string
+}
+
+type ListSchemaAdviceApiParams struct {
+ GroupId string
+ ClusterName string
+}
+
+func (a *PerformanceAdvisorApiService) ListSchemaAdviceWithParams(ctx context.Context, args *ListSchemaAdviceApiParams) ListSchemaAdviceApiRequest {
+ return ListSchemaAdviceApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ groupId: args.GroupId,
+ clusterName: args.ClusterName,
+ }
+}
+
+func (r ListSchemaAdviceApiRequest) Execute() (*SchemaAdvisorResponse, *http.Response, error) {
+ return r.ApiService.ListSchemaAdviceExecute(r)
+}
+
+/*
+ListSchemaAdvice Return Schema Advice
+
+Returns the schema suggestions that the Performance Advisor detects. The Performance Advisor provides holistic schema recommendations for your cluster by sampling documents in your most active collections and collections with slow-running queries. To use this resource, the requesting API Key must have the Project Read Only role.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param clusterName Human-readable label that identifies the cluster.
+ @return ListSchemaAdviceApiRequest
+*/
+func (a *PerformanceAdvisorApiService) ListSchemaAdvice(ctx context.Context, groupId string, clusterName string) ListSchemaAdviceApiRequest {
+ return ListSchemaAdviceApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ groupId: groupId,
+ clusterName: clusterName,
+ }
+}
+
+// ListSchemaAdviceExecute executes the request
+//
+// @return SchemaAdvisorResponse
+func (a *PerformanceAdvisorApiService) ListSchemaAdviceExecute(r ListSchemaAdviceApiRequest) (*SchemaAdvisorResponse, *http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodGet
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue *SchemaAdvisorResponse
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "PerformanceAdvisorApiService.ListSchemaAdvice")
+ if err != nil {
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice"
+ localVarPath = strings.Replace(localVarPath, "{"+"groupId"+"}", url.PathEscape(r.groupId), -1)
+ localVarPath = strings.Replace(localVarPath, "{"+"clusterName"+"}", url.PathEscape(r.clusterName), -1)
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header (only first one)
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2024-08-05+json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
+
type ListSlowQueriesApiRequest struct {
ctx context.Context
ApiService PerformanceAdvisorApi
@@ -866,7 +1165,7 @@ func (r ListSlowQueriesApiRequest) Execute() (*PerformanceAdvisorSlowQueryList,
/*
ListSlowQueries Return Slow Queries
-Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role.
+Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have any Project Data Access role or the Project Observability Viewer role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -1386,7 +1685,7 @@ func (r SetServerlessAutoIndexingApiRequest) Execute() (any, *http.Response, err
/*
SetServerlessAutoIndexing Set Serverless Auto Indexing
-Set whether the Serverless Auto Indexing feature is enabled.
+Set whether the Serverless Auto Indexing feature is enabled. This endpoint sets a value for Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
diff --git a/admin/api_projects.go b/admin/api_projects.go
index b7b75a7f0..ac9d243d2 100644
--- a/admin/api_projects.go
+++ b/admin/api_projects.go
@@ -21,6 +21,8 @@ type ProjectsApi interface {
@param groupId 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. **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.
@param groupInvitationRequest Adds one MongoDB Cloud user to the specified project.
@return AddUserToProjectApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for ProjectsApi
*/
AddUserToProject(ctx context.Context, groupId string, groupInvitationRequest *GroupInvitationRequest) AddUserToProjectApiRequest
/*
@@ -30,6 +32,8 @@ type ProjectsApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param AddUserToProjectApiParams - Parameters for the request
@return AddUserToProjectApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for ProjectsApi
*/
AddUserToProjectWithParams(ctx context.Context, args *AddUserToProjectApiParams) AddUserToProjectApiRequest
@@ -359,13 +363,11 @@ type ProjectsApi interface {
/*
ListProjectUsers Return All Users in One Project
- Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role.
+ Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@return ListProjectUsersApiRequest
-
- Deprecated: this method has been deprecated. Please check the latest resource version for ProjectsApi
*/
ListProjectUsers(ctx context.Context, groupId string) ListProjectUsersApiRequest
/*
@@ -375,13 +377,11 @@ type ProjectsApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ListProjectUsersApiParams - Parameters for the request
@return ListProjectUsersApiRequest
-
- Deprecated: this method has been deprecated. Please check the latest resource version for ProjectsApi
*/
ListProjectUsersWithParams(ctx context.Context, args *ListProjectUsersApiParams) ListProjectUsersApiRequest
// Method available only for mocking purposes
- ListProjectUsersExecute(r ListProjectUsersApiRequest) (*PaginatedAppUser, *http.Response, error)
+ ListProjectUsersExecute(r ListProjectUsersApiRequest) (*PaginatedGroupUser, *http.Response, error)
/*
ListProjects Return All Projects
@@ -432,7 +432,7 @@ type ProjectsApi interface {
/*
RemoveProjectUser Remove One User from One Project
- Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+ Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -451,7 +451,7 @@ type ProjectsApi interface {
RemoveProjectUserWithParams(ctx context.Context, args *RemoveProjectUserApiParams) RemoveProjectUserApiRequest
// Method available only for mocking purposes
- RemoveProjectUserExecute(r RemoveProjectUserApiRequest) (*http.Response, error)
+ RemoveProjectUserExecute(r RemoveProjectUserApiRequest) (any, *http.Response, error)
/*
ReturnAllIpAddresses Return All IP Addresses for One Project
@@ -594,6 +594,8 @@ type ProjectsApi interface {
@param userId Unique 24-hexadecimal digit string that identifies the user to modify.
@param updateGroupRolesForUser Roles to update for the specified user.
@return UpdateProjectRolesApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for ProjectsApi
*/
UpdateProjectRoles(ctx context.Context, groupId string, userId string, updateGroupRolesForUser *UpdateGroupRolesForUser) UpdateProjectRolesApiRequest
/*
@@ -603,6 +605,8 @@ type ProjectsApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param UpdateProjectRolesApiParams - Parameters for the request
@return UpdateProjectRolesApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for ProjectsApi
*/
UpdateProjectRolesWithParams(ctx context.Context, args *UpdateProjectRolesApiParams) UpdateProjectRolesApiRequest
@@ -670,6 +674,8 @@ Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@return AddUserToProjectApiRequest
+
+Deprecated
*/
func (a *ProjectsApiService) AddUserToProject(ctx context.Context, groupId string, groupInvitationRequest *GroupInvitationRequest) AddUserToProjectApiRequest {
return AddUserToProjectApiRequest{
@@ -683,6 +689,8 @@ func (a *ProjectsApiService) AddUserToProject(ctx context.Context, groupId strin
// AddUserToProjectExecute executes the request
//
// @return OrganizationInvitation
+//
+// Deprecated
func (a *ProjectsApiService) AddUserToProjectExecute(r AddUserToProjectApiRequest) (*OrganizationInvitation, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
@@ -2345,38 +2353,35 @@ func (a *ProjectsApiService) ListProjectLimitsExecute(r ListProjectLimitsApiRequ
}
type ListProjectUsersApiRequest struct {
- ctx context.Context
- ApiService ProjectsApi
- groupId string
- includeCount *bool
- itemsPerPage *int
- pageNum *int
- flattenTeams *bool
- includeOrgUsers *bool
- orgMembershipStatus *string
+ ctx context.Context
+ ApiService ProjectsApi
+ groupId string
+ includeCount *bool
+ itemsPerPage *int
+ pageNum *int
+ flattenTeams *bool
+ includeOrgUsers *bool
}
type ListProjectUsersApiParams struct {
- GroupId string
- IncludeCount *bool
- ItemsPerPage *int
- PageNum *int
- FlattenTeams *bool
- IncludeOrgUsers *bool
- OrgMembershipStatus *string
+ GroupId string
+ IncludeCount *bool
+ ItemsPerPage *int
+ PageNum *int
+ FlattenTeams *bool
+ IncludeOrgUsers *bool
}
func (a *ProjectsApiService) ListProjectUsersWithParams(ctx context.Context, args *ListProjectUsersApiParams) ListProjectUsersApiRequest {
return ListProjectUsersApiRequest{
- ApiService: a,
- ctx: ctx,
- groupId: args.GroupId,
- includeCount: args.IncludeCount,
- itemsPerPage: args.ItemsPerPage,
- pageNum: args.PageNum,
- flattenTeams: args.FlattenTeams,
- includeOrgUsers: args.IncludeOrgUsers,
- orgMembershipStatus: args.OrgMembershipStatus,
+ ApiService: a,
+ ctx: ctx,
+ groupId: args.GroupId,
+ includeCount: args.IncludeCount,
+ itemsPerPage: args.ItemsPerPage,
+ pageNum: args.PageNum,
+ flattenTeams: args.FlattenTeams,
+ includeOrgUsers: args.IncludeOrgUsers,
}
}
@@ -2410,26 +2415,18 @@ func (r ListProjectUsersApiRequest) IncludeOrgUsers(includeOrgUsers bool) ListPr
return r
}
-// Flag that indicates whether to filter the returned list by users organization membership status. If you exclude this parameter, this resource returns both pending and active users.
-func (r ListProjectUsersApiRequest) OrgMembershipStatus(orgMembershipStatus string) ListProjectUsersApiRequest {
- r.orgMembershipStatus = &orgMembershipStatus
- return r
-}
-
-func (r ListProjectUsersApiRequest) Execute() (*PaginatedAppUser, *http.Response, error) {
+func (r ListProjectUsersApiRequest) Execute() (*PaginatedGroupUser, *http.Response, error) {
return r.ApiService.ListProjectUsersExecute(r)
}
/*
ListProjectUsers Return All Users in One Project
-Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role.
+Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@return ListProjectUsersApiRequest
-
-Deprecated
*/
func (a *ProjectsApiService) ListProjectUsers(ctx context.Context, groupId string) ListProjectUsersApiRequest {
return ListProjectUsersApiRequest{
@@ -2441,15 +2438,13 @@ func (a *ProjectsApiService) ListProjectUsers(ctx context.Context, groupId strin
// ListProjectUsersExecute executes the request
//
-// @return PaginatedAppUser
-//
-// Deprecated
-func (a *ProjectsApiService) ListProjectUsersExecute(r ListProjectUsersApiRequest) (*PaginatedAppUser, *http.Response, error) {
+// @return PaginatedGroupUser
+func (a *ProjectsApiService) ListProjectUsersExecute(r ListProjectUsersApiRequest) (*PaginatedGroupUser, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody any
formFiles []formFile
- localVarReturnValue *PaginatedAppUser
+ localVarReturnValue *PaginatedGroupUser
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "ProjectsApiService.ListProjectUsers")
@@ -2499,9 +2494,6 @@ func (a *ProjectsApiService) ListProjectUsersExecute(r ListProjectUsersApiReques
r.includeOrgUsers = &defaultValue
parameterAddToHeaderOrQuery(localVarQueryParams, "includeOrgUsers", r.includeOrgUsers, "")
}
- if r.orgMembershipStatus != nil {
- parameterAddToHeaderOrQuery(localVarQueryParams, "orgMembershipStatus", r.orgMembershipStatus, "")
- }
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
@@ -2512,7 +2504,7 @@ func (a *ProjectsApiService) ListProjectUsersExecute(r ListProjectUsersApiReques
}
// to determine the Accept header (only first one)
- localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2023-01-01+json"}
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
@@ -2845,14 +2837,14 @@ func (a *ProjectsApiService) RemoveProjectUserWithParams(ctx context.Context, ar
}
}
-func (r RemoveProjectUserApiRequest) Execute() (*http.Response, error) {
+func (r RemoveProjectUserApiRequest) Execute() (any, *http.Response, error) {
return r.ApiService.RemoveProjectUserExecute(r)
}
/*
RemoveProjectUser Remove One User from One Project
-Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@@ -2869,16 +2861,19 @@ func (a *ProjectsApiService) RemoveProjectUser(ctx context.Context, groupId stri
}
// RemoveProjectUserExecute executes the request
-func (a *ProjectsApiService) RemoveProjectUserExecute(r RemoveProjectUserApiRequest) (*http.Response, error) {
+//
+// @return any
+func (a *ProjectsApiService) RemoveProjectUserExecute(r RemoveProjectUserApiRequest) (any, *http.Response, error) {
var (
- localVarHTTPMethod = http.MethodDelete
- localVarPostBody any
- formFiles []formFile
+ localVarHTTPMethod = http.MethodDelete
+ localVarPostBody any
+ formFiles []formFile
+ localVarReturnValue any
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "ProjectsApiService.RemoveProjectUser")
if err != nil {
- return nil, &GenericOpenAPIError{error: err.Error()}
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/atlas/v2/groups/{groupId}/users/{userId}"
@@ -2899,7 +2894,7 @@ func (a *ProjectsApiService) RemoveProjectUserExecute(r RemoveProjectUserApiRequ
}
// to determine the Accept header (only first one)
- localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2023-01-01+json"}
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
@@ -2908,20 +2903,34 @@ func (a *ProjectsApiService) RemoveProjectUserExecute(r RemoveProjectUserApiRequ
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
- return nil, err
+ return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
- return localVarHTTPResponse, err
+ return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
- return localVarHTTPResponse, newErr
+ return localVarReturnValue, localVarHTTPResponse, newErr
}
- return localVarHTTPResponse, nil
+ err = a.client.decode(&localVarReturnValue, localVarHTTPResponse.Body, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ defer localVarHTTPResponse.Body.Close()
+ buf, readErr := io.ReadAll(localVarHTTPResponse.Body)
+ if readErr != nil {
+ err = readErr
+ }
+ newErr := &GenericOpenAPIError{
+ body: buf,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
}
type ReturnAllIpAddressesApiRequest struct {
@@ -3574,6 +3583,8 @@ Updates the roles of the specified user in the specified project. To specify the
@param groupId 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. **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.
@param userId Unique 24-hexadecimal digit string that identifies the user to modify.
@return UpdateProjectRolesApiRequest
+
+Deprecated
*/
func (a *ProjectsApiService) UpdateProjectRoles(ctx context.Context, groupId string, userId string, updateGroupRolesForUser *UpdateGroupRolesForUser) UpdateProjectRolesApiRequest {
return UpdateProjectRolesApiRequest{
@@ -3588,6 +3599,8 @@ func (a *ProjectsApiService) UpdateProjectRoles(ctx context.Context, groupId str
// UpdateProjectRolesExecute executes the request
//
// @return UpdateGroupRolesForUser
+//
+// Deprecated
func (a *ProjectsApiService) UpdateProjectRolesExecute(r UpdateProjectRolesApiRequest) (*UpdateGroupRolesForUser, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPut
diff --git a/admin/api_serverless_instances.go b/admin/api_serverless_instances.go
index 1f8e4f66a..571a63bbf 100644
--- a/admin/api_serverless_instances.go
+++ b/admin/api_serverless_instances.go
@@ -13,14 +13,16 @@ import (
type ServerlessInstancesApi interface {
/*
- CreateServerlessInstance Create One Serverless Instance in One Project
+ CreateServerlessInstance Create One Serverless Instance in One Project
+
+ Update as of Feb 2025: This endpoint now creates a Flex cluster instead. This endpoint will no longer be supported starting January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect. Please use the createFlexCluster endpoint instead.
Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param serverlessInstanceDescriptionCreate Create One Serverless Instance in One Project.
- @return CreateServerlessInstanceApiRequest
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param serverlessInstanceDescriptionCreate Create One Serverless Instance in One Project.
+ @return CreateServerlessInstanceApiRequest
*/
CreateServerlessInstance(ctx context.Context, groupId string, serverlessInstanceDescriptionCreate *ServerlessInstanceDescriptionCreate) CreateServerlessInstanceApiRequest
/*
@@ -37,14 +39,16 @@ type ServerlessInstancesApi interface {
CreateServerlessInstanceExecute(r CreateServerlessInstanceApiRequest) (*ServerlessInstanceDescription, *http.Response, error)
/*
- DeleteServerlessInstance Remove One Serverless Instance from One Project
+ DeleteServerlessInstance Remove One Serverless Instance from One Project
- Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role.
+ Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param name Human-readable label that identifies the serverless instance.
- @return DeleteServerlessInstanceApiRequest
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the deleteFlexCluster endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param name Human-readable label that identifies the serverless instance.
+ @return DeleteServerlessInstanceApiRequest
*/
DeleteServerlessInstance(ctx context.Context, groupId string, name string) DeleteServerlessInstanceApiRequest
/*
@@ -61,14 +65,16 @@ type ServerlessInstancesApi interface {
DeleteServerlessInstanceExecute(r DeleteServerlessInstanceApiRequest) (any, *http.Response, error)
/*
- GetServerlessInstance Return One Serverless Instance from One Project
+ GetServerlessInstance Return One Serverless Instance from One Project
- Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+ Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param name Human-readable label that identifies the serverless instance.
- @return GetServerlessInstanceApiRequest
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. This endpoint will be sunset in January 2026. Please use the getFlexCluster endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param name Human-readable label that identifies the serverless instance.
+ @return GetServerlessInstanceApiRequest
*/
GetServerlessInstance(ctx context.Context, groupId string, name string) GetServerlessInstanceApiRequest
/*
@@ -85,13 +91,15 @@ type ServerlessInstancesApi interface {
GetServerlessInstanceExecute(r GetServerlessInstanceApiRequest) (*ServerlessInstanceDescription, *http.Response, error)
/*
- ListServerlessInstances Return All Serverless Instances from One Project
+ ListServerlessInstances Return All Serverless Instances from One Project
- Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+ Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @return ListServerlessInstancesApiRequest
+ This endpoint also lists Flex clusters that were created using the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or former Serverless instances that have been migrated to Flex clusters, until January 2026 after which this endpoint will be sunset. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the listFlexClusters endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @return ListServerlessInstancesApiRequest
*/
ListServerlessInstances(ctx context.Context, groupId string) ListServerlessInstancesApiRequest
/*
@@ -108,15 +116,17 @@ type ServerlessInstancesApi interface {
ListServerlessInstancesExecute(r ListServerlessInstancesApiRequest) (*PaginatedServerlessInstanceDescription, *http.Response, error)
/*
- UpdateServerlessInstance Update One Serverless Instance in One Project
+ UpdateServerlessInstance Update One Serverless Instance in One Project
- Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+ Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param name Human-readable label that identifies the serverless instance.
- @param serverlessInstanceDescriptionUpdate Update One Serverless Instance in One Project.
- @return UpdateServerlessInstanceApiRequest
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the updateFlexCluster endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param name Human-readable label that identifies the serverless instance.
+ @param serverlessInstanceDescriptionUpdate Update One Serverless Instance in One Project.
+ @return UpdateServerlessInstanceApiRequest
*/
UpdateServerlessInstance(ctx context.Context, groupId string, name string, serverlessInstanceDescriptionUpdate *ServerlessInstanceDescriptionUpdate) UpdateServerlessInstanceApiRequest
/*
@@ -164,6 +174,8 @@ func (r CreateServerlessInstanceApiRequest) Execute() (*ServerlessInstanceDescri
/*
CreateServerlessInstance Create One Serverless Instance in One Project
+Update as of Feb 2025: This endpoint now creates a Flex cluster instead. This endpoint will no longer be supported starting January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect. Please use the createFlexCluster endpoint instead.
+
Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@@ -286,6 +298,8 @@ DeleteServerlessInstance Remove One Serverless Instance from One Project
Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role.
+This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the deleteFlexCluster endpoint instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param name Human-readable label that identifies the serverless instance.
@@ -403,6 +417,8 @@ GetServerlessInstance Return One Serverless Instance from One Project
Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. This endpoint will be sunset in January 2026. Please use the getFlexCluster endpoint instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param name Human-readable label that identifies the serverless instance.
@@ -544,6 +560,8 @@ ListServerlessInstances Return All Serverless Instances from One Project
Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+This endpoint also lists Flex clusters that were created using the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or former Serverless instances that have been migrated to Flex clusters, until January 2026 after which this endpoint will be sunset. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the listFlexClusters endpoint instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@return ListServerlessInstancesApiRequest
@@ -682,6 +700,8 @@ UpdateServerlessInstance Update One Serverless Instance in One Project
Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the updateFlexCluster endpoint instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param name Human-readable label that identifies the serverless instance.
diff --git a/admin/api_serverless_private_endpoints.go b/admin/api_serverless_private_endpoints.go
index caeaa585b..df52414ba 100644
--- a/admin/api_serverless_private_endpoints.go
+++ b/admin/api_serverless_private_endpoints.go
@@ -19,6 +19,8 @@ type ServerlessPrivateEndpointsApi interface {
A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.
+ This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param instanceName Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.
@@ -40,15 +42,17 @@ type ServerlessPrivateEndpointsApi interface {
CreateServerlessPrivateEndpointExecute(r CreateServerlessPrivateEndpointApiRequest) (*ServerlessTenantEndpoint, *http.Response, error)
/*
- DeleteServerlessPrivateEndpoint Remove One Private Endpoint for One Serverless Instance
+ DeleteServerlessPrivateEndpoint Remove One Private Endpoint for One Serverless Instance
- Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.
+ Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param instanceName Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.
- @param endpointId Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.
- @return DeleteServerlessPrivateEndpointApiRequest
+ This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param instanceName Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.
+ @param endpointId Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.
+ @return DeleteServerlessPrivateEndpointApiRequest
*/
DeleteServerlessPrivateEndpoint(ctx context.Context, groupId string, instanceName string, endpointId string) DeleteServerlessPrivateEndpointApiRequest
/*
@@ -65,15 +69,17 @@ type ServerlessPrivateEndpointsApi interface {
DeleteServerlessPrivateEndpointExecute(r DeleteServerlessPrivateEndpointApiRequest) (any, *http.Response, error)
/*
- GetServerlessPrivateEndpoint Return One Private Endpoint for One Serverless Instance
+ GetServerlessPrivateEndpoint Return One Private Endpoint for One Serverless Instance
- Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource.
+ Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param instanceName Human-readable label that identifies the serverless instance associated with the tenant endpoint.
- @param endpointId Unique 24-hexadecimal digit string that identifies the tenant endpoint.
- @return GetServerlessPrivateEndpointApiRequest
+ This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param instanceName Human-readable label that identifies the serverless instance associated with the tenant endpoint.
+ @param endpointId Unique 24-hexadecimal digit string that identifies the tenant endpoint.
+ @return GetServerlessPrivateEndpointApiRequest
*/
GetServerlessPrivateEndpoint(ctx context.Context, groupId string, instanceName string, endpointId string) GetServerlessPrivateEndpointApiRequest
/*
@@ -90,14 +96,16 @@ type ServerlessPrivateEndpointsApi interface {
GetServerlessPrivateEndpointExecute(r GetServerlessPrivateEndpointApiRequest) (*ServerlessTenantEndpoint, *http.Response, error)
/*
- ListServerlessPrivateEndpoints Return All Private Endpoints for One Serverless Instance
+ ListServerlessPrivateEndpoints Return All Private Endpoints for One Serverless Instance
- Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource.
+ Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param instanceName Human-readable label that identifies the serverless instance associated with the tenant endpoint.
- @return ListServerlessPrivateEndpointsApiRequest
+ This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param instanceName Human-readable label that identifies the serverless instance associated with the tenant endpoint.
+ @return ListServerlessPrivateEndpointsApiRequest
*/
ListServerlessPrivateEndpoints(ctx context.Context, groupId string, instanceName string) ListServerlessPrivateEndpointsApiRequest
/*
@@ -114,16 +122,18 @@ type ServerlessPrivateEndpointsApi interface {
ListServerlessPrivateEndpointsExecute(r ListServerlessPrivateEndpointsApiRequest) ([]ServerlessTenantEndpoint, *http.Response, error)
/*
- UpdateServerlessPrivateEndpoint Update One Private Endpoint for One Serverless Instance
+ UpdateServerlessPrivateEndpoint Update One Private Endpoint for One Serverless Instance
- Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.
+ Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param instanceName Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.
- @param endpointId Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.
- @param serverlessTenantEndpointUpdate Object used for update.
- @return UpdateServerlessPrivateEndpointApiRequest
+ This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param instanceName Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.
+ @param endpointId Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.
+ @param serverlessTenantEndpointUpdate Object used for update.
+ @return UpdateServerlessPrivateEndpointApiRequest
*/
UpdateServerlessPrivateEndpoint(ctx context.Context, groupId string, instanceName string, endpointId string, serverlessTenantEndpointUpdate *ServerlessTenantEndpointUpdate) UpdateServerlessPrivateEndpointApiRequest
/*
@@ -178,6 +188,8 @@ Creates one private endpoint for one serverless instance. To use this resource,
A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.
+This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param instanceName Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.
@@ -304,6 +316,8 @@ DeleteServerlessPrivateEndpoint Remove One Private Endpoint for One Serverless I
Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.
+This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param instanceName Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.
@@ -427,6 +441,8 @@ GetServerlessPrivateEndpoint Return One Private Endpoint for One Serverless Inst
Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource.
+This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param instanceName Human-readable label that identifies the serverless instance associated with the tenant endpoint.
@@ -547,6 +563,8 @@ ListServerlessPrivateEndpoints Return All Private Endpoints for One Serverless I
Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource.
+This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param instanceName Human-readable label that identifies the serverless instance associated with the tenant endpoint.
@@ -670,6 +688,8 @@ UpdateServerlessPrivateEndpoint Update One Private Endpoint for One Serverless I
Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.
+This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param instanceName Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.
diff --git a/admin/api_shared_tier_restore_jobs.go b/admin/api_shared_tier_restore_jobs.go
index 66b92e582..68104dad8 100644
--- a/admin/api_shared_tier_restore_jobs.go
+++ b/admin/api_shared_tier_restore_jobs.go
@@ -13,15 +13,17 @@ import (
type SharedTierRestoreJobsApi interface {
/*
- CreateSharedClusterBackupRestoreJob Create One Restore Job from One M2 or M5 Cluster
+ CreateSharedClusterBackupRestoreJob Create One Restore Job from One M2 or M5 Cluster
- Restores the specified cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role.
+ Restores the specified M2 or M5 cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param clusterName Human-readable label that identifies the cluster.
- @param groupId 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. **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.
- @param tenantRestore The restore job details.
- @return CreateSharedClusterBackupRestoreJobApiRequest
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the createFlexBackupRestoreJob endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param clusterName Human-readable label that identifies the cluster.
+ @param groupId 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. **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.
+ @param tenantRestore The restore job details.
+ @return CreateSharedClusterBackupRestoreJobApiRequest
*/
CreateSharedClusterBackupRestoreJob(ctx context.Context, clusterName string, groupId string, tenantRestore *TenantRestore) CreateSharedClusterBackupRestoreJobApiRequest
/*
@@ -38,15 +40,17 @@ type SharedTierRestoreJobsApi interface {
CreateSharedClusterBackupRestoreJobExecute(r CreateSharedClusterBackupRestoreJobApiRequest) (*TenantRestore, *http.Response, error)
/*
- GetSharedClusterBackupRestoreJob Return One Restore Job for One M2 or M5 Cluster
+ GetSharedClusterBackupRestoreJob Return One Restore Job for One M2 or M5 Cluster
- Returns the specified restore job. To use this resource, the requesting API Key must have the Project Read Only role.
+ Returns the specified restore job for the specified M2 or M5 cluster. To use this resource, the requesting API Key must have the Project Read Only role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param clusterName Human-readable label that identifies the cluster.
- @param groupId 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. **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.
- @param restoreId Unique 24-hexadecimal digit string that identifies the restore job to return.
- @return GetSharedClusterBackupRestoreJobApiRequest
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackupRestoreJob endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param clusterName Human-readable label that identifies the cluster.
+ @param groupId 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. **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.
+ @param restoreId Unique 24-hexadecimal digit string that identifies the restore job to return.
+ @return GetSharedClusterBackupRestoreJobApiRequest
*/
GetSharedClusterBackupRestoreJob(ctx context.Context, clusterName string, groupId string, restoreId string) GetSharedClusterBackupRestoreJobApiRequest
/*
@@ -63,14 +67,16 @@ type SharedTierRestoreJobsApi interface {
GetSharedClusterBackupRestoreJobExecute(r GetSharedClusterBackupRestoreJobApiRequest) (*TenantRestore, *http.Response, error)
/*
- ListSharedClusterBackupRestoreJobs Return All Restore Jobs for One M2 or M5 Cluster
+ ListSharedClusterBackupRestoreJobs Return All Restore Jobs for One M2 or M5 Cluster
- Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role.
+ Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param clusterName Human-readable label that identifies the cluster.
- @param groupId 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. **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.
- @return ListSharedClusterBackupRestoreJobsApiRequest
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the listFlexBackupRestoreJobs endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param clusterName Human-readable label that identifies the cluster.
+ @param groupId 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. **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.
+ @return ListSharedClusterBackupRestoreJobsApiRequest
*/
ListSharedClusterBackupRestoreJobs(ctx context.Context, clusterName string, groupId string) ListSharedClusterBackupRestoreJobsApiRequest
/*
@@ -121,7 +127,9 @@ func (r CreateSharedClusterBackupRestoreJobApiRequest) Execute() (*TenantRestore
/*
CreateSharedClusterBackupRestoreJob Create One Restore Job from One M2 or M5 Cluster
-Restores the specified cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role.
+Restores the specified M2 or M5 cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role.
+
+This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the createFlexBackupRestoreJob endpoint instead.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param clusterName Human-readable label that identifies the cluster.
@@ -247,7 +255,9 @@ func (r GetSharedClusterBackupRestoreJobApiRequest) Execute() (*TenantRestore, *
/*
GetSharedClusterBackupRestoreJob Return One Restore Job for One M2 or M5 Cluster
-Returns the specified restore job. To use this resource, the requesting API Key must have the Project Read Only role.
+Returns the specified restore job for the specified M2 or M5 cluster. To use this resource, the requesting API Key must have the Project Read Only role.
+
+This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackupRestoreJob endpoint instead.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param clusterName Human-readable label that identifies the cluster.
@@ -369,6 +379,8 @@ ListSharedClusterBackupRestoreJobs Return All Restore Jobs for One M2 or M5 Clus
Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role.
+This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the listFlexBackupRestoreJobs endpoint instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param clusterName Human-readable label that identifies the cluster.
@param groupId 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. **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.
diff --git a/admin/api_shared_tier_snapshots.go b/admin/api_shared_tier_snapshots.go
index 191718d67..f0a897e13 100644
--- a/admin/api_shared_tier_snapshots.go
+++ b/admin/api_shared_tier_snapshots.go
@@ -13,15 +13,17 @@ import (
type SharedTierSnapshotsApi interface {
/*
- DownloadSharedClusterBackup Download One M2 or M5 Cluster Snapshot
+ DownloadSharedClusterBackup Download One M2 or M5 Cluster Snapshot
- Requests one snapshot for the specified shared cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role.
+ Requests one snapshot for the specified shared cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param clusterName Human-readable label that identifies the cluster.
- @param groupId 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. **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.
- @param tenantRestore Snapshot to be downloaded.
- @return DownloadSharedClusterBackupApiRequest
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the downloadFlexBackup endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param clusterName Human-readable label that identifies the cluster.
+ @param groupId 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. **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.
+ @param tenantRestore Snapshot to be downloaded.
+ @return DownloadSharedClusterBackupApiRequest
*/
DownloadSharedClusterBackup(ctx context.Context, clusterName string, groupId string, tenantRestore *TenantRestore) DownloadSharedClusterBackupApiRequest
/*
@@ -38,15 +40,17 @@ type SharedTierSnapshotsApi interface {
DownloadSharedClusterBackupExecute(r DownloadSharedClusterBackupApiRequest) (*TenantRestore, *http.Response, error)
/*
- GetSharedClusterBackup Return One Snapshot for One M2 or M5 Cluster
+ GetSharedClusterBackup Return One Snapshot for One M2 or M5 Cluster
- Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role.
+ Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param clusterName Human-readable label that identifies the cluster.
- @param snapshotId Unique 24-hexadecimal digit string that identifies the desired snapshot.
- @return GetSharedClusterBackupApiRequest
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackup endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param clusterName Human-readable label that identifies the cluster.
+ @param snapshotId Unique 24-hexadecimal digit string that identifies the desired snapshot.
+ @return GetSharedClusterBackupApiRequest
*/
GetSharedClusterBackup(ctx context.Context, groupId string, clusterName string, snapshotId string) GetSharedClusterBackupApiRequest
/*
@@ -63,14 +67,16 @@ type SharedTierSnapshotsApi interface {
GetSharedClusterBackupExecute(r GetSharedClusterBackupApiRequest) (*BackupTenantSnapshot, *http.Response, error)
/*
- ListSharedClusterBackups Return All Snapshots for One M2 or M5 Cluster
+ ListSharedClusterBackups Return All Snapshots for One M2 or M5 Cluster
- Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role.
+ Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param groupId 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. **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.
- @param clusterName Human-readable label that identifies the cluster.
- @return ListSharedClusterBackupsApiRequest
+ This API also works for Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters, until January 2026, after which this endpoint will be sunset. Please use the listFlexBackups endpoint instead.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @param clusterName Human-readable label that identifies the cluster.
+ @return ListSharedClusterBackupsApiRequest
*/
ListSharedClusterBackups(ctx context.Context, groupId string, clusterName string) ListSharedClusterBackupsApiRequest
/*
@@ -123,6 +129,8 @@ DownloadSharedClusterBackup Download One M2 or M5 Cluster Snapshot
Requests one snapshot for the specified shared cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role.
+This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the downloadFlexBackup endpoint instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param clusterName Human-readable label that identifies the cluster.
@param groupId 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. **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.
@@ -249,6 +257,8 @@ GetSharedClusterBackup Return One Snapshot for One M2 or M5 Cluster
Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role.
+This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackup endpoint instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param clusterName Human-readable label that identifies the cluster.
@@ -369,6 +379,8 @@ ListSharedClusterBackups Return All Snapshots for One M2 or M5 Cluster
Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role.
+This API also works for Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters, until January 2026, after which this endpoint will be sunset. Please use the listFlexBackups endpoint instead.
+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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. **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.
@param clusterName Human-readable label that identifies the cluster.
diff --git a/admin/api_streams.go b/admin/api_streams.go
index 01abe866d..33f931e64 100644
--- a/admin/api_streams.go
+++ b/admin/api_streams.go
@@ -328,6 +328,29 @@ type StreamsApi interface {
// Method available only for mocking purposes
GetAccountDetailsExecute(r GetAccountDetailsApiRequest) (*AWSAccountDetails, *http.Response, error)
+ /*
+ GetActiveVpcPeeringConnections Returns all the active incoming VPC Peering Connections.
+
+ Returns a list of active incoming VPC Peering Connections.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @return GetActiveVpcPeeringConnectionsApiRequest
+ */
+ GetActiveVpcPeeringConnections(ctx context.Context, groupId string) GetActiveVpcPeeringConnectionsApiRequest
+ /*
+ GetActiveVpcPeeringConnections Returns all the active incoming VPC Peering Connections.
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param GetActiveVpcPeeringConnectionsApiParams - Parameters for the request
+ @return GetActiveVpcPeeringConnectionsApiRequest
+ */
+ GetActiveVpcPeeringConnectionsWithParams(ctx context.Context, args *GetActiveVpcPeeringConnectionsApiParams) GetActiveVpcPeeringConnectionsApiRequest
+
+ // Method available only for mocking purposes
+ GetActiveVpcPeeringConnectionsExecute(r GetActiveVpcPeeringConnectionsApiRequest) (*http.Response, error)
+
/*
GetPrivateLinkConnection Return One PrivateLink Connection
@@ -2294,6 +2317,132 @@ func (a *StreamsApiService) GetAccountDetailsExecute(r GetAccountDetailsApiReque
return localVarReturnValue, localVarHTTPResponse, nil
}
+type GetActiveVpcPeeringConnectionsApiRequest struct {
+ ctx context.Context
+ ApiService StreamsApi
+ groupId string
+ itemsPerPage *int
+ pageNum *int
+}
+
+type GetActiveVpcPeeringConnectionsApiParams struct {
+ GroupId string
+ ItemsPerPage *int
+ PageNum *int
+}
+
+func (a *StreamsApiService) GetActiveVpcPeeringConnectionsWithParams(ctx context.Context, args *GetActiveVpcPeeringConnectionsApiParams) GetActiveVpcPeeringConnectionsApiRequest {
+ return GetActiveVpcPeeringConnectionsApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ groupId: args.GroupId,
+ itemsPerPage: args.ItemsPerPage,
+ pageNum: args.PageNum,
+ }
+}
+
+// Number of items that the response returns per page.
+func (r GetActiveVpcPeeringConnectionsApiRequest) ItemsPerPage(itemsPerPage int) GetActiveVpcPeeringConnectionsApiRequest {
+ r.itemsPerPage = &itemsPerPage
+ return r
+}
+
+// Number of the page that displays the current set of the total objects that the response returns.
+func (r GetActiveVpcPeeringConnectionsApiRequest) PageNum(pageNum int) GetActiveVpcPeeringConnectionsApiRequest {
+ r.pageNum = &pageNum
+ return r
+}
+
+func (r GetActiveVpcPeeringConnectionsApiRequest) Execute() (*http.Response, error) {
+ return r.ApiService.GetActiveVpcPeeringConnectionsExecute(r)
+}
+
+/*
+GetActiveVpcPeeringConnections Returns all the active incoming VPC Peering Connections.
+
+Returns a list of active incoming VPC Peering Connections.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param groupId 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. **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.
+ @return GetActiveVpcPeeringConnectionsApiRequest
+*/
+func (a *StreamsApiService) GetActiveVpcPeeringConnections(ctx context.Context, groupId string) GetActiveVpcPeeringConnectionsApiRequest {
+ return GetActiveVpcPeeringConnectionsApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ groupId: groupId,
+ }
+}
+
+// GetActiveVpcPeeringConnectionsExecute executes the request
+func (a *StreamsApiService) GetActiveVpcPeeringConnectionsExecute(r GetActiveVpcPeeringConnectionsApiRequest) (*http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodGet
+ localVarPostBody any
+ formFiles []formFile
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "StreamsApiService.GetActiveVpcPeeringConnections")
+ if err != nil {
+ return nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections"
+ localVarPath = strings.Replace(localVarPath, "{"+"groupId"+"}", url.PathEscape(r.groupId), -1)
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+
+ if r.itemsPerPage != nil {
+ parameterAddToHeaderOrQuery(localVarQueryParams, "itemsPerPage", r.itemsPerPage, "")
+ } else {
+ var defaultValue int = 100
+ r.itemsPerPage = &defaultValue
+ parameterAddToHeaderOrQuery(localVarQueryParams, "itemsPerPage", r.itemsPerPage, "")
+ }
+ if r.pageNum != nil {
+ parameterAddToHeaderOrQuery(localVarQueryParams, "pageNum", r.pageNum, "")
+ } else {
+ var defaultValue int = 1
+ r.pageNum = &defaultValue
+ parameterAddToHeaderOrQuery(localVarQueryParams, "pageNum", r.pageNum, "")
+ }
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header (only first one)
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2024-11-13+json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := a.client.makeApiError(localVarHTTPResponse, localVarHTTPMethod, localVarPath)
+ return localVarHTTPResponse, newErr
+ }
+
+ return localVarHTTPResponse, nil
+}
+
type GetPrivateLinkConnectionApiRequest struct {
ctx context.Context
ApiService StreamsApi
diff --git a/admin/api_teams.go b/admin/api_teams.go
index cd533871d..c8c3790d5 100644
--- a/admin/api_teams.go
+++ b/admin/api_teams.go
@@ -46,6 +46,8 @@ type TeamsApi interface {
@param teamId Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.
@param addUserToTeam One or more MongoDB Cloud users that you want to add to the specified team.
@return AddTeamUserApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for TeamsApi
*/
AddTeamUser(ctx context.Context, orgId string, teamId string, addUserToTeam *[]AddUserToTeam) AddTeamUserApiRequest
/*
@@ -55,6 +57,8 @@ type TeamsApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param AddTeamUserApiParams - Parameters for the request
@return AddTeamUserApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for TeamsApi
*/
AddTeamUserWithParams(ctx context.Context, args *AddTeamUserApiParams) AddTeamUserApiRequest
@@ -206,7 +210,7 @@ type TeamsApi interface {
/*
ListTeamUsers Return All MongoDB Cloud Users Assigned to One Team
- Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role.
+ Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. Deprecated versions: v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@@ -225,7 +229,7 @@ type TeamsApi interface {
ListTeamUsersWithParams(ctx context.Context, args *ListTeamUsersApiParams) ListTeamUsersApiRequest
// Method available only for mocking purposes
- ListTeamUsersExecute(r ListTeamUsersApiRequest) (*PaginatedAppUser, *http.Response, error)
+ ListTeamUsersExecute(r ListTeamUsersApiRequest) (*PaginatedOrgUser, *http.Response, error)
/*
RemoveProjectTeam Remove One Team from One Project
@@ -261,6 +265,8 @@ type TeamsApi interface {
@param teamId Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.
@param userId Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.
@return RemoveTeamUserApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for TeamsApi
*/
RemoveTeamUser(ctx context.Context, orgId string, teamId string, userId string) RemoveTeamUserApiRequest
/*
@@ -270,6 +276,8 @@ type TeamsApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param RemoveTeamUserApiParams - Parameters for the request
@return RemoveTeamUserApiRequest
+
+ Deprecated: this method has been deprecated. Please check the latest resource version for TeamsApi
*/
RemoveTeamUserWithParams(ctx context.Context, args *RemoveTeamUserApiParams) RemoveTeamUserApiRequest
@@ -487,6 +495,8 @@ Adds one or more MongoDB Cloud users from the specified organization to the spec
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@param teamId Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.
@return AddTeamUserApiRequest
+
+Deprecated
*/
func (a *TeamsApiService) AddTeamUser(ctx context.Context, orgId string, teamId string, addUserToTeam *[]AddUserToTeam) AddTeamUserApiRequest {
return AddTeamUserApiRequest{
@@ -501,6 +511,8 @@ func (a *TeamsApiService) AddTeamUser(ctx context.Context, orgId string, teamId
// AddTeamUserExecute executes the request
//
// @return PaginatedApiAppUser
+//
+// Deprecated
func (a *TeamsApiService) AddTeamUserExecute(r AddTeamUserApiRequest) (*PaginatedApiAppUser, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
@@ -1404,14 +1416,14 @@ func (r ListTeamUsersApiRequest) PageNum(pageNum int) ListTeamUsersApiRequest {
return r
}
-func (r ListTeamUsersApiRequest) Execute() (*PaginatedAppUser, *http.Response, error) {
+func (r ListTeamUsersApiRequest) Execute() (*PaginatedOrgUser, *http.Response, error) {
return r.ApiService.ListTeamUsersExecute(r)
}
/*
ListTeamUsers Return All MongoDB Cloud Users Assigned to One Team
-Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role.
+Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. Deprecated versions: v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@@ -1429,13 +1441,13 @@ func (a *TeamsApiService) ListTeamUsers(ctx context.Context, orgId string, teamI
// ListTeamUsersExecute executes the request
//
-// @return PaginatedAppUser
-func (a *TeamsApiService) ListTeamUsersExecute(r ListTeamUsersApiRequest) (*PaginatedAppUser, *http.Response, error) {
+// @return PaginatedOrgUser
+func (a *TeamsApiService) ListTeamUsersExecute(r ListTeamUsersApiRequest) (*PaginatedOrgUser, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody any
formFiles []formFile
- localVarReturnValue *PaginatedAppUser
+ localVarReturnValue *PaginatedOrgUser
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "TeamsApiService.ListTeamUsers")
@@ -1475,7 +1487,7 @@ func (a *TeamsApiService) ListTeamUsersExecute(r ListTeamUsersApiRequest) (*Pagi
}
// to determine the Accept header (only first one)
- localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2023-01-01+json"}
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2043-01-01+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
@@ -1652,6 +1664,8 @@ Removes one MongoDB Cloud user from the specified team. This team belongs to one
@param teamId Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.
@param userId Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.
@return RemoveTeamUserApiRequest
+
+Deprecated
*/
func (a *TeamsApiService) RemoveTeamUser(ctx context.Context, orgId string, teamId string, userId string) RemoveTeamUserApiRequest {
return RemoveTeamUserApiRequest{
@@ -1664,6 +1678,7 @@ func (a *TeamsApiService) RemoveTeamUser(ctx context.Context, orgId string, team
}
// RemoveTeamUserExecute executes the request
+// Deprecated
func (a *TeamsApiService) RemoveTeamUserExecute(r RemoveTeamUserApiRequest) (*http.Response, error) {
var (
localVarHTTPMethod = http.MethodDelete
diff --git a/admin/atlas_client.go b/admin/atlas_client.go
index 3b55249a6..d15277975 100644
--- a/admin/atlas_client.go
+++ b/admin/atlas_client.go
@@ -1,4 +1,4 @@
-package admin // import "go.mongodb.org/atlas-sdk/v20241113004/admin"
+package admin // import "github.com/mongodb/atlas-sdk-go/admin"
import (
"context"
@@ -7,9 +7,9 @@ import (
"strings"
"github.com/mongodb-forks/digest"
- "go.mongodb.org/atlas-sdk/v20241113004/auth"
- "go.mongodb.org/atlas-sdk/v20241113004/auth/clientcredentials"
- "go.mongodb.org/atlas-sdk/v20241113004/internal/core"
+ "github.com/mongodb/atlas-sdk-go/auth"
+ "github.com/mongodb/atlas-sdk-go/auth/clientcredentials"
+ "github.com/mongodb/atlas-sdk-go/internal/core"
)
const (
diff --git a/admin/client.go b/admin/client.go
index c09944c28..802d2070f 100644
--- a/admin/client.go
+++ b/admin/client.go
@@ -101,6 +101,8 @@ type APIClient struct {
OnlineArchiveApi OnlineArchiveApi
+ OpenAPIApi OpenAPIApi
+
OrganizationsApi OrganizationsApi
PerformanceAdvisorApi PerformanceAdvisorApi
@@ -187,6 +189,7 @@ func NewAPIClient(cfg *Configuration) *APIClient {
c.MonitoringAndLogsApi = (*MonitoringAndLogsApiService)(&c.common)
c.NetworkPeeringApi = (*NetworkPeeringApiService)(&c.common)
c.OnlineArchiveApi = (*OnlineArchiveApiService)(&c.common)
+ c.OpenAPIApi = (*OpenAPIApiService)(&c.common)
c.OrganizationsApi = (*OrganizationsApiService)(&c.common)
c.PerformanceAdvisorApi = (*PerformanceAdvisorApiService)(&c.common)
c.PrivateEndpointServicesApi = (*PrivateEndpointServicesApiService)(&c.common)
diff --git a/admin/model_acknowledge_alert.go b/admin/model_acknowledge_alert.go
index 9fba00775..f4a8cd09a 100644
--- a/admin/model_acknowledge_alert.go
+++ b/admin/model_acknowledge_alert.go
@@ -8,7 +8,7 @@ import (
// AcknowledgeAlert Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean.
type AcknowledgeAlert struct {
- // Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
+ // Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
AcknowledgedUntil *time.Time `json:"acknowledgedUntil,omitempty"`
// Comment that a MongoDB Cloud user submitted when acknowledging the alert.
AcknowledgementComment *string `json:"acknowledgementComment,omitempty"`
diff --git a/admin/model_add_or_remove_group_role.go b/admin/model_add_or_remove_group_role.go
new file mode 100644
index 000000000..aa625a076
--- /dev/null
+++ b/admin/model_add_or_remove_group_role.go
@@ -0,0 +1,51 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// AddOrRemoveGroupRole struct for AddOrRemoveGroupRole
+type AddOrRemoveGroupRole struct {
+ // Project-level role.
+ GroupRole string `json:"groupRole"`
+}
+
+// NewAddOrRemoveGroupRole instantiates a new AddOrRemoveGroupRole object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewAddOrRemoveGroupRole(groupRole string) *AddOrRemoveGroupRole {
+ this := AddOrRemoveGroupRole{}
+ this.GroupRole = groupRole
+ return &this
+}
+
+// NewAddOrRemoveGroupRoleWithDefaults instantiates a new AddOrRemoveGroupRole object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewAddOrRemoveGroupRoleWithDefaults() *AddOrRemoveGroupRole {
+ this := AddOrRemoveGroupRole{}
+ return &this
+}
+
+// GetGroupRole returns the GroupRole field value
+func (o *AddOrRemoveGroupRole) GetGroupRole() string {
+ if o == nil {
+ var ret string
+ return ret
+ }
+
+ return o.GroupRole
+}
+
+// GetGroupRoleOk returns a tuple with the GroupRole field value
+// and a boolean to check if the value has been set.
+func (o *AddOrRemoveGroupRole) GetGroupRoleOk() (*string, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.GroupRole, true
+}
+
+// SetGroupRole sets field value
+func (o *AddOrRemoveGroupRole) SetGroupRole(v string) {
+ o.GroupRole = v
+}
diff --git a/admin/model_add_or_remove_org_role.go b/admin/model_add_or_remove_org_role.go
new file mode 100644
index 000000000..20928d5bd
--- /dev/null
+++ b/admin/model_add_or_remove_org_role.go
@@ -0,0 +1,51 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// AddOrRemoveOrgRole struct for AddOrRemoveOrgRole
+type AddOrRemoveOrgRole struct {
+ // Organization-level role.
+ OrgRole string `json:"orgRole"`
+}
+
+// NewAddOrRemoveOrgRole instantiates a new AddOrRemoveOrgRole object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewAddOrRemoveOrgRole(orgRole string) *AddOrRemoveOrgRole {
+ this := AddOrRemoveOrgRole{}
+ this.OrgRole = orgRole
+ return &this
+}
+
+// NewAddOrRemoveOrgRoleWithDefaults instantiates a new AddOrRemoveOrgRole object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewAddOrRemoveOrgRoleWithDefaults() *AddOrRemoveOrgRole {
+ this := AddOrRemoveOrgRole{}
+ return &this
+}
+
+// GetOrgRole returns the OrgRole field value
+func (o *AddOrRemoveOrgRole) GetOrgRole() string {
+ if o == nil {
+ var ret string
+ return ret
+ }
+
+ return o.OrgRole
+}
+
+// GetOrgRoleOk returns a tuple with the OrgRole field value
+// and a boolean to check if the value has been set.
+func (o *AddOrRemoveOrgRole) GetOrgRoleOk() (*string, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.OrgRole, true
+}
+
+// SetOrgRole sets field value
+func (o *AddOrRemoveOrgRole) SetOrgRole(v string) {
+ o.OrgRole = v
+}
diff --git a/admin/model_add_or_remove_user_from_team.go b/admin/model_add_or_remove_user_from_team.go
new file mode 100644
index 000000000..c834a26e9
--- /dev/null
+++ b/admin/model_add_or_remove_user_from_team.go
@@ -0,0 +1,52 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// AddOrRemoveUserFromTeam struct for AddOrRemoveUserFromTeam
+type AddOrRemoveUserFromTeam struct {
+ // Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.
+ // Write only field.
+ Id string `json:"id"`
+}
+
+// NewAddOrRemoveUserFromTeam instantiates a new AddOrRemoveUserFromTeam object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewAddOrRemoveUserFromTeam(id string) *AddOrRemoveUserFromTeam {
+ this := AddOrRemoveUserFromTeam{}
+ this.Id = id
+ return &this
+}
+
+// NewAddOrRemoveUserFromTeamWithDefaults instantiates a new AddOrRemoveUserFromTeam object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewAddOrRemoveUserFromTeamWithDefaults() *AddOrRemoveUserFromTeam {
+ this := AddOrRemoveUserFromTeam{}
+ return &this
+}
+
+// GetId returns the Id field value
+func (o *AddOrRemoveUserFromTeam) GetId() string {
+ if o == nil {
+ var ret string
+ return ret
+ }
+
+ return o.Id
+}
+
+// GetIdOk returns a tuple with the Id field value
+// and a boolean to check if the value has been set.
+func (o *AddOrRemoveUserFromTeam) GetIdOk() (*string, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.Id, true
+}
+
+// SetId sets field value
+func (o *AddOrRemoveUserFromTeam) SetId(v string) {
+ o.Id = v
+}
diff --git a/admin/model_advanced_compute_auto_scaling.go b/admin/model_advanced_compute_auto_scaling.go
index 871b1645b..800a58210 100644
--- a/admin/model_advanced_compute_auto_scaling.go
+++ b/admin/model_advanced_compute_auto_scaling.go
@@ -7,8 +7,10 @@ type AdvancedComputeAutoScaling struct {
// Flag that indicates whether someone enabled instance size auto-scaling. - Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**. - Set to `false` to disable instance size automatic scaling.
Enabled *bool `json:"enabled,omitempty"`
// Instance size boundary to which your cluster can automatically scale.
+ // Read only field.
MaxInstanceSize *string `json:"maxInstanceSize,omitempty"`
// Instance size boundary to which your cluster can automatically scale.
+ // Read only field.
MinInstanceSize *string `json:"minInstanceSize,omitempty"`
// Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**.
ScaleDownEnabled *bool `json:"scaleDownEnabled,omitempty"`
diff --git a/admin/model_alert_view_for_nds_group.go b/admin/model_alert_view_for_nds_group.go
index cbb814e21..1f2533a46 100644
--- a/admin/model_alert_view_for_nds_group.go
+++ b/admin/model_alert_view_for_nds_group.go
@@ -8,7 +8,7 @@ import (
// AlertViewForNdsGroup struct for AlertViewForNdsGroup
type AlertViewForNdsGroup struct {
- // Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert. - To acknowledge this alert forever, set the parameter value to 100 years in the future. - To unacknowledge a previously acknowledged alert, do not set this parameter value.
+ // Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert. - To acknowledge this alert forever, set the parameter value to 100 years in the future. - To unacknowledge a previously acknowledged alert, do not set this parameter value.
AcknowledgedUntil *time.Time `json:"acknowledgedUntil,omitempty"`
// Comment that a MongoDB Cloud user submitted when acknowledging the alert.
AcknowledgementComment *string `json:"acknowledgementComment,omitempty"`
@@ -18,7 +18,7 @@ type AlertViewForNdsGroup struct {
// Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
// Read only field.
AlertConfigId *string `json:"alertConfigId,omitempty"`
- // Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
+ // Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
// Read only field.
Created *time.Time `json:"created,omitempty"`
// Incident that triggered this alert.
@@ -30,7 +30,7 @@ type AlertViewForNdsGroup struct {
// Unique 24-hexadecimal digit string that identifies this alert.
// Read only field.
Id *string `json:"id,omitempty"`
- // Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
+ // Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
// Read only field.
LastNotified *time.Time `json:"lastNotified,omitempty"`
// 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.
@@ -39,13 +39,13 @@ type AlertViewForNdsGroup struct {
// Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
// Read only field.
OrgId *string `json:"orgId,omitempty"`
- // Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.
+ // Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.
// Read only field.
Resolved *time.Time `json:"resolved,omitempty"`
// State of this alert at the time you requested its details.
// Read only field.
Status *string `json:"status,omitempty"`
- // Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
+ // Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
// Read only field.
Updated *time.Time `json:"updated,omitempty"`
// Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.
diff --git a/admin/model_alerts_notification_root_for_group.go b/admin/model_alerts_notification_root_for_group.go
index 38ad1bcd4..966e4c35b 100644
--- a/admin/model_alerts_notification_root_for_group.go
+++ b/admin/model_alerts_notification_root_for_group.go
@@ -6,7 +6,7 @@ package admin
type AlertsNotificationRootForGroup struct {
// Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API.
DatadogApiKey *string `json:"datadogApiKey,omitempty"`
- // Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`. To learn more about Datadog's regions, see Datadog Sites.
+ // Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.
DatadogRegion *string `json:"datadogRegion,omitempty"`
// Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
DelayMin *int `json:"delayMin,omitempty"`
@@ -56,7 +56,7 @@ type AlertsNotificationRootForGroup struct {
VictorOpsApiKey *string `json:"victorOpsApiKey,omitempty"`
// Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
VictorOpsRoutingKey *string `json:"victorOpsRoutingKey,omitempty"`
- // Authentication secret for a webhook-based alert. Atlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either: * You set `notification.[n].webhookSecret` to a non-empty string * You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration) **NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
+ // Authentication secret for a webhook-based alert. Atlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either: * You set `notification.[n].webhookSecret` to a non-empty string * You set a default webhookSecret either on the Integrations page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration) **NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
WebhookSecret *string `json:"webhookSecret,omitempty"`
// Target URL for a webhook-based alert. Atlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either: * You set `notification.[n].webhookURL` to a non-empty string * You set a default webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration) **NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
WebhookUrl *string `json:"webhookUrl,omitempty"`
diff --git a/admin/model_api_atlas_resource_policy.go b/admin/model_api_atlas_resource_policy.go
index 18654b7fa..fa9175bfd 100644
--- a/admin/model_api_atlas_resource_policy.go
+++ b/admin/model_api_atlas_resource_policy.go
@@ -12,6 +12,9 @@ type ApiAtlasResourcePolicy struct {
// Date and time in UTC when the atlas resource policy was created.
// Read only field.
CreatedDate *time.Time `json:"createdDate,omitempty"`
+ // Description of the atlas resource policy.
+ // Read only field.
+ Description *string `json:"description,omitempty"`
// Unique 24-hexadecimal character string that identifies the atlas resource policy.
// Read only field.
Id *string `json:"id,omitempty"`
@@ -116,6 +119,39 @@ func (o *ApiAtlasResourcePolicy) SetCreatedDate(v time.Time) {
o.CreatedDate = &v
}
+// GetDescription returns the Description field value if set, zero value otherwise
+func (o *ApiAtlasResourcePolicy) GetDescription() string {
+ if o == nil || IsNil(o.Description) {
+ var ret string
+ return ret
+ }
+ return *o.Description
+}
+
+// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *ApiAtlasResourcePolicy) GetDescriptionOk() (*string, bool) {
+ if o == nil || IsNil(o.Description) {
+ return nil, false
+ }
+
+ return o.Description, true
+}
+
+// HasDescription returns a boolean if a field has been set.
+func (o *ApiAtlasResourcePolicy) HasDescription() bool {
+ if o != nil && !IsNil(o.Description) {
+ return true
+ }
+
+ return false
+}
+
+// SetDescription gets a reference to the given string and assigns it to the Description field.
+func (o *ApiAtlasResourcePolicy) SetDescription(v string) {
+ o.Description = &v
+}
+
// GetId returns the Id field value if set, zero value otherwise
func (o *ApiAtlasResourcePolicy) GetId() string {
if o == nil || IsNil(o.Id) {
diff --git a/admin/model_api_atlas_resource_policy_create.go b/admin/model_api_atlas_resource_policy_create.go
index cdbcfcbd6..27a49fc36 100644
--- a/admin/model_api_atlas_resource_policy_create.go
+++ b/admin/model_api_atlas_resource_policy_create.go
@@ -4,6 +4,8 @@ package admin
// ApiAtlasResourcePolicyCreate struct for ApiAtlasResourcePolicyCreate
type ApiAtlasResourcePolicyCreate struct {
+ // Description of the atlas resource policy.
+ Description *string `json:"description,omitempty"`
// Human-readable label that describes the atlas resource policy.
Name string `json:"name"`
// List of policies that make up the atlas resource policy.
@@ -29,6 +31,39 @@ func NewApiAtlasResourcePolicyCreateWithDefaults() *ApiAtlasResourcePolicyCreate
return &this
}
+// GetDescription returns the Description field value if set, zero value otherwise
+func (o *ApiAtlasResourcePolicyCreate) GetDescription() string {
+ if o == nil || IsNil(o.Description) {
+ var ret string
+ return ret
+ }
+ return *o.Description
+}
+
+// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *ApiAtlasResourcePolicyCreate) GetDescriptionOk() (*string, bool) {
+ if o == nil || IsNil(o.Description) {
+ return nil, false
+ }
+
+ return o.Description, true
+}
+
+// HasDescription returns a boolean if a field has been set.
+func (o *ApiAtlasResourcePolicyCreate) HasDescription() bool {
+ if o != nil && !IsNil(o.Description) {
+ return true
+ }
+
+ return false
+}
+
+// SetDescription gets a reference to the given string and assigns it to the Description field.
+func (o *ApiAtlasResourcePolicyCreate) SetDescription(v string) {
+ o.Description = &v
+}
+
// GetName returns the Name field value
func (o *ApiAtlasResourcePolicyCreate) GetName() string {
if o == nil {
diff --git a/admin/model_api_atlas_resource_policy_edit.go b/admin/model_api_atlas_resource_policy_edit.go
index 5a1150a82..6aeb4908c 100644
--- a/admin/model_api_atlas_resource_policy_edit.go
+++ b/admin/model_api_atlas_resource_policy_edit.go
@@ -4,6 +4,8 @@ package admin
// ApiAtlasResourcePolicyEdit struct for ApiAtlasResourcePolicyEdit
type ApiAtlasResourcePolicyEdit struct {
+ // Description of the atlas resource policy.
+ Description *string `json:"description,omitempty"`
// Human-readable label that describes the atlas resource policy.
Name *string `json:"name,omitempty"`
// List of policies that make up the atlas resource policy.
@@ -27,6 +29,39 @@ func NewApiAtlasResourcePolicyEditWithDefaults() *ApiAtlasResourcePolicyEdit {
return &this
}
+// GetDescription returns the Description field value if set, zero value otherwise
+func (o *ApiAtlasResourcePolicyEdit) GetDescription() string {
+ if o == nil || IsNil(o.Description) {
+ var ret string
+ return ret
+ }
+ return *o.Description
+}
+
+// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *ApiAtlasResourcePolicyEdit) GetDescriptionOk() (*string, bool) {
+ if o == nil || IsNil(o.Description) {
+ return nil, false
+ }
+
+ return o.Description, true
+}
+
+// HasDescription returns a boolean if a field has been set.
+func (o *ApiAtlasResourcePolicyEdit) HasDescription() bool {
+ if o != nil && !IsNil(o.Description) {
+ return true
+ }
+
+ return false
+}
+
+// SetDescription gets a reference to the given string and assigns it to the Description field.
+func (o *ApiAtlasResourcePolicyEdit) SetDescription(v string) {
+ o.Description = &v
+}
+
// GetName returns the Name field value if set, zero value otherwise
func (o *ApiAtlasResourcePolicyEdit) GetName() string {
if o == nil || IsNil(o.Name) {
diff --git a/admin/model_api_search_deployment_request.go b/admin/model_api_search_deployment_request.go
index f6be4033e..0f5318ebb 100644
--- a/admin/model_api_search_deployment_request.go
+++ b/admin/model_api_search_deployment_request.go
@@ -4,7 +4,7 @@ package admin
// ApiSearchDeploymentRequest struct for ApiSearchDeploymentRequest
type ApiSearchDeploymentRequest struct {
- // List of settings that configure the Search Nodes for your cluster.
+ // List of settings that configure the Search Nodes for your cluster. **NOTE**: We accept a single configuration for all nodes currently.
Specs []ApiSearchDeploymentSpec `json:"specs"`
}
diff --git a/admin/model_api_search_deployment_response.go b/admin/model_api_search_deployment_response.go
index 6eb9c423d..91fe67fac 100644
--- a/admin/model_api_search_deployment_response.go
+++ b/admin/model_api_search_deployment_response.go
@@ -10,7 +10,7 @@ type ApiSearchDeploymentResponse struct {
// Unique 24-hexadecimal digit string that identifies the search deployment.
// Read only field.
Id *string `json:"id,omitempty"`
- // List of settings that configure the Search Nodes for your cluster.
+ // List of settings that configure the Search Nodes for your cluster. The configuration will be returned for each region and shard.
// Read only field.
Specs *[]ApiSearchDeploymentSpec `json:"specs,omitempty"`
// Human-readable label that indicates the current operating condition of this search deployment.
diff --git a/admin/model_api_version.go b/admin/model_api_version.go
new file mode 100644
index 000000000..3e3511811
--- /dev/null
+++ b/admin/model_api_version.go
@@ -0,0 +1,59 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// ApiVersion struct for ApiVersion
+type ApiVersion struct {
+ // Object representing a version of the Atlas Admin API.
+ Version *string `json:"version,omitempty"`
+}
+
+// NewApiVersion instantiates a new ApiVersion object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewApiVersion() *ApiVersion {
+ this := ApiVersion{}
+ return &this
+}
+
+// NewApiVersionWithDefaults instantiates a new ApiVersion object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewApiVersionWithDefaults() *ApiVersion {
+ this := ApiVersion{}
+ return &this
+}
+
+// GetVersion returns the Version field value if set, zero value otherwise
+func (o *ApiVersion) GetVersion() string {
+ if o == nil || IsNil(o.Version) {
+ var ret string
+ return ret
+ }
+ return *o.Version
+}
+
+// GetVersionOk returns a tuple with the Version field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *ApiVersion) GetVersionOk() (*string, bool) {
+ if o == nil || IsNil(o.Version) {
+ return nil, false
+ }
+
+ return o.Version, true
+}
+
+// HasVersion returns a boolean if a field has been set.
+func (o *ApiVersion) HasVersion() bool {
+ if o != nil && !IsNil(o.Version) {
+ return true
+ }
+
+ return false
+}
+
+// SetVersion gets a reference to the given string and assigns it to the Version field.
+func (o *ApiVersion) SetVersion(v string) {
+ o.Version = &v
+}
diff --git a/admin/model_awskms_configuration.go b/admin/model_awskms_configuration.go
index 0207eb280..339ab1742 100644
--- a/admin/model_awskms_configuration.go
+++ b/admin/model_awskms_configuration.go
@@ -12,6 +12,8 @@ type AWSKMSConfiguration struct {
Enabled *bool `json:"enabled,omitempty"`
// Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. 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. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.
Region *string `json:"region,omitempty"`
+ // Enable connection to your Amazon Web Services (AWS) Key Management Service (KMS) over private networking.
+ RequirePrivateNetworking *bool `json:"requirePrivateNetworking,omitempty"`
// Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. This IAM role has the permissions required to manage your AWS customer master key.
// Write only field.
RoleId *string `json:"roleId,omitempty"`
@@ -172,6 +174,39 @@ func (o *AWSKMSConfiguration) SetRegion(v string) {
o.Region = &v
}
+// GetRequirePrivateNetworking returns the RequirePrivateNetworking field value if set, zero value otherwise
+func (o *AWSKMSConfiguration) GetRequirePrivateNetworking() bool {
+ if o == nil || IsNil(o.RequirePrivateNetworking) {
+ var ret bool
+ return ret
+ }
+ return *o.RequirePrivateNetworking
+}
+
+// GetRequirePrivateNetworkingOk returns a tuple with the RequirePrivateNetworking field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *AWSKMSConfiguration) GetRequirePrivateNetworkingOk() (*bool, bool) {
+ if o == nil || IsNil(o.RequirePrivateNetworking) {
+ return nil, false
+ }
+
+ return o.RequirePrivateNetworking, true
+}
+
+// HasRequirePrivateNetworking returns a boolean if a field has been set.
+func (o *AWSKMSConfiguration) HasRequirePrivateNetworking() bool {
+ if o != nil && !IsNil(o.RequirePrivateNetworking) {
+ return true
+ }
+
+ return false
+}
+
+// SetRequirePrivateNetworking gets a reference to the given bool and assigns it to the RequirePrivateNetworking field.
+func (o *AWSKMSConfiguration) SetRequirePrivateNetworking(v bool) {
+ o.RequirePrivateNetworking = &v
+}
+
// GetRoleId returns the RoleId field value if set, zero value otherwise
func (o *AWSKMSConfiguration) GetRoleId() string {
if o == nil || IsNil(o.RoleId) {
diff --git a/admin/model_cloud_region_config20240805.go b/admin/model_cloud_region_config20240805.go
index e2551a4e2..9e358dd04 100644
--- a/admin/model_cloud_region_config20240805.go
+++ b/admin/model_cloud_region_config20240805.go
@@ -15,7 +15,7 @@ type CloudRegionConfig20240805 struct {
AnalyticsSpecs *DedicatedHardwareSpec20240805 `json:"analyticsSpecs,omitempty"`
AutoScaling *AdvancedAutoScalingSettings `json:"autoScaling,omitempty"`
ReadOnlySpecs *DedicatedHardwareSpec20240805 `json:"readOnlySpecs,omitempty"`
- // Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.
+ // Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`. Please note that using an instanceSize of M2 or M5 will create a Flex cluster instead. Support for the instanceSize of M2 or M5 will be discontinued in January 2026. We recommend using the createFlexCluster API for such configurations moving forward.
BackingProviderName *string `json:"backingProviderName,omitempty"`
}
diff --git a/admin/model_create_data_process_region.go b/admin/model_create_data_process_region.go
index 19e60af50..c4d5f634f 100644
--- a/admin/model_create_data_process_region.go
+++ b/admin/model_create_data_process_region.go
@@ -4,7 +4,7 @@ package admin
// CreateDataProcessRegion Settings to configure the region where you wish to store your archived data.
type CreateDataProcessRegion struct {
- // Human-readable label that identifies the Cloud service provider where you wish to store your archived data. **AZURE** or **GCP** may be selected only if it is the Cloud service provider for the cluster and no archives for any other cloud provider have been created for the cluster. **GCP** is currently only supported in [private preview](https://www.mongodb.com/community/forums/t/invitation-to-participate-in-the-private-preview-program-of-online-archive-on-gcp).
+ // Human-readable label that identifies the Cloud service provider where you wish to store your archived data. **AZURE** or **GCP** may be selected only if it is the Cloud service provider for the cluster and no archives for any other cloud provider have been created for the cluster.
CloudProvider *string `json:"cloudProvider,omitempty"`
// Human-readable label that identifies the geographic location of the region where you wish to store your archived data.
Region *string `json:"region,omitempty"`
diff --git a/admin/model_disk_backup_snapshot_export_bucket_request.go b/admin/model_disk_backup_snapshot_export_bucket_request.go
index 727497ab0..9a8facdda 100644
--- a/admin/model_disk_backup_snapshot_export_bucket_request.go
+++ b/admin/model_disk_backup_snapshot_export_bucket_request.go
@@ -11,7 +11,7 @@ type DiskBackupSnapshotExportBucketRequest struct {
// 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.
// Read only field.
Links *[]Link `json:"links,omitempty"`
- // Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.
+ // Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.
IamRoleId *string `json:"iamRoleId,omitempty"`
// Unique 24-hexadecimal digit string that identifies the Azure Cloud Provider Access Role that MongoDB Cloud uses to access the Azure Blob Storage Container.
RoleId *string `json:"roleId,omitempty"`
diff --git a/admin/model_disk_backup_snapshot_export_bucket_response.go b/admin/model_disk_backup_snapshot_export_bucket_response.go
index 02dd2bb9a..f732995ad 100644
--- a/admin/model_disk_backup_snapshot_export_bucket_response.go
+++ b/admin/model_disk_backup_snapshot_export_bucket_response.go
@@ -13,7 +13,7 @@ type DiskBackupSnapshotExportBucketResponse struct {
// 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.
// Read only field.
Links *[]Link `json:"links,omitempty"`
- // Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.
+ // Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.
IamRoleId *string `json:"iamRoleId,omitempty"`
// Unique 24-hexadecimal digit string that identifies the Azure Cloud Provider Access Role that MongoDB Cloud uses to access the Azure Blob Storage Container.
RoleId *string `json:"roleId,omitempty"`
diff --git a/admin/model_drop_index_suggestions_index.go b/admin/model_drop_index_suggestions_index.go
new file mode 100644
index 000000000..1ea20cb50
--- /dev/null
+++ b/admin/model_drop_index_suggestions_index.go
@@ -0,0 +1,273 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+import (
+ "time"
+)
+
+// DropIndexSuggestionsIndex struct for DropIndexSuggestionsIndex
+type DropIndexSuggestionsIndex struct {
+ // Usage count (since last restart) of index.
+ AccessCount *int64 `json:"accessCount,omitempty"`
+ // List that contains documents that specify a key in the index and its sort order.
+ Index *[]any `json:"index,omitempty"`
+ // Name of index.
+ Name *string `json:"name,omitempty"`
+ // Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.
+ Namespace *string `json:"namespace,omitempty"`
+ // List that contains strings that specifies the shards where the index is found.
+ Shards *[]string `json:"shards,omitempty"`
+ // Date of most recent usage of index.
+ Since *time.Time `json:"since,omitempty"`
+ // Size of index.
+ SizeBytes *int64 `json:"sizeBytes,omitempty"`
+}
+
+// NewDropIndexSuggestionsIndex instantiates a new DropIndexSuggestionsIndex object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewDropIndexSuggestionsIndex() *DropIndexSuggestionsIndex {
+ this := DropIndexSuggestionsIndex{}
+ return &this
+}
+
+// NewDropIndexSuggestionsIndexWithDefaults instantiates a new DropIndexSuggestionsIndex object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewDropIndexSuggestionsIndexWithDefaults() *DropIndexSuggestionsIndex {
+ this := DropIndexSuggestionsIndex{}
+ return &this
+}
+
+// GetAccessCount returns the AccessCount field value if set, zero value otherwise
+func (o *DropIndexSuggestionsIndex) GetAccessCount() int64 {
+ if o == nil || IsNil(o.AccessCount) {
+ var ret int64
+ return ret
+ }
+ return *o.AccessCount
+}
+
+// GetAccessCountOk returns a tuple with the AccessCount field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *DropIndexSuggestionsIndex) GetAccessCountOk() (*int64, bool) {
+ if o == nil || IsNil(o.AccessCount) {
+ return nil, false
+ }
+
+ return o.AccessCount, true
+}
+
+// HasAccessCount returns a boolean if a field has been set.
+func (o *DropIndexSuggestionsIndex) HasAccessCount() bool {
+ if o != nil && !IsNil(o.AccessCount) {
+ return true
+ }
+
+ return false
+}
+
+// SetAccessCount gets a reference to the given int64 and assigns it to the AccessCount field.
+func (o *DropIndexSuggestionsIndex) SetAccessCount(v int64) {
+ o.AccessCount = &v
+}
+
+// GetIndex returns the Index field value if set, zero value otherwise
+func (o *DropIndexSuggestionsIndex) GetIndex() []any {
+ if o == nil || IsNil(o.Index) {
+ var ret []any
+ return ret
+ }
+ return *o.Index
+}
+
+// GetIndexOk returns a tuple with the Index field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *DropIndexSuggestionsIndex) GetIndexOk() (*[]any, bool) {
+ if o == nil || IsNil(o.Index) {
+ return nil, false
+ }
+
+ return o.Index, true
+}
+
+// HasIndex returns a boolean if a field has been set.
+func (o *DropIndexSuggestionsIndex) HasIndex() bool {
+ if o != nil && !IsNil(o.Index) {
+ return true
+ }
+
+ return false
+}
+
+// SetIndex gets a reference to the given []any and assigns it to the Index field.
+func (o *DropIndexSuggestionsIndex) SetIndex(v []any) {
+ o.Index = &v
+}
+
+// GetName returns the Name field value if set, zero value otherwise
+func (o *DropIndexSuggestionsIndex) GetName() string {
+ if o == nil || IsNil(o.Name) {
+ var ret string
+ return ret
+ }
+ return *o.Name
+}
+
+// GetNameOk returns a tuple with the Name field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *DropIndexSuggestionsIndex) GetNameOk() (*string, bool) {
+ if o == nil || IsNil(o.Name) {
+ return nil, false
+ }
+
+ return o.Name, true
+}
+
+// HasName returns a boolean if a field has been set.
+func (o *DropIndexSuggestionsIndex) HasName() bool {
+ if o != nil && !IsNil(o.Name) {
+ return true
+ }
+
+ return false
+}
+
+// SetName gets a reference to the given string and assigns it to the Name field.
+func (o *DropIndexSuggestionsIndex) SetName(v string) {
+ o.Name = &v
+}
+
+// GetNamespace returns the Namespace field value if set, zero value otherwise
+func (o *DropIndexSuggestionsIndex) GetNamespace() string {
+ if o == nil || IsNil(o.Namespace) {
+ var ret string
+ return ret
+ }
+ return *o.Namespace
+}
+
+// GetNamespaceOk returns a tuple with the Namespace field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *DropIndexSuggestionsIndex) GetNamespaceOk() (*string, bool) {
+ if o == nil || IsNil(o.Namespace) {
+ return nil, false
+ }
+
+ return o.Namespace, true
+}
+
+// HasNamespace returns a boolean if a field has been set.
+func (o *DropIndexSuggestionsIndex) HasNamespace() bool {
+ if o != nil && !IsNil(o.Namespace) {
+ return true
+ }
+
+ return false
+}
+
+// SetNamespace gets a reference to the given string and assigns it to the Namespace field.
+func (o *DropIndexSuggestionsIndex) SetNamespace(v string) {
+ o.Namespace = &v
+}
+
+// GetShards returns the Shards field value if set, zero value otherwise
+func (o *DropIndexSuggestionsIndex) GetShards() []string {
+ if o == nil || IsNil(o.Shards) {
+ var ret []string
+ return ret
+ }
+ return *o.Shards
+}
+
+// GetShardsOk returns a tuple with the Shards field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *DropIndexSuggestionsIndex) GetShardsOk() (*[]string, bool) {
+ if o == nil || IsNil(o.Shards) {
+ return nil, false
+ }
+
+ return o.Shards, true
+}
+
+// HasShards returns a boolean if a field has been set.
+func (o *DropIndexSuggestionsIndex) HasShards() bool {
+ if o != nil && !IsNil(o.Shards) {
+ return true
+ }
+
+ return false
+}
+
+// SetShards gets a reference to the given []string and assigns it to the Shards field.
+func (o *DropIndexSuggestionsIndex) SetShards(v []string) {
+ o.Shards = &v
+}
+
+// GetSince returns the Since field value if set, zero value otherwise
+func (o *DropIndexSuggestionsIndex) GetSince() time.Time {
+ if o == nil || IsNil(o.Since) {
+ var ret time.Time
+ return ret
+ }
+ return *o.Since
+}
+
+// GetSinceOk returns a tuple with the Since field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *DropIndexSuggestionsIndex) GetSinceOk() (*time.Time, bool) {
+ if o == nil || IsNil(o.Since) {
+ return nil, false
+ }
+
+ return o.Since, true
+}
+
+// HasSince returns a boolean if a field has been set.
+func (o *DropIndexSuggestionsIndex) HasSince() bool {
+ if o != nil && !IsNil(o.Since) {
+ return true
+ }
+
+ return false
+}
+
+// SetSince gets a reference to the given time.Time and assigns it to the Since field.
+func (o *DropIndexSuggestionsIndex) SetSince(v time.Time) {
+ o.Since = &v
+}
+
+// GetSizeBytes returns the SizeBytes field value if set, zero value otherwise
+func (o *DropIndexSuggestionsIndex) GetSizeBytes() int64 {
+ if o == nil || IsNil(o.SizeBytes) {
+ var ret int64
+ return ret
+ }
+ return *o.SizeBytes
+}
+
+// GetSizeBytesOk returns a tuple with the SizeBytes field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *DropIndexSuggestionsIndex) GetSizeBytesOk() (*int64, bool) {
+ if o == nil || IsNil(o.SizeBytes) {
+ return nil, false
+ }
+
+ return o.SizeBytes, true
+}
+
+// HasSizeBytes returns a boolean if a field has been set.
+func (o *DropIndexSuggestionsIndex) HasSizeBytes() bool {
+ if o != nil && !IsNil(o.SizeBytes) {
+ return true
+ }
+
+ return false
+}
+
+// SetSizeBytes gets a reference to the given int64 and assigns it to the SizeBytes field.
+func (o *DropIndexSuggestionsIndex) SetSizeBytes(v int64) {
+ o.SizeBytes = &v
+}
diff --git a/admin/model_drop_index_suggestions_response.go b/admin/model_drop_index_suggestions_response.go
new file mode 100644
index 000000000..37904cb95
--- /dev/null
+++ b/admin/model_drop_index_suggestions_response.go
@@ -0,0 +1,132 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// DropIndexSuggestionsResponse struct for DropIndexSuggestionsResponse
+type DropIndexSuggestionsResponse struct {
+ // List that contains the documents with information about the hidden indexes that the Performance Advisor suggests to remove.
+ // Read only field.
+ HiddenIndexes *[]DropIndexSuggestionsIndex `json:"hiddenIndexes,omitempty"`
+ // List that contains the documents with information about the redundant indexes that the Performance Advisor suggests to remove.
+ // Read only field.
+ RedundantIndexes *[]DropIndexSuggestionsIndex `json:"redundantIndexes,omitempty"`
+ // List that contains the documents with information about the unused indexes that the Performance Advisor suggests to remove.
+ // Read only field.
+ UnusedIndexes *[]DropIndexSuggestionsIndex `json:"unusedIndexes,omitempty"`
+}
+
+// NewDropIndexSuggestionsResponse instantiates a new DropIndexSuggestionsResponse object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewDropIndexSuggestionsResponse() *DropIndexSuggestionsResponse {
+ this := DropIndexSuggestionsResponse{}
+ return &this
+}
+
+// NewDropIndexSuggestionsResponseWithDefaults instantiates a new DropIndexSuggestionsResponse object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewDropIndexSuggestionsResponseWithDefaults() *DropIndexSuggestionsResponse {
+ this := DropIndexSuggestionsResponse{}
+ return &this
+}
+
+// GetHiddenIndexes returns the HiddenIndexes field value if set, zero value otherwise
+func (o *DropIndexSuggestionsResponse) GetHiddenIndexes() []DropIndexSuggestionsIndex {
+ if o == nil || IsNil(o.HiddenIndexes) {
+ var ret []DropIndexSuggestionsIndex
+ return ret
+ }
+ return *o.HiddenIndexes
+}
+
+// GetHiddenIndexesOk returns a tuple with the HiddenIndexes field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *DropIndexSuggestionsResponse) GetHiddenIndexesOk() (*[]DropIndexSuggestionsIndex, bool) {
+ if o == nil || IsNil(o.HiddenIndexes) {
+ return nil, false
+ }
+
+ return o.HiddenIndexes, true
+}
+
+// HasHiddenIndexes returns a boolean if a field has been set.
+func (o *DropIndexSuggestionsResponse) HasHiddenIndexes() bool {
+ if o != nil && !IsNil(o.HiddenIndexes) {
+ return true
+ }
+
+ return false
+}
+
+// SetHiddenIndexes gets a reference to the given []DropIndexSuggestionsIndex and assigns it to the HiddenIndexes field.
+func (o *DropIndexSuggestionsResponse) SetHiddenIndexes(v []DropIndexSuggestionsIndex) {
+ o.HiddenIndexes = &v
+}
+
+// GetRedundantIndexes returns the RedundantIndexes field value if set, zero value otherwise
+func (o *DropIndexSuggestionsResponse) GetRedundantIndexes() []DropIndexSuggestionsIndex {
+ if o == nil || IsNil(o.RedundantIndexes) {
+ var ret []DropIndexSuggestionsIndex
+ return ret
+ }
+ return *o.RedundantIndexes
+}
+
+// GetRedundantIndexesOk returns a tuple with the RedundantIndexes field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *DropIndexSuggestionsResponse) GetRedundantIndexesOk() (*[]DropIndexSuggestionsIndex, bool) {
+ if o == nil || IsNil(o.RedundantIndexes) {
+ return nil, false
+ }
+
+ return o.RedundantIndexes, true
+}
+
+// HasRedundantIndexes returns a boolean if a field has been set.
+func (o *DropIndexSuggestionsResponse) HasRedundantIndexes() bool {
+ if o != nil && !IsNil(o.RedundantIndexes) {
+ return true
+ }
+
+ return false
+}
+
+// SetRedundantIndexes gets a reference to the given []DropIndexSuggestionsIndex and assigns it to the RedundantIndexes field.
+func (o *DropIndexSuggestionsResponse) SetRedundantIndexes(v []DropIndexSuggestionsIndex) {
+ o.RedundantIndexes = &v
+}
+
+// GetUnusedIndexes returns the UnusedIndexes field value if set, zero value otherwise
+func (o *DropIndexSuggestionsResponse) GetUnusedIndexes() []DropIndexSuggestionsIndex {
+ if o == nil || IsNil(o.UnusedIndexes) {
+ var ret []DropIndexSuggestionsIndex
+ return ret
+ }
+ return *o.UnusedIndexes
+}
+
+// GetUnusedIndexesOk returns a tuple with the UnusedIndexes field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *DropIndexSuggestionsResponse) GetUnusedIndexesOk() (*[]DropIndexSuggestionsIndex, bool) {
+ if o == nil || IsNil(o.UnusedIndexes) {
+ return nil, false
+ }
+
+ return o.UnusedIndexes, true
+}
+
+// HasUnusedIndexes returns a boolean if a field has been set.
+func (o *DropIndexSuggestionsResponse) HasUnusedIndexes() bool {
+ if o != nil && !IsNil(o.UnusedIndexes) {
+ return true
+ }
+
+ return false
+}
+
+// SetUnusedIndexes gets a reference to the given []DropIndexSuggestionsIndex and assigns it to the UnusedIndexes field.
+func (o *DropIndexSuggestionsResponse) SetUnusedIndexes(v []DropIndexSuggestionsIndex) {
+ o.UnusedIndexes = &v
+}
diff --git a/admin/model_event_view_for_nds_group.go b/admin/model_event_view_for_nds_group.go
index e1edaccfe..54d64214e 100644
--- a/admin/model_event_view_for_nds_group.go
+++ b/admin/model_event_view_for_nds_group.go
@@ -8,10 +8,10 @@ import (
// EventViewForNdsGroup struct for EventViewForNdsGroup
type EventViewForNdsGroup struct {
- // Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.
+ // Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.
// Read only field.
ApiKeyId *string `json:"apiKeyId,omitempty"`
- // Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
+ // Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
// Read only field.
Created *time.Time `json:"created,omitempty"`
// Unique identifier of event type.
@@ -31,7 +31,7 @@ type EventViewForNdsGroup struct {
// Unique 24-hexadecimal digit string that identifies the organization to which these events apply.
// Read only field.
OrgId *string `json:"orgId,omitempty"`
- // Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.
+ // Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.
// Read only field.
PublicKey *string `json:"publicKey,omitempty"`
Raw *Raw `json:"raw,omitempty"`
@@ -68,6 +68,9 @@ type EventViewForNdsGroup struct {
// Action that the database attempted to execute when the event triggered. The response returns this parameter when `eventTypeName\" : \"DATA_EXPLORER\"`.
// Read only field.
OpType *string `json:"opType,omitempty"`
+ // Unique 24-hexadecimal digit string that identifies the Data Explorer session associated with the event.
+ // Read only field.
+ SessionId *string `json:"sessionId,omitempty"`
// Desk location of MongoDB employee associated with the event.
// Read only field.
DeskLocation *string `json:"deskLocation,omitempty"`
@@ -831,6 +834,39 @@ func (o *EventViewForNdsGroup) SetOpType(v string) {
o.OpType = &v
}
+// GetSessionId returns the SessionId field value if set, zero value otherwise
+func (o *EventViewForNdsGroup) GetSessionId() string {
+ if o == nil || IsNil(o.SessionId) {
+ var ret string
+ return ret
+ }
+ return *o.SessionId
+}
+
+// GetSessionIdOk returns a tuple with the SessionId field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *EventViewForNdsGroup) GetSessionIdOk() (*string, bool) {
+ if o == nil || IsNil(o.SessionId) {
+ return nil, false
+ }
+
+ return o.SessionId, true
+}
+
+// HasSessionId returns a boolean if a field has been set.
+func (o *EventViewForNdsGroup) HasSessionId() bool {
+ if o != nil && !IsNil(o.SessionId) {
+ return true
+ }
+
+ return false
+}
+
+// SetSessionId gets a reference to the given string and assigns it to the SessionId field.
+func (o *EventViewForNdsGroup) SetSessionId(v string) {
+ o.SessionId = &v
+}
+
// GetDeskLocation returns the DeskLocation field value if set, zero value otherwise
func (o *EventViewForNdsGroup) GetDeskLocation() string {
if o == nil || IsNil(o.DeskLocation) {
diff --git a/admin/model_event_view_for_org.go b/admin/model_event_view_for_org.go
index 4afab9467..77487919a 100644
--- a/admin/model_event_view_for_org.go
+++ b/admin/model_event_view_for_org.go
@@ -8,10 +8,10 @@ import (
// EventViewForOrg struct for EventViewForOrg
type EventViewForOrg struct {
- // Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.
+ // Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.
// Read only field.
ApiKeyId *string `json:"apiKeyId,omitempty"`
- // Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
+ // Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
// Read only field.
Created *time.Time `json:"created,omitempty"`
// Unique identifier of event type.
@@ -31,7 +31,7 @@ type EventViewForOrg struct {
// Unique 24-hexadecimal digit string that identifies the organization to which these events apply.
// Read only field.
OrgId *string `json:"orgId,omitempty"`
- // Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.
+ // Public part of the API Key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.
// Read only field.
PublicKey *string `json:"publicKey,omitempty"`
Raw *Raw `json:"raw,omitempty"`
diff --git a/admin/model_serverless_metric_threshold.go b/admin/model_flex_cluster_metric_threshold.go
similarity index 68%
rename from admin/model_serverless_metric_threshold.go
rename to admin/model_flex_cluster_metric_threshold.go
index d35250b81..721342ff1 100644
--- a/admin/model_serverless_metric_threshold.go
+++ b/admin/model_flex_cluster_metric_threshold.go
@@ -2,8 +2,8 @@
package admin
-// ServerlessMetricThreshold Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
-type ServerlessMetricThreshold struct {
+// FlexClusterMetricThreshold Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
+type FlexClusterMetricThreshold struct {
// Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**.
MetricName string `json:"metricName"`
// MongoDB Cloud computes the current metric value as an average.
@@ -16,26 +16,26 @@ type ServerlessMetricThreshold struct {
Units *string `json:"units,omitempty"`
}
-// NewServerlessMetricThreshold instantiates a new ServerlessMetricThreshold object
+// NewFlexClusterMetricThreshold instantiates a new FlexClusterMetricThreshold object
// This constructor will assign default values to properties that have it defined,
// and makes sure properties required by API are set, but the set of arguments
// will change when the set of required properties is changed
-func NewServerlessMetricThreshold(metricName string) *ServerlessMetricThreshold {
- this := ServerlessMetricThreshold{}
+func NewFlexClusterMetricThreshold(metricName string) *FlexClusterMetricThreshold {
+ this := FlexClusterMetricThreshold{}
this.MetricName = metricName
return &this
}
-// NewServerlessMetricThresholdWithDefaults instantiates a new ServerlessMetricThreshold object
+// NewFlexClusterMetricThresholdWithDefaults instantiates a new FlexClusterMetricThreshold object
// This constructor will only assign default values to properties that have it defined,
// but it doesn't guarantee that properties required by API are set
-func NewServerlessMetricThresholdWithDefaults() *ServerlessMetricThreshold {
- this := ServerlessMetricThreshold{}
+func NewFlexClusterMetricThresholdWithDefaults() *FlexClusterMetricThreshold {
+ this := FlexClusterMetricThreshold{}
return &this
}
// GetMetricName returns the MetricName field value
-func (o *ServerlessMetricThreshold) GetMetricName() string {
+func (o *FlexClusterMetricThreshold) GetMetricName() string {
if o == nil {
var ret string
return ret
@@ -46,7 +46,7 @@ func (o *ServerlessMetricThreshold) GetMetricName() string {
// GetMetricNameOk returns a tuple with the MetricName field value
// and a boolean to check if the value has been set.
-func (o *ServerlessMetricThreshold) GetMetricNameOk() (*string, bool) {
+func (o *FlexClusterMetricThreshold) GetMetricNameOk() (*string, bool) {
if o == nil {
return nil, false
}
@@ -54,12 +54,12 @@ func (o *ServerlessMetricThreshold) GetMetricNameOk() (*string, bool) {
}
// SetMetricName sets field value
-func (o *ServerlessMetricThreshold) SetMetricName(v string) {
+func (o *FlexClusterMetricThreshold) SetMetricName(v string) {
o.MetricName = v
}
// GetMode returns the Mode field value if set, zero value otherwise
-func (o *ServerlessMetricThreshold) GetMode() string {
+func (o *FlexClusterMetricThreshold) GetMode() string {
if o == nil || IsNil(o.Mode) {
var ret string
return ret
@@ -69,7 +69,7 @@ func (o *ServerlessMetricThreshold) GetMode() string {
// GetModeOk returns a tuple with the Mode field value if set, nil otherwise
// and a boolean to check if the value has been set.
-func (o *ServerlessMetricThreshold) GetModeOk() (*string, bool) {
+func (o *FlexClusterMetricThreshold) GetModeOk() (*string, bool) {
if o == nil || IsNil(o.Mode) {
return nil, false
}
@@ -78,7 +78,7 @@ func (o *ServerlessMetricThreshold) GetModeOk() (*string, bool) {
}
// HasMode returns a boolean if a field has been set.
-func (o *ServerlessMetricThreshold) HasMode() bool {
+func (o *FlexClusterMetricThreshold) HasMode() bool {
if o != nil && !IsNil(o.Mode) {
return true
}
@@ -87,12 +87,12 @@ func (o *ServerlessMetricThreshold) HasMode() bool {
}
// SetMode gets a reference to the given string and assigns it to the Mode field.
-func (o *ServerlessMetricThreshold) SetMode(v string) {
+func (o *FlexClusterMetricThreshold) SetMode(v string) {
o.Mode = &v
}
// GetOperator returns the Operator field value if set, zero value otherwise
-func (o *ServerlessMetricThreshold) GetOperator() string {
+func (o *FlexClusterMetricThreshold) GetOperator() string {
if o == nil || IsNil(o.Operator) {
var ret string
return ret
@@ -102,7 +102,7 @@ func (o *ServerlessMetricThreshold) GetOperator() string {
// GetOperatorOk returns a tuple with the Operator field value if set, nil otherwise
// and a boolean to check if the value has been set.
-func (o *ServerlessMetricThreshold) GetOperatorOk() (*string, bool) {
+func (o *FlexClusterMetricThreshold) GetOperatorOk() (*string, bool) {
if o == nil || IsNil(o.Operator) {
return nil, false
}
@@ -111,7 +111,7 @@ func (o *ServerlessMetricThreshold) GetOperatorOk() (*string, bool) {
}
// HasOperator returns a boolean if a field has been set.
-func (o *ServerlessMetricThreshold) HasOperator() bool {
+func (o *FlexClusterMetricThreshold) HasOperator() bool {
if o != nil && !IsNil(o.Operator) {
return true
}
@@ -120,12 +120,12 @@ func (o *ServerlessMetricThreshold) HasOperator() bool {
}
// SetOperator gets a reference to the given string and assigns it to the Operator field.
-func (o *ServerlessMetricThreshold) SetOperator(v string) {
+func (o *FlexClusterMetricThreshold) SetOperator(v string) {
o.Operator = &v
}
// GetThreshold returns the Threshold field value if set, zero value otherwise
-func (o *ServerlessMetricThreshold) GetThreshold() float64 {
+func (o *FlexClusterMetricThreshold) GetThreshold() float64 {
if o == nil || IsNil(o.Threshold) {
var ret float64
return ret
@@ -135,7 +135,7 @@ func (o *ServerlessMetricThreshold) GetThreshold() float64 {
// GetThresholdOk returns a tuple with the Threshold field value if set, nil otherwise
// and a boolean to check if the value has been set.
-func (o *ServerlessMetricThreshold) GetThresholdOk() (*float64, bool) {
+func (o *FlexClusterMetricThreshold) GetThresholdOk() (*float64, bool) {
if o == nil || IsNil(o.Threshold) {
return nil, false
}
@@ -144,7 +144,7 @@ func (o *ServerlessMetricThreshold) GetThresholdOk() (*float64, bool) {
}
// HasThreshold returns a boolean if a field has been set.
-func (o *ServerlessMetricThreshold) HasThreshold() bool {
+func (o *FlexClusterMetricThreshold) HasThreshold() bool {
if o != nil && !IsNil(o.Threshold) {
return true
}
@@ -153,12 +153,12 @@ func (o *ServerlessMetricThreshold) HasThreshold() bool {
}
// SetThreshold gets a reference to the given float64 and assigns it to the Threshold field.
-func (o *ServerlessMetricThreshold) SetThreshold(v float64) {
+func (o *FlexClusterMetricThreshold) SetThreshold(v float64) {
o.Threshold = &v
}
// GetUnits returns the Units field value if set, zero value otherwise
-func (o *ServerlessMetricThreshold) GetUnits() string {
+func (o *FlexClusterMetricThreshold) GetUnits() string {
if o == nil || IsNil(o.Units) {
var ret string
return ret
@@ -168,7 +168,7 @@ func (o *ServerlessMetricThreshold) GetUnits() string {
// GetUnitsOk returns a tuple with the Units field value if set, nil otherwise
// and a boolean to check if the value has been set.
-func (o *ServerlessMetricThreshold) GetUnitsOk() (*string, bool) {
+func (o *FlexClusterMetricThreshold) GetUnitsOk() (*string, bool) {
if o == nil || IsNil(o.Units) {
return nil, false
}
@@ -177,7 +177,7 @@ func (o *ServerlessMetricThreshold) GetUnitsOk() (*string, bool) {
}
// HasUnits returns a boolean if a field has been set.
-func (o *ServerlessMetricThreshold) HasUnits() bool {
+func (o *FlexClusterMetricThreshold) HasUnits() bool {
if o != nil && !IsNil(o.Units) {
return true
}
@@ -186,6 +186,6 @@ func (o *ServerlessMetricThreshold) HasUnits() bool {
}
// SetUnits gets a reference to the given string and assigns it to the Units field.
-func (o *ServerlessMetricThreshold) SetUnits(v string) {
+func (o *FlexClusterMetricThreshold) SetUnits(v string) {
o.Units = &v
}
diff --git a/admin/model_group_alerts_config.go b/admin/model_group_alerts_config.go
index 2d6f6281b..df32672de 100644
--- a/admin/model_group_alerts_config.go
+++ b/admin/model_group_alerts_config.go
@@ -8,7 +8,7 @@ import (
// GroupAlertsConfig struct for GroupAlertsConfig
type GroupAlertsConfig struct {
- // Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
+ // Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
// Read only field.
Created *time.Time `json:"created,omitempty"`
// Flag that indicates whether someone enabled this alert configuration for the specified project.
@@ -28,11 +28,11 @@ type GroupAlertsConfig struct {
Matchers *[]StreamsMatcher `json:"matchers,omitempty"`
// List that contains the targets that MongoDB Cloud sends notifications.
Notifications *[]AlertsNotificationRootForGroup `json:"notifications,omitempty"`
- // Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
+ // Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
// Read only field.
- Updated *time.Time `json:"updated,omitempty"`
- MetricThreshold *ServerlessMetricThreshold `json:"metricThreshold,omitempty"`
- Threshold *GreaterThanRawThreshold `json:"threshold,omitempty"`
+ Updated *time.Time `json:"updated,omitempty"`
+ MetricThreshold *FlexClusterMetricThreshold `json:"metricThreshold,omitempty"`
+ Threshold *GreaterThanRawThreshold `json:"threshold,omitempty"`
}
// NewGroupAlertsConfig instantiates a new GroupAlertsConfig object
@@ -354,9 +354,9 @@ func (o *GroupAlertsConfig) SetUpdated(v time.Time) {
}
// GetMetricThreshold returns the MetricThreshold field value if set, zero value otherwise
-func (o *GroupAlertsConfig) GetMetricThreshold() ServerlessMetricThreshold {
+func (o *GroupAlertsConfig) GetMetricThreshold() FlexClusterMetricThreshold {
if o == nil || IsNil(o.MetricThreshold) {
- var ret ServerlessMetricThreshold
+ var ret FlexClusterMetricThreshold
return ret
}
return *o.MetricThreshold
@@ -364,7 +364,7 @@ func (o *GroupAlertsConfig) GetMetricThreshold() ServerlessMetricThreshold {
// GetMetricThresholdOk returns a tuple with the MetricThreshold field value if set, nil otherwise
// and a boolean to check if the value has been set.
-func (o *GroupAlertsConfig) GetMetricThresholdOk() (*ServerlessMetricThreshold, bool) {
+func (o *GroupAlertsConfig) GetMetricThresholdOk() (*FlexClusterMetricThreshold, bool) {
if o == nil || IsNil(o.MetricThreshold) {
return nil, false
}
@@ -381,8 +381,8 @@ func (o *GroupAlertsConfig) HasMetricThreshold() bool {
return false
}
-// SetMetricThreshold gets a reference to the given ServerlessMetricThreshold and assigns it to the MetricThreshold field.
-func (o *GroupAlertsConfig) SetMetricThreshold(v ServerlessMetricThreshold) {
+// SetMetricThreshold gets a reference to the given FlexClusterMetricThreshold and assigns it to the MetricThreshold field.
+func (o *GroupAlertsConfig) SetMetricThreshold(v FlexClusterMetricThreshold) {
o.MetricThreshold = &v
}
diff --git a/admin/model_group_role_assignment.go b/admin/model_group_role_assignment.go
new file mode 100644
index 000000000..3e4aa7fc8
--- /dev/null
+++ b/admin/model_group_role_assignment.go
@@ -0,0 +1,94 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// GroupRoleAssignment struct for GroupRoleAssignment
+type GroupRoleAssignment struct {
+ // Unique 24-hexadecimal digit string that identifies the project to which these roles belong.
+ GroupId *string `json:"groupId,omitempty"`
+ // One or more project-level roles assigned to the MongoDB Cloud user.
+ GroupRoles *[]string `json:"groupRoles,omitempty"`
+}
+
+// NewGroupRoleAssignment instantiates a new GroupRoleAssignment object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewGroupRoleAssignment() *GroupRoleAssignment {
+ this := GroupRoleAssignment{}
+ return &this
+}
+
+// NewGroupRoleAssignmentWithDefaults instantiates a new GroupRoleAssignment object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewGroupRoleAssignmentWithDefaults() *GroupRoleAssignment {
+ this := GroupRoleAssignment{}
+ return &this
+}
+
+// GetGroupId returns the GroupId field value if set, zero value otherwise
+func (o *GroupRoleAssignment) GetGroupId() string {
+ if o == nil || IsNil(o.GroupId) {
+ var ret string
+ return ret
+ }
+ return *o.GroupId
+}
+
+// GetGroupIdOk returns a tuple with the GroupId field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *GroupRoleAssignment) GetGroupIdOk() (*string, bool) {
+ if o == nil || IsNil(o.GroupId) {
+ return nil, false
+ }
+
+ return o.GroupId, true
+}
+
+// HasGroupId returns a boolean if a field has been set.
+func (o *GroupRoleAssignment) HasGroupId() bool {
+ if o != nil && !IsNil(o.GroupId) {
+ return true
+ }
+
+ return false
+}
+
+// SetGroupId gets a reference to the given string and assigns it to the GroupId field.
+func (o *GroupRoleAssignment) SetGroupId(v string) {
+ o.GroupId = &v
+}
+
+// GetGroupRoles returns the GroupRoles field value if set, zero value otherwise
+func (o *GroupRoleAssignment) GetGroupRoles() []string {
+ if o == nil || IsNil(o.GroupRoles) {
+ var ret []string
+ return ret
+ }
+ return *o.GroupRoles
+}
+
+// GetGroupRolesOk returns a tuple with the GroupRoles field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *GroupRoleAssignment) GetGroupRolesOk() (*[]string, bool) {
+ if o == nil || IsNil(o.GroupRoles) {
+ return nil, false
+ }
+
+ return o.GroupRoles, true
+}
+
+// HasGroupRoles returns a boolean if a field has been set.
+func (o *GroupRoleAssignment) HasGroupRoles() bool {
+ if o != nil && !IsNil(o.GroupRoles) {
+ return true
+ }
+
+ return false
+}
+
+// SetGroupRoles gets a reference to the given []string and assigns it to the GroupRoles field.
+func (o *GroupRoleAssignment) SetGroupRoles(v []string) {
+ o.GroupRoles = &v
+}
diff --git a/admin/model_group_settings.go b/admin/model_group_settings.go
index 27abe76e9..0104054c4 100644
--- a/admin/model_group_settings.go
+++ b/admin/model_group_settings.go
@@ -4,13 +4,17 @@ package admin
// GroupSettings Collection of settings that configures the project.
type GroupSettings struct {
- // Flag that indicates whether to collect database-specific metrics for the specified project.
+ // Flag that indicates whether to collect database-specific metrics for the specified project.
IsCollectDatabaseSpecificsStatisticsEnabled *bool `json:"isCollectDatabaseSpecificsStatisticsEnabled,omitempty"`
// Flag that indicates whether to enable the Data Explorer for the specified project.
IsDataExplorerEnabled *bool `json:"isDataExplorerEnabled,omitempty"`
- // Flag that indicates whether to enable extended storage sizes for the specified project.
+ // Flag that indicates whether to enable the use of generative AI features which make requests to 3rd party services in Data Explorer for the specified project.
+ IsDataExplorerGenAIFeaturesEnabled *bool `json:"isDataExplorerGenAIFeaturesEnabled,omitempty"`
+ // Flag that indicates whether to enable the passing of sample field values with the use of generative AI features in the Data Explorer for the specified project.
+ IsDataExplorerGenAISampleDocumentPassingEnabled *bool `json:"isDataExplorerGenAISampleDocumentPassingEnabled,omitempty"`
+ // Flag that indicates whether to enable extended storage sizes for the specified project.
IsExtendedStorageSizesEnabled *bool `json:"isExtendedStorageSizesEnabled,omitempty"`
- // Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project.
+ // Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project.
IsPerformanceAdvisorEnabled *bool `json:"isPerformanceAdvisorEnabled,omitempty"`
// Flag that indicates whether to enable the Real Time Performance Panel for the specified project.
IsRealtimePerformancePanelEnabled *bool `json:"isRealtimePerformancePanelEnabled,omitempty"`
@@ -24,6 +28,8 @@ type GroupSettings struct {
// will change when the set of required properties is changed
func NewGroupSettings() *GroupSettings {
this := GroupSettings{}
+ var isDataExplorerGenAISampleDocumentPassingEnabled bool = false
+ this.IsDataExplorerGenAISampleDocumentPassingEnabled = &isDataExplorerGenAISampleDocumentPassingEnabled
return &this
}
@@ -32,6 +38,8 @@ func NewGroupSettings() *GroupSettings {
// but it doesn't guarantee that properties required by API are set
func NewGroupSettingsWithDefaults() *GroupSettings {
this := GroupSettings{}
+ var isDataExplorerGenAISampleDocumentPassingEnabled bool = false
+ this.IsDataExplorerGenAISampleDocumentPassingEnabled = &isDataExplorerGenAISampleDocumentPassingEnabled
return &this
}
@@ -101,6 +109,72 @@ func (o *GroupSettings) SetIsDataExplorerEnabled(v bool) {
o.IsDataExplorerEnabled = &v
}
+// GetIsDataExplorerGenAIFeaturesEnabled returns the IsDataExplorerGenAIFeaturesEnabled field value if set, zero value otherwise
+func (o *GroupSettings) GetIsDataExplorerGenAIFeaturesEnabled() bool {
+ if o == nil || IsNil(o.IsDataExplorerGenAIFeaturesEnabled) {
+ var ret bool
+ return ret
+ }
+ return *o.IsDataExplorerGenAIFeaturesEnabled
+}
+
+// GetIsDataExplorerGenAIFeaturesEnabledOk returns a tuple with the IsDataExplorerGenAIFeaturesEnabled field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *GroupSettings) GetIsDataExplorerGenAIFeaturesEnabledOk() (*bool, bool) {
+ if o == nil || IsNil(o.IsDataExplorerGenAIFeaturesEnabled) {
+ return nil, false
+ }
+
+ return o.IsDataExplorerGenAIFeaturesEnabled, true
+}
+
+// HasIsDataExplorerGenAIFeaturesEnabled returns a boolean if a field has been set.
+func (o *GroupSettings) HasIsDataExplorerGenAIFeaturesEnabled() bool {
+ if o != nil && !IsNil(o.IsDataExplorerGenAIFeaturesEnabled) {
+ return true
+ }
+
+ return false
+}
+
+// SetIsDataExplorerGenAIFeaturesEnabled gets a reference to the given bool and assigns it to the IsDataExplorerGenAIFeaturesEnabled field.
+func (o *GroupSettings) SetIsDataExplorerGenAIFeaturesEnabled(v bool) {
+ o.IsDataExplorerGenAIFeaturesEnabled = &v
+}
+
+// GetIsDataExplorerGenAISampleDocumentPassingEnabled returns the IsDataExplorerGenAISampleDocumentPassingEnabled field value if set, zero value otherwise
+func (o *GroupSettings) GetIsDataExplorerGenAISampleDocumentPassingEnabled() bool {
+ if o == nil || IsNil(o.IsDataExplorerGenAISampleDocumentPassingEnabled) {
+ var ret bool
+ return ret
+ }
+ return *o.IsDataExplorerGenAISampleDocumentPassingEnabled
+}
+
+// GetIsDataExplorerGenAISampleDocumentPassingEnabledOk returns a tuple with the IsDataExplorerGenAISampleDocumentPassingEnabled field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *GroupSettings) GetIsDataExplorerGenAISampleDocumentPassingEnabledOk() (*bool, bool) {
+ if o == nil || IsNil(o.IsDataExplorerGenAISampleDocumentPassingEnabled) {
+ return nil, false
+ }
+
+ return o.IsDataExplorerGenAISampleDocumentPassingEnabled, true
+}
+
+// HasIsDataExplorerGenAISampleDocumentPassingEnabled returns a boolean if a field has been set.
+func (o *GroupSettings) HasIsDataExplorerGenAISampleDocumentPassingEnabled() bool {
+ if o != nil && !IsNil(o.IsDataExplorerGenAISampleDocumentPassingEnabled) {
+ return true
+ }
+
+ return false
+}
+
+// SetIsDataExplorerGenAISampleDocumentPassingEnabled gets a reference to the given bool and assigns it to the IsDataExplorerGenAISampleDocumentPassingEnabled field.
+func (o *GroupSettings) SetIsDataExplorerGenAISampleDocumentPassingEnabled(v bool) {
+ o.IsDataExplorerGenAISampleDocumentPassingEnabled = &v
+}
+
// GetIsExtendedStorageSizesEnabled returns the IsExtendedStorageSizesEnabled field value if set, zero value otherwise
func (o *GroupSettings) GetIsExtendedStorageSizesEnabled() bool {
if o == nil || IsNil(o.IsExtendedStorageSizesEnabled) {
diff --git a/admin/model_group_user_request.go b/admin/model_group_user_request.go
new file mode 100644
index 000000000..3c69d47f7
--- /dev/null
+++ b/admin/model_group_user_request.go
@@ -0,0 +1,80 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// GroupUserRequest struct for GroupUserRequest
+type GroupUserRequest struct {
+ // One or more project-level roles to assign the MongoDB Cloud user.
+ // Write only field.
+ Roles []string `json:"roles"`
+ // Email address that represents the username of the MongoDB Cloud user.
+ // Write only field.
+ Username string `json:"username"`
+}
+
+// NewGroupUserRequest instantiates a new GroupUserRequest object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewGroupUserRequest(roles []string, username string) *GroupUserRequest {
+ this := GroupUserRequest{}
+ this.Roles = roles
+ this.Username = username
+ return &this
+}
+
+// NewGroupUserRequestWithDefaults instantiates a new GroupUserRequest object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewGroupUserRequestWithDefaults() *GroupUserRequest {
+ this := GroupUserRequest{}
+ return &this
+}
+
+// GetRoles returns the Roles field value
+func (o *GroupUserRequest) GetRoles() []string {
+ if o == nil {
+ var ret []string
+ return ret
+ }
+
+ return o.Roles
+}
+
+// GetRolesOk returns a tuple with the Roles field value
+// and a boolean to check if the value has been set.
+func (o *GroupUserRequest) GetRolesOk() (*[]string, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.Roles, true
+}
+
+// SetRoles sets field value
+func (o *GroupUserRequest) SetRoles(v []string) {
+ o.Roles = v
+}
+
+// GetUsername returns the Username field value
+func (o *GroupUserRequest) GetUsername() string {
+ if o == nil {
+ var ret string
+ return ret
+ }
+
+ return o.Username
+}
+
+// GetUsernameOk returns a tuple with the Username field value
+// and a boolean to check if the value has been set.
+func (o *GroupUserRequest) GetUsernameOk() (*string, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.Username, true
+}
+
+// SetUsername sets field value
+func (o *GroupUserRequest) SetUsername(v string) {
+ o.Username = v
+}
diff --git a/admin/model_group_user_response.go b/admin/model_group_user_response.go
new file mode 100644
index 000000000..39adef2de
--- /dev/null
+++ b/admin/model_group_user_response.go
@@ -0,0 +1,464 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+import (
+ "time"
+)
+
+// GroupUserResponse struct for GroupUserResponse
+type GroupUserResponse struct {
+ // Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.
+ // Read only field.
+ Id string `json:"id"`
+ // String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.
+ // Read only field.
+ OrgMembershipStatus string `json:"orgMembershipStatus"`
+ // One or more project-level roles assigned to the MongoDB Cloud user.
+ // Read only field.
+ Roles []string `json:"roles"`
+ // Email address that represents the username of the MongoDB Cloud user.
+ // Read only field.
+ Username string `json:"username"`
+ // Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
+ // Read only field.
+ InvitationCreatedAt *time.Time `json:"invitationCreatedAt,omitempty"`
+ // Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
+ // Read only field.
+ InvitationExpiresAt *time.Time `json:"invitationExpiresAt,omitempty"`
+ // Username of the MongoDB Cloud user who sent the invitation to join the organization.
+ // Read only field.
+ InviterUsername *string `json:"inviterUsername,omitempty"`
+ // Two-character alphabetical string that identifies the MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.
+ // Read only field.
+ Country *string `json:"country,omitempty"`
+ // Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.
+ // Read only field.
+ CreatedAt *time.Time `json:"createdAt,omitempty"`
+ // First or given name that belongs to the MongoDB Cloud user.
+ // Read only field.
+ FirstName *string `json:"firstName,omitempty"`
+ // Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
+ // Read only field.
+ LastAuth *time.Time `json:"lastAuth,omitempty"`
+ // Last name, family name, or surname that belongs to the MongoDB Cloud user.
+ // Read only field.
+ LastName *string `json:"lastName,omitempty"`
+ // Mobile phone number that belongs to the MongoDB Cloud user.
+ // Read only field.
+ MobileNumber *string `json:"mobileNumber,omitempty"`
+}
+
+// NewGroupUserResponse instantiates a new GroupUserResponse object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewGroupUserResponse(id string, orgMembershipStatus string, roles []string, username string) *GroupUserResponse {
+ this := GroupUserResponse{}
+ this.Id = id
+ this.OrgMembershipStatus = orgMembershipStatus
+ this.Roles = roles
+ this.Username = username
+ return &this
+}
+
+// NewGroupUserResponseWithDefaults instantiates a new GroupUserResponse object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewGroupUserResponseWithDefaults() *GroupUserResponse {
+ this := GroupUserResponse{}
+ return &this
+}
+
+// GetId returns the Id field value
+func (o *GroupUserResponse) GetId() string {
+ if o == nil {
+ var ret string
+ return ret
+ }
+
+ return o.Id
+}
+
+// GetIdOk returns a tuple with the Id field value
+// and a boolean to check if the value has been set.
+func (o *GroupUserResponse) GetIdOk() (*string, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.Id, true
+}
+
+// SetId sets field value
+func (o *GroupUserResponse) SetId(v string) {
+ o.Id = v
+}
+
+// GetOrgMembershipStatus returns the OrgMembershipStatus field value
+func (o *GroupUserResponse) GetOrgMembershipStatus() string {
+ if o == nil {
+ var ret string
+ return ret
+ }
+
+ return o.OrgMembershipStatus
+}
+
+// GetOrgMembershipStatusOk returns a tuple with the OrgMembershipStatus field value
+// and a boolean to check if the value has been set.
+func (o *GroupUserResponse) GetOrgMembershipStatusOk() (*string, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.OrgMembershipStatus, true
+}
+
+// SetOrgMembershipStatus sets field value
+func (o *GroupUserResponse) SetOrgMembershipStatus(v string) {
+ o.OrgMembershipStatus = v
+}
+
+// GetRoles returns the Roles field value
+func (o *GroupUserResponse) GetRoles() []string {
+ if o == nil {
+ var ret []string
+ return ret
+ }
+
+ return o.Roles
+}
+
+// GetRolesOk returns a tuple with the Roles field value
+// and a boolean to check if the value has been set.
+func (o *GroupUserResponse) GetRolesOk() (*[]string, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.Roles, true
+}
+
+// SetRoles sets field value
+func (o *GroupUserResponse) SetRoles(v []string) {
+ o.Roles = v
+}
+
+// GetUsername returns the Username field value
+func (o *GroupUserResponse) GetUsername() string {
+ if o == nil {
+ var ret string
+ return ret
+ }
+
+ return o.Username
+}
+
+// GetUsernameOk returns a tuple with the Username field value
+// and a boolean to check if the value has been set.
+func (o *GroupUserResponse) GetUsernameOk() (*string, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.Username, true
+}
+
+// SetUsername sets field value
+func (o *GroupUserResponse) SetUsername(v string) {
+ o.Username = v
+}
+
+// GetInvitationCreatedAt returns the InvitationCreatedAt field value if set, zero value otherwise
+func (o *GroupUserResponse) GetInvitationCreatedAt() time.Time {
+ if o == nil || IsNil(o.InvitationCreatedAt) {
+ var ret time.Time
+ return ret
+ }
+ return *o.InvitationCreatedAt
+}
+
+// GetInvitationCreatedAtOk returns a tuple with the InvitationCreatedAt field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *GroupUserResponse) GetInvitationCreatedAtOk() (*time.Time, bool) {
+ if o == nil || IsNil(o.InvitationCreatedAt) {
+ return nil, false
+ }
+
+ return o.InvitationCreatedAt, true
+}
+
+// HasInvitationCreatedAt returns a boolean if a field has been set.
+func (o *GroupUserResponse) HasInvitationCreatedAt() bool {
+ if o != nil && !IsNil(o.InvitationCreatedAt) {
+ return true
+ }
+
+ return false
+}
+
+// SetInvitationCreatedAt gets a reference to the given time.Time and assigns it to the InvitationCreatedAt field.
+func (o *GroupUserResponse) SetInvitationCreatedAt(v time.Time) {
+ o.InvitationCreatedAt = &v
+}
+
+// GetInvitationExpiresAt returns the InvitationExpiresAt field value if set, zero value otherwise
+func (o *GroupUserResponse) GetInvitationExpiresAt() time.Time {
+ if o == nil || IsNil(o.InvitationExpiresAt) {
+ var ret time.Time
+ return ret
+ }
+ return *o.InvitationExpiresAt
+}
+
+// GetInvitationExpiresAtOk returns a tuple with the InvitationExpiresAt field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *GroupUserResponse) GetInvitationExpiresAtOk() (*time.Time, bool) {
+ if o == nil || IsNil(o.InvitationExpiresAt) {
+ return nil, false
+ }
+
+ return o.InvitationExpiresAt, true
+}
+
+// HasInvitationExpiresAt returns a boolean if a field has been set.
+func (o *GroupUserResponse) HasInvitationExpiresAt() bool {
+ if o != nil && !IsNil(o.InvitationExpiresAt) {
+ return true
+ }
+
+ return false
+}
+
+// SetInvitationExpiresAt gets a reference to the given time.Time and assigns it to the InvitationExpiresAt field.
+func (o *GroupUserResponse) SetInvitationExpiresAt(v time.Time) {
+ o.InvitationExpiresAt = &v
+}
+
+// GetInviterUsername returns the InviterUsername field value if set, zero value otherwise
+func (o *GroupUserResponse) GetInviterUsername() string {
+ if o == nil || IsNil(o.InviterUsername) {
+ var ret string
+ return ret
+ }
+ return *o.InviterUsername
+}
+
+// GetInviterUsernameOk returns a tuple with the InviterUsername field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *GroupUserResponse) GetInviterUsernameOk() (*string, bool) {
+ if o == nil || IsNil(o.InviterUsername) {
+ return nil, false
+ }
+
+ return o.InviterUsername, true
+}
+
+// HasInviterUsername returns a boolean if a field has been set.
+func (o *GroupUserResponse) HasInviterUsername() bool {
+ if o != nil && !IsNil(o.InviterUsername) {
+ return true
+ }
+
+ return false
+}
+
+// SetInviterUsername gets a reference to the given string and assigns it to the InviterUsername field.
+func (o *GroupUserResponse) SetInviterUsername(v string) {
+ o.InviterUsername = &v
+}
+
+// GetCountry returns the Country field value if set, zero value otherwise
+func (o *GroupUserResponse) GetCountry() string {
+ if o == nil || IsNil(o.Country) {
+ var ret string
+ return ret
+ }
+ return *o.Country
+}
+
+// GetCountryOk returns a tuple with the Country field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *GroupUserResponse) GetCountryOk() (*string, bool) {
+ if o == nil || IsNil(o.Country) {
+ return nil, false
+ }
+
+ return o.Country, true
+}
+
+// HasCountry returns a boolean if a field has been set.
+func (o *GroupUserResponse) HasCountry() bool {
+ if o != nil && !IsNil(o.Country) {
+ return true
+ }
+
+ return false
+}
+
+// SetCountry gets a reference to the given string and assigns it to the Country field.
+func (o *GroupUserResponse) SetCountry(v string) {
+ o.Country = &v
+}
+
+// GetCreatedAt returns the CreatedAt field value if set, zero value otherwise
+func (o *GroupUserResponse) GetCreatedAt() time.Time {
+ if o == nil || IsNil(o.CreatedAt) {
+ var ret time.Time
+ return ret
+ }
+ return *o.CreatedAt
+}
+
+// GetCreatedAtOk returns a tuple with the CreatedAt field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *GroupUserResponse) GetCreatedAtOk() (*time.Time, bool) {
+ if o == nil || IsNil(o.CreatedAt) {
+ return nil, false
+ }
+
+ return o.CreatedAt, true
+}
+
+// HasCreatedAt returns a boolean if a field has been set.
+func (o *GroupUserResponse) HasCreatedAt() bool {
+ if o != nil && !IsNil(o.CreatedAt) {
+ return true
+ }
+
+ return false
+}
+
+// SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.
+func (o *GroupUserResponse) SetCreatedAt(v time.Time) {
+ o.CreatedAt = &v
+}
+
+// GetFirstName returns the FirstName field value if set, zero value otherwise
+func (o *GroupUserResponse) GetFirstName() string {
+ if o == nil || IsNil(o.FirstName) {
+ var ret string
+ return ret
+ }
+ return *o.FirstName
+}
+
+// GetFirstNameOk returns a tuple with the FirstName field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *GroupUserResponse) GetFirstNameOk() (*string, bool) {
+ if o == nil || IsNil(o.FirstName) {
+ return nil, false
+ }
+
+ return o.FirstName, true
+}
+
+// HasFirstName returns a boolean if a field has been set.
+func (o *GroupUserResponse) HasFirstName() bool {
+ if o != nil && !IsNil(o.FirstName) {
+ return true
+ }
+
+ return false
+}
+
+// SetFirstName gets a reference to the given string and assigns it to the FirstName field.
+func (o *GroupUserResponse) SetFirstName(v string) {
+ o.FirstName = &v
+}
+
+// GetLastAuth returns the LastAuth field value if set, zero value otherwise
+func (o *GroupUserResponse) GetLastAuth() time.Time {
+ if o == nil || IsNil(o.LastAuth) {
+ var ret time.Time
+ return ret
+ }
+ return *o.LastAuth
+}
+
+// GetLastAuthOk returns a tuple with the LastAuth field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *GroupUserResponse) GetLastAuthOk() (*time.Time, bool) {
+ if o == nil || IsNil(o.LastAuth) {
+ return nil, false
+ }
+
+ return o.LastAuth, true
+}
+
+// HasLastAuth returns a boolean if a field has been set.
+func (o *GroupUserResponse) HasLastAuth() bool {
+ if o != nil && !IsNil(o.LastAuth) {
+ return true
+ }
+
+ return false
+}
+
+// SetLastAuth gets a reference to the given time.Time and assigns it to the LastAuth field.
+func (o *GroupUserResponse) SetLastAuth(v time.Time) {
+ o.LastAuth = &v
+}
+
+// GetLastName returns the LastName field value if set, zero value otherwise
+func (o *GroupUserResponse) GetLastName() string {
+ if o == nil || IsNil(o.LastName) {
+ var ret string
+ return ret
+ }
+ return *o.LastName
+}
+
+// GetLastNameOk returns a tuple with the LastName field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *GroupUserResponse) GetLastNameOk() (*string, bool) {
+ if o == nil || IsNil(o.LastName) {
+ return nil, false
+ }
+
+ return o.LastName, true
+}
+
+// HasLastName returns a boolean if a field has been set.
+func (o *GroupUserResponse) HasLastName() bool {
+ if o != nil && !IsNil(o.LastName) {
+ return true
+ }
+
+ return false
+}
+
+// SetLastName gets a reference to the given string and assigns it to the LastName field.
+func (o *GroupUserResponse) SetLastName(v string) {
+ o.LastName = &v
+}
+
+// GetMobileNumber returns the MobileNumber field value if set, zero value otherwise
+func (o *GroupUserResponse) GetMobileNumber() string {
+ if o == nil || IsNil(o.MobileNumber) {
+ var ret string
+ return ret
+ }
+ return *o.MobileNumber
+}
+
+// GetMobileNumberOk returns a tuple with the MobileNumber field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *GroupUserResponse) GetMobileNumberOk() (*string, bool) {
+ if o == nil || IsNil(o.MobileNumber) {
+ return nil, false
+ }
+
+ return o.MobileNumber, true
+}
+
+// HasMobileNumber returns a boolean if a field has been set.
+func (o *GroupUserResponse) HasMobileNumber() bool {
+ if o != nil && !IsNil(o.MobileNumber) {
+ return true
+ }
+
+ return false
+}
+
+// SetMobileNumber gets a reference to the given string and assigns it to the MobileNumber field.
+func (o *GroupUserResponse) SetMobileNumber(v string) {
+ o.MobileNumber = &v
+}
diff --git a/admin/model_mdb_available_version.go b/admin/model_mdb_available_version.go
index f892f04fa..57b9a93b8 100644
--- a/admin/model_mdb_available_version.go
+++ b/admin/model_mdb_available_version.go
@@ -9,6 +9,7 @@ type MdbAvailableVersion struct {
// Whether the version is the current default for the Instance Size and Cloud Provider.
DefaultStatus *string `json:"defaultStatus,omitempty"`
// Instance size boundary to which your cluster can automatically scale.
+ // Read only field.
InstanceSize *string `json:"instanceSize,omitempty"`
// 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.
// Read only field.
diff --git a/admin/model_org_user_request.go b/admin/model_org_user_request.go
new file mode 100644
index 000000000..373751614
--- /dev/null
+++ b/admin/model_org_user_request.go
@@ -0,0 +1,114 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// OrgUserRequest struct for OrgUserRequest
+type OrgUserRequest struct {
+ Roles OrgUserRolesRequest `json:"roles"`
+ // List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.
+ // Write only field.
+ TeamIds *[]string `json:"teamIds,omitempty"`
+ // Email address that represents the username of the MongoDB Cloud user.
+ // Write only field.
+ Username string `json:"username"`
+}
+
+// NewOrgUserRequest instantiates a new OrgUserRequest object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewOrgUserRequest(roles OrgUserRolesRequest, username string) *OrgUserRequest {
+ this := OrgUserRequest{}
+ this.Roles = roles
+ this.Username = username
+ return &this
+}
+
+// NewOrgUserRequestWithDefaults instantiates a new OrgUserRequest object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewOrgUserRequestWithDefaults() *OrgUserRequest {
+ this := OrgUserRequest{}
+ return &this
+}
+
+// GetRoles returns the Roles field value
+func (o *OrgUserRequest) GetRoles() OrgUserRolesRequest {
+ if o == nil {
+ var ret OrgUserRolesRequest
+ return ret
+ }
+
+ return o.Roles
+}
+
+// GetRolesOk returns a tuple with the Roles field value
+// and a boolean to check if the value has been set.
+func (o *OrgUserRequest) GetRolesOk() (*OrgUserRolesRequest, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.Roles, true
+}
+
+// SetRoles sets field value
+func (o *OrgUserRequest) SetRoles(v OrgUserRolesRequest) {
+ o.Roles = v
+}
+
+// GetTeamIds returns the TeamIds field value if set, zero value otherwise
+func (o *OrgUserRequest) GetTeamIds() []string {
+ if o == nil || IsNil(o.TeamIds) {
+ var ret []string
+ return ret
+ }
+ return *o.TeamIds
+}
+
+// GetTeamIdsOk returns a tuple with the TeamIds field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserRequest) GetTeamIdsOk() (*[]string, bool) {
+ if o == nil || IsNil(o.TeamIds) {
+ return nil, false
+ }
+
+ return o.TeamIds, true
+}
+
+// HasTeamIds returns a boolean if a field has been set.
+func (o *OrgUserRequest) HasTeamIds() bool {
+ if o != nil && !IsNil(o.TeamIds) {
+ return true
+ }
+
+ return false
+}
+
+// SetTeamIds gets a reference to the given []string and assigns it to the TeamIds field.
+func (o *OrgUserRequest) SetTeamIds(v []string) {
+ o.TeamIds = &v
+}
+
+// GetUsername returns the Username field value
+func (o *OrgUserRequest) GetUsername() string {
+ if o == nil {
+ var ret string
+ return ret
+ }
+
+ return o.Username
+}
+
+// GetUsernameOk returns a tuple with the Username field value
+// and a boolean to check if the value has been set.
+func (o *OrgUserRequest) GetUsernameOk() (*string, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.Username, true
+}
+
+// SetUsername sets field value
+func (o *OrgUserRequest) SetUsername(v string) {
+ o.Username = v
+}
diff --git a/admin/model_org_user_response.go b/admin/model_org_user_response.go
new file mode 100644
index 000000000..448109209
--- /dev/null
+++ b/admin/model_org_user_response.go
@@ -0,0 +1,498 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+import (
+ "time"
+)
+
+// OrgUserResponse struct for OrgUserResponse
+type OrgUserResponse struct {
+ // Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.
+ // Read only field.
+ Id string `json:"id"`
+ // String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.
+ // Read only field.
+ OrgMembershipStatus string `json:"orgMembershipStatus"`
+ Roles OrgUserRolesResponse `json:"roles"`
+ // List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.
+ // Read only field.
+ TeamIds *[]string `json:"teamIds,omitempty"`
+ // Email address that represents the username of the MongoDB Cloud user.
+ // Read only field.
+ Username string `json:"username"`
+ // Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
+ // Read only field.
+ InvitationCreatedAt *time.Time `json:"invitationCreatedAt,omitempty"`
+ // Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
+ // Read only field.
+ InvitationExpiresAt *time.Time `json:"invitationExpiresAt,omitempty"`
+ // Username of the MongoDB Cloud user who sent the invitation to join the organization.
+ // Read only field.
+ InviterUsername *string `json:"inviterUsername,omitempty"`
+ // Two-character alphabetical string that identifies the MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.
+ // Read only field.
+ Country *string `json:"country,omitempty"`
+ // Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.
+ // Read only field.
+ CreatedAt *time.Time `json:"createdAt,omitempty"`
+ // First or given name that belongs to the MongoDB Cloud user.
+ // Read only field.
+ FirstName *string `json:"firstName,omitempty"`
+ // Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
+ // Read only field.
+ LastAuth *time.Time `json:"lastAuth,omitempty"`
+ // Last name, family name, or surname that belongs to the MongoDB Cloud user.
+ // Read only field.
+ LastName *string `json:"lastName,omitempty"`
+ // Mobile phone number that belongs to the MongoDB Cloud user.
+ // Read only field.
+ MobileNumber *string `json:"mobileNumber,omitempty"`
+}
+
+// NewOrgUserResponse instantiates a new OrgUserResponse object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewOrgUserResponse(id string, orgMembershipStatus string, roles OrgUserRolesResponse, username string) *OrgUserResponse {
+ this := OrgUserResponse{}
+ this.Id = id
+ this.OrgMembershipStatus = orgMembershipStatus
+ this.Roles = roles
+ this.Username = username
+ return &this
+}
+
+// NewOrgUserResponseWithDefaults instantiates a new OrgUserResponse object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewOrgUserResponseWithDefaults() *OrgUserResponse {
+ this := OrgUserResponse{}
+ return &this
+}
+
+// GetId returns the Id field value
+func (o *OrgUserResponse) GetId() string {
+ if o == nil {
+ var ret string
+ return ret
+ }
+
+ return o.Id
+}
+
+// GetIdOk returns a tuple with the Id field value
+// and a boolean to check if the value has been set.
+func (o *OrgUserResponse) GetIdOk() (*string, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.Id, true
+}
+
+// SetId sets field value
+func (o *OrgUserResponse) SetId(v string) {
+ o.Id = v
+}
+
+// GetOrgMembershipStatus returns the OrgMembershipStatus field value
+func (o *OrgUserResponse) GetOrgMembershipStatus() string {
+ if o == nil {
+ var ret string
+ return ret
+ }
+
+ return o.OrgMembershipStatus
+}
+
+// GetOrgMembershipStatusOk returns a tuple with the OrgMembershipStatus field value
+// and a boolean to check if the value has been set.
+func (o *OrgUserResponse) GetOrgMembershipStatusOk() (*string, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.OrgMembershipStatus, true
+}
+
+// SetOrgMembershipStatus sets field value
+func (o *OrgUserResponse) SetOrgMembershipStatus(v string) {
+ o.OrgMembershipStatus = v
+}
+
+// GetRoles returns the Roles field value
+func (o *OrgUserResponse) GetRoles() OrgUserRolesResponse {
+ if o == nil {
+ var ret OrgUserRolesResponse
+ return ret
+ }
+
+ return o.Roles
+}
+
+// GetRolesOk returns a tuple with the Roles field value
+// and a boolean to check if the value has been set.
+func (o *OrgUserResponse) GetRolesOk() (*OrgUserRolesResponse, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.Roles, true
+}
+
+// SetRoles sets field value
+func (o *OrgUserResponse) SetRoles(v OrgUserRolesResponse) {
+ o.Roles = v
+}
+
+// GetTeamIds returns the TeamIds field value if set, zero value otherwise
+func (o *OrgUserResponse) GetTeamIds() []string {
+ if o == nil || IsNil(o.TeamIds) {
+ var ret []string
+ return ret
+ }
+ return *o.TeamIds
+}
+
+// GetTeamIdsOk returns a tuple with the TeamIds field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserResponse) GetTeamIdsOk() (*[]string, bool) {
+ if o == nil || IsNil(o.TeamIds) {
+ return nil, false
+ }
+
+ return o.TeamIds, true
+}
+
+// HasTeamIds returns a boolean if a field has been set.
+func (o *OrgUserResponse) HasTeamIds() bool {
+ if o != nil && !IsNil(o.TeamIds) {
+ return true
+ }
+
+ return false
+}
+
+// SetTeamIds gets a reference to the given []string and assigns it to the TeamIds field.
+func (o *OrgUserResponse) SetTeamIds(v []string) {
+ o.TeamIds = &v
+}
+
+// GetUsername returns the Username field value
+func (o *OrgUserResponse) GetUsername() string {
+ if o == nil {
+ var ret string
+ return ret
+ }
+
+ return o.Username
+}
+
+// GetUsernameOk returns a tuple with the Username field value
+// and a boolean to check if the value has been set.
+func (o *OrgUserResponse) GetUsernameOk() (*string, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.Username, true
+}
+
+// SetUsername sets field value
+func (o *OrgUserResponse) SetUsername(v string) {
+ o.Username = v
+}
+
+// GetInvitationCreatedAt returns the InvitationCreatedAt field value if set, zero value otherwise
+func (o *OrgUserResponse) GetInvitationCreatedAt() time.Time {
+ if o == nil || IsNil(o.InvitationCreatedAt) {
+ var ret time.Time
+ return ret
+ }
+ return *o.InvitationCreatedAt
+}
+
+// GetInvitationCreatedAtOk returns a tuple with the InvitationCreatedAt field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserResponse) GetInvitationCreatedAtOk() (*time.Time, bool) {
+ if o == nil || IsNil(o.InvitationCreatedAt) {
+ return nil, false
+ }
+
+ return o.InvitationCreatedAt, true
+}
+
+// HasInvitationCreatedAt returns a boolean if a field has been set.
+func (o *OrgUserResponse) HasInvitationCreatedAt() bool {
+ if o != nil && !IsNil(o.InvitationCreatedAt) {
+ return true
+ }
+
+ return false
+}
+
+// SetInvitationCreatedAt gets a reference to the given time.Time and assigns it to the InvitationCreatedAt field.
+func (o *OrgUserResponse) SetInvitationCreatedAt(v time.Time) {
+ o.InvitationCreatedAt = &v
+}
+
+// GetInvitationExpiresAt returns the InvitationExpiresAt field value if set, zero value otherwise
+func (o *OrgUserResponse) GetInvitationExpiresAt() time.Time {
+ if o == nil || IsNil(o.InvitationExpiresAt) {
+ var ret time.Time
+ return ret
+ }
+ return *o.InvitationExpiresAt
+}
+
+// GetInvitationExpiresAtOk returns a tuple with the InvitationExpiresAt field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserResponse) GetInvitationExpiresAtOk() (*time.Time, bool) {
+ if o == nil || IsNil(o.InvitationExpiresAt) {
+ return nil, false
+ }
+
+ return o.InvitationExpiresAt, true
+}
+
+// HasInvitationExpiresAt returns a boolean if a field has been set.
+func (o *OrgUserResponse) HasInvitationExpiresAt() bool {
+ if o != nil && !IsNil(o.InvitationExpiresAt) {
+ return true
+ }
+
+ return false
+}
+
+// SetInvitationExpiresAt gets a reference to the given time.Time and assigns it to the InvitationExpiresAt field.
+func (o *OrgUserResponse) SetInvitationExpiresAt(v time.Time) {
+ o.InvitationExpiresAt = &v
+}
+
+// GetInviterUsername returns the InviterUsername field value if set, zero value otherwise
+func (o *OrgUserResponse) GetInviterUsername() string {
+ if o == nil || IsNil(o.InviterUsername) {
+ var ret string
+ return ret
+ }
+ return *o.InviterUsername
+}
+
+// GetInviterUsernameOk returns a tuple with the InviterUsername field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserResponse) GetInviterUsernameOk() (*string, bool) {
+ if o == nil || IsNil(o.InviterUsername) {
+ return nil, false
+ }
+
+ return o.InviterUsername, true
+}
+
+// HasInviterUsername returns a boolean if a field has been set.
+func (o *OrgUserResponse) HasInviterUsername() bool {
+ if o != nil && !IsNil(o.InviterUsername) {
+ return true
+ }
+
+ return false
+}
+
+// SetInviterUsername gets a reference to the given string and assigns it to the InviterUsername field.
+func (o *OrgUserResponse) SetInviterUsername(v string) {
+ o.InviterUsername = &v
+}
+
+// GetCountry returns the Country field value if set, zero value otherwise
+func (o *OrgUserResponse) GetCountry() string {
+ if o == nil || IsNil(o.Country) {
+ var ret string
+ return ret
+ }
+ return *o.Country
+}
+
+// GetCountryOk returns a tuple with the Country field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserResponse) GetCountryOk() (*string, bool) {
+ if o == nil || IsNil(o.Country) {
+ return nil, false
+ }
+
+ return o.Country, true
+}
+
+// HasCountry returns a boolean if a field has been set.
+func (o *OrgUserResponse) HasCountry() bool {
+ if o != nil && !IsNil(o.Country) {
+ return true
+ }
+
+ return false
+}
+
+// SetCountry gets a reference to the given string and assigns it to the Country field.
+func (o *OrgUserResponse) SetCountry(v string) {
+ o.Country = &v
+}
+
+// GetCreatedAt returns the CreatedAt field value if set, zero value otherwise
+func (o *OrgUserResponse) GetCreatedAt() time.Time {
+ if o == nil || IsNil(o.CreatedAt) {
+ var ret time.Time
+ return ret
+ }
+ return *o.CreatedAt
+}
+
+// GetCreatedAtOk returns a tuple with the CreatedAt field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserResponse) GetCreatedAtOk() (*time.Time, bool) {
+ if o == nil || IsNil(o.CreatedAt) {
+ return nil, false
+ }
+
+ return o.CreatedAt, true
+}
+
+// HasCreatedAt returns a boolean if a field has been set.
+func (o *OrgUserResponse) HasCreatedAt() bool {
+ if o != nil && !IsNil(o.CreatedAt) {
+ return true
+ }
+
+ return false
+}
+
+// SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.
+func (o *OrgUserResponse) SetCreatedAt(v time.Time) {
+ o.CreatedAt = &v
+}
+
+// GetFirstName returns the FirstName field value if set, zero value otherwise
+func (o *OrgUserResponse) GetFirstName() string {
+ if o == nil || IsNil(o.FirstName) {
+ var ret string
+ return ret
+ }
+ return *o.FirstName
+}
+
+// GetFirstNameOk returns a tuple with the FirstName field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserResponse) GetFirstNameOk() (*string, bool) {
+ if o == nil || IsNil(o.FirstName) {
+ return nil, false
+ }
+
+ return o.FirstName, true
+}
+
+// HasFirstName returns a boolean if a field has been set.
+func (o *OrgUserResponse) HasFirstName() bool {
+ if o != nil && !IsNil(o.FirstName) {
+ return true
+ }
+
+ return false
+}
+
+// SetFirstName gets a reference to the given string and assigns it to the FirstName field.
+func (o *OrgUserResponse) SetFirstName(v string) {
+ o.FirstName = &v
+}
+
+// GetLastAuth returns the LastAuth field value if set, zero value otherwise
+func (o *OrgUserResponse) GetLastAuth() time.Time {
+ if o == nil || IsNil(o.LastAuth) {
+ var ret time.Time
+ return ret
+ }
+ return *o.LastAuth
+}
+
+// GetLastAuthOk returns a tuple with the LastAuth field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserResponse) GetLastAuthOk() (*time.Time, bool) {
+ if o == nil || IsNil(o.LastAuth) {
+ return nil, false
+ }
+
+ return o.LastAuth, true
+}
+
+// HasLastAuth returns a boolean if a field has been set.
+func (o *OrgUserResponse) HasLastAuth() bool {
+ if o != nil && !IsNil(o.LastAuth) {
+ return true
+ }
+
+ return false
+}
+
+// SetLastAuth gets a reference to the given time.Time and assigns it to the LastAuth field.
+func (o *OrgUserResponse) SetLastAuth(v time.Time) {
+ o.LastAuth = &v
+}
+
+// GetLastName returns the LastName field value if set, zero value otherwise
+func (o *OrgUserResponse) GetLastName() string {
+ if o == nil || IsNil(o.LastName) {
+ var ret string
+ return ret
+ }
+ return *o.LastName
+}
+
+// GetLastNameOk returns a tuple with the LastName field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserResponse) GetLastNameOk() (*string, bool) {
+ if o == nil || IsNil(o.LastName) {
+ return nil, false
+ }
+
+ return o.LastName, true
+}
+
+// HasLastName returns a boolean if a field has been set.
+func (o *OrgUserResponse) HasLastName() bool {
+ if o != nil && !IsNil(o.LastName) {
+ return true
+ }
+
+ return false
+}
+
+// SetLastName gets a reference to the given string and assigns it to the LastName field.
+func (o *OrgUserResponse) SetLastName(v string) {
+ o.LastName = &v
+}
+
+// GetMobileNumber returns the MobileNumber field value if set, zero value otherwise
+func (o *OrgUserResponse) GetMobileNumber() string {
+ if o == nil || IsNil(o.MobileNumber) {
+ var ret string
+ return ret
+ }
+ return *o.MobileNumber
+}
+
+// GetMobileNumberOk returns a tuple with the MobileNumber field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserResponse) GetMobileNumberOk() (*string, bool) {
+ if o == nil || IsNil(o.MobileNumber) {
+ return nil, false
+ }
+
+ return o.MobileNumber, true
+}
+
+// HasMobileNumber returns a boolean if a field has been set.
+func (o *OrgUserResponse) HasMobileNumber() bool {
+ if o != nil && !IsNil(o.MobileNumber) {
+ return true
+ }
+
+ return false
+}
+
+// SetMobileNumber gets a reference to the given string and assigns it to the MobileNumber field.
+func (o *OrgUserResponse) SetMobileNumber(v string) {
+ o.MobileNumber = &v
+}
diff --git a/admin/model_org_user_roles_request.go b/admin/model_org_user_roles_request.go
new file mode 100644
index 000000000..f8fd53f70
--- /dev/null
+++ b/admin/model_org_user_roles_request.go
@@ -0,0 +1,86 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// OrgUserRolesRequest Organization and project level roles to assign the MongoDB Cloud user within one organization.
+type OrgUserRolesRequest struct {
+ // List of project level role assignments to assign the MongoDB Cloud user.
+ GroupRoleAssignments *[]GroupRoleAssignment `json:"groupRoleAssignments,omitempty"`
+ // One or more organization level roles to assign the MongoDB Cloud user.
+ OrgRoles []string `json:"orgRoles"`
+}
+
+// NewOrgUserRolesRequest instantiates a new OrgUserRolesRequest object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewOrgUserRolesRequest(orgRoles []string) *OrgUserRolesRequest {
+ this := OrgUserRolesRequest{}
+ this.OrgRoles = orgRoles
+ return &this
+}
+
+// NewOrgUserRolesRequestWithDefaults instantiates a new OrgUserRolesRequest object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewOrgUserRolesRequestWithDefaults() *OrgUserRolesRequest {
+ this := OrgUserRolesRequest{}
+ return &this
+}
+
+// GetGroupRoleAssignments returns the GroupRoleAssignments field value if set, zero value otherwise
+func (o *OrgUserRolesRequest) GetGroupRoleAssignments() []GroupRoleAssignment {
+ if o == nil || IsNil(o.GroupRoleAssignments) {
+ var ret []GroupRoleAssignment
+ return ret
+ }
+ return *o.GroupRoleAssignments
+}
+
+// GetGroupRoleAssignmentsOk returns a tuple with the GroupRoleAssignments field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserRolesRequest) GetGroupRoleAssignmentsOk() (*[]GroupRoleAssignment, bool) {
+ if o == nil || IsNil(o.GroupRoleAssignments) {
+ return nil, false
+ }
+
+ return o.GroupRoleAssignments, true
+}
+
+// HasGroupRoleAssignments returns a boolean if a field has been set.
+func (o *OrgUserRolesRequest) HasGroupRoleAssignments() bool {
+ if o != nil && !IsNil(o.GroupRoleAssignments) {
+ return true
+ }
+
+ return false
+}
+
+// SetGroupRoleAssignments gets a reference to the given []GroupRoleAssignment and assigns it to the GroupRoleAssignments field.
+func (o *OrgUserRolesRequest) SetGroupRoleAssignments(v []GroupRoleAssignment) {
+ o.GroupRoleAssignments = &v
+}
+
+// GetOrgRoles returns the OrgRoles field value
+func (o *OrgUserRolesRequest) GetOrgRoles() []string {
+ if o == nil {
+ var ret []string
+ return ret
+ }
+
+ return o.OrgRoles
+}
+
+// GetOrgRolesOk returns a tuple with the OrgRoles field value
+// and a boolean to check if the value has been set.
+func (o *OrgUserRolesRequest) GetOrgRolesOk() (*[]string, bool) {
+ if o == nil {
+ return nil, false
+ }
+ return &o.OrgRoles, true
+}
+
+// SetOrgRoles sets field value
+func (o *OrgUserRolesRequest) SetOrgRoles(v []string) {
+ o.OrgRoles = v
+}
diff --git a/admin/model_org_user_roles_response.go b/admin/model_org_user_roles_response.go
new file mode 100644
index 000000000..2a0e020b6
--- /dev/null
+++ b/admin/model_org_user_roles_response.go
@@ -0,0 +1,94 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// OrgUserRolesResponse Organization- and project-level roles assigned to one MongoDB Cloud user within one organization.
+type OrgUserRolesResponse struct {
+ // List of project-level role assignments assigned to the MongoDB Cloud user.
+ GroupRoleAssignments *[]GroupRoleAssignment `json:"groupRoleAssignments,omitempty"`
+ // One or more organization-level roles assigned to the MongoDB Cloud user.
+ OrgRoles *[]string `json:"orgRoles,omitempty"`
+}
+
+// NewOrgUserRolesResponse instantiates a new OrgUserRolesResponse object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewOrgUserRolesResponse() *OrgUserRolesResponse {
+ this := OrgUserRolesResponse{}
+ return &this
+}
+
+// NewOrgUserRolesResponseWithDefaults instantiates a new OrgUserRolesResponse object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewOrgUserRolesResponseWithDefaults() *OrgUserRolesResponse {
+ this := OrgUserRolesResponse{}
+ return &this
+}
+
+// GetGroupRoleAssignments returns the GroupRoleAssignments field value if set, zero value otherwise
+func (o *OrgUserRolesResponse) GetGroupRoleAssignments() []GroupRoleAssignment {
+ if o == nil || IsNil(o.GroupRoleAssignments) {
+ var ret []GroupRoleAssignment
+ return ret
+ }
+ return *o.GroupRoleAssignments
+}
+
+// GetGroupRoleAssignmentsOk returns a tuple with the GroupRoleAssignments field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserRolesResponse) GetGroupRoleAssignmentsOk() (*[]GroupRoleAssignment, bool) {
+ if o == nil || IsNil(o.GroupRoleAssignments) {
+ return nil, false
+ }
+
+ return o.GroupRoleAssignments, true
+}
+
+// HasGroupRoleAssignments returns a boolean if a field has been set.
+func (o *OrgUserRolesResponse) HasGroupRoleAssignments() bool {
+ if o != nil && !IsNil(o.GroupRoleAssignments) {
+ return true
+ }
+
+ return false
+}
+
+// SetGroupRoleAssignments gets a reference to the given []GroupRoleAssignment and assigns it to the GroupRoleAssignments field.
+func (o *OrgUserRolesResponse) SetGroupRoleAssignments(v []GroupRoleAssignment) {
+ o.GroupRoleAssignments = &v
+}
+
+// GetOrgRoles returns the OrgRoles field value if set, zero value otherwise
+func (o *OrgUserRolesResponse) GetOrgRoles() []string {
+ if o == nil || IsNil(o.OrgRoles) {
+ var ret []string
+ return ret
+ }
+ return *o.OrgRoles
+}
+
+// GetOrgRolesOk returns a tuple with the OrgRoles field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserRolesResponse) GetOrgRolesOk() (*[]string, bool) {
+ if o == nil || IsNil(o.OrgRoles) {
+ return nil, false
+ }
+
+ return o.OrgRoles, true
+}
+
+// HasOrgRoles returns a boolean if a field has been set.
+func (o *OrgUserRolesResponse) HasOrgRoles() bool {
+ if o != nil && !IsNil(o.OrgRoles) {
+ return true
+ }
+
+ return false
+}
+
+// SetOrgRoles gets a reference to the given []string and assigns it to the OrgRoles field.
+func (o *OrgUserRolesResponse) SetOrgRoles(v []string) {
+ o.OrgRoles = &v
+}
diff --git a/admin/model_org_user_update_request.go b/admin/model_org_user_update_request.go
new file mode 100644
index 000000000..9044b4aa3
--- /dev/null
+++ b/admin/model_org_user_update_request.go
@@ -0,0 +1,94 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// OrgUserUpdateRequest struct for OrgUserUpdateRequest
+type OrgUserUpdateRequest struct {
+ Roles *OrgUserRolesRequest `json:"roles,omitempty"`
+ // List of unique 24-hexadecimal digit strings that identifies the teams to assign the MongoDB Cloud user.
+ // Write only field.
+ TeamIds *[]string `json:"teamIds,omitempty"`
+}
+
+// NewOrgUserUpdateRequest instantiates a new OrgUserUpdateRequest object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewOrgUserUpdateRequest() *OrgUserUpdateRequest {
+ this := OrgUserUpdateRequest{}
+ return &this
+}
+
+// NewOrgUserUpdateRequestWithDefaults instantiates a new OrgUserUpdateRequest object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewOrgUserUpdateRequestWithDefaults() *OrgUserUpdateRequest {
+ this := OrgUserUpdateRequest{}
+ return &this
+}
+
+// GetRoles returns the Roles field value if set, zero value otherwise
+func (o *OrgUserUpdateRequest) GetRoles() OrgUserRolesRequest {
+ if o == nil || IsNil(o.Roles) {
+ var ret OrgUserRolesRequest
+ return ret
+ }
+ return *o.Roles
+}
+
+// GetRolesOk returns a tuple with the Roles field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserUpdateRequest) GetRolesOk() (*OrgUserRolesRequest, bool) {
+ if o == nil || IsNil(o.Roles) {
+ return nil, false
+ }
+
+ return o.Roles, true
+}
+
+// HasRoles returns a boolean if a field has been set.
+func (o *OrgUserUpdateRequest) HasRoles() bool {
+ if o != nil && !IsNil(o.Roles) {
+ return true
+ }
+
+ return false
+}
+
+// SetRoles gets a reference to the given OrgUserRolesRequest and assigns it to the Roles field.
+func (o *OrgUserUpdateRequest) SetRoles(v OrgUserRolesRequest) {
+ o.Roles = &v
+}
+
+// GetTeamIds returns the TeamIds field value if set, zero value otherwise
+func (o *OrgUserUpdateRequest) GetTeamIds() []string {
+ if o == nil || IsNil(o.TeamIds) {
+ var ret []string
+ return ret
+ }
+ return *o.TeamIds
+}
+
+// GetTeamIdsOk returns a tuple with the TeamIds field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *OrgUserUpdateRequest) GetTeamIdsOk() (*[]string, bool) {
+ if o == nil || IsNil(o.TeamIds) {
+ return nil, false
+ }
+
+ return o.TeamIds, true
+}
+
+// HasTeamIds returns a boolean if a field has been set.
+func (o *OrgUserUpdateRequest) HasTeamIds() bool {
+ if o != nil && !IsNil(o.TeamIds) {
+ return true
+ }
+
+ return false
+}
+
+// SetTeamIds gets a reference to the given []string and assigns it to the TeamIds field.
+func (o *OrgUserUpdateRequest) SetTeamIds(v []string) {
+ o.TeamIds = &v
+}
diff --git a/admin/model_paginated_api_versions.go b/admin/model_paginated_api_versions.go
new file mode 100644
index 000000000..d4f90a4f4
--- /dev/null
+++ b/admin/model_paginated_api_versions.go
@@ -0,0 +1,132 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// PaginatedApiVersions struct for PaginatedApiVersions
+type PaginatedApiVersions struct {
+ // 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.
+ // Read only field.
+ Links *[]Link `json:"links,omitempty"`
+ // List of returned documents that MongoDB Cloud provides when completing this request.
+ // Read only field.
+ Results *[]ApiVersion `json:"results,omitempty"`
+ // 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.
+ // Read only field.
+ TotalCount *int `json:"totalCount,omitempty"`
+}
+
+// NewPaginatedApiVersions instantiates a new PaginatedApiVersions object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewPaginatedApiVersions() *PaginatedApiVersions {
+ this := PaginatedApiVersions{}
+ return &this
+}
+
+// NewPaginatedApiVersionsWithDefaults instantiates a new PaginatedApiVersions object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewPaginatedApiVersionsWithDefaults() *PaginatedApiVersions {
+ this := PaginatedApiVersions{}
+ return &this
+}
+
+// GetLinks returns the Links field value if set, zero value otherwise
+func (o *PaginatedApiVersions) GetLinks() []Link {
+ if o == nil || IsNil(o.Links) {
+ var ret []Link
+ return ret
+ }
+ return *o.Links
+}
+
+// GetLinksOk returns a tuple with the Links field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *PaginatedApiVersions) GetLinksOk() (*[]Link, bool) {
+ if o == nil || IsNil(o.Links) {
+ return nil, false
+ }
+
+ return o.Links, true
+}
+
+// HasLinks returns a boolean if a field has been set.
+func (o *PaginatedApiVersions) HasLinks() bool {
+ if o != nil && !IsNil(o.Links) {
+ return true
+ }
+
+ return false
+}
+
+// SetLinks gets a reference to the given []Link and assigns it to the Links field.
+func (o *PaginatedApiVersions) SetLinks(v []Link) {
+ o.Links = &v
+}
+
+// GetResults returns the Results field value if set, zero value otherwise
+func (o *PaginatedApiVersions) GetResults() []ApiVersion {
+ if o == nil || IsNil(o.Results) {
+ var ret []ApiVersion
+ return ret
+ }
+ return *o.Results
+}
+
+// GetResultsOk returns a tuple with the Results field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *PaginatedApiVersions) GetResultsOk() (*[]ApiVersion, bool) {
+ if o == nil || IsNil(o.Results) {
+ return nil, false
+ }
+
+ return o.Results, true
+}
+
+// HasResults returns a boolean if a field has been set.
+func (o *PaginatedApiVersions) HasResults() bool {
+ if o != nil && !IsNil(o.Results) {
+ return true
+ }
+
+ return false
+}
+
+// SetResults gets a reference to the given []ApiVersion and assigns it to the Results field.
+func (o *PaginatedApiVersions) SetResults(v []ApiVersion) {
+ o.Results = &v
+}
+
+// GetTotalCount returns the TotalCount field value if set, zero value otherwise
+func (o *PaginatedApiVersions) GetTotalCount() int {
+ if o == nil || IsNil(o.TotalCount) {
+ var ret int
+ return ret
+ }
+ return *o.TotalCount
+}
+
+// GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *PaginatedApiVersions) GetTotalCountOk() (*int, bool) {
+ if o == nil || IsNil(o.TotalCount) {
+ return nil, false
+ }
+
+ return o.TotalCount, true
+}
+
+// HasTotalCount returns a boolean if a field has been set.
+func (o *PaginatedApiVersions) HasTotalCount() bool {
+ if o != nil && !IsNil(o.TotalCount) {
+ return true
+ }
+
+ return false
+}
+
+// SetTotalCount gets a reference to the given int and assigns it to the TotalCount field.
+func (o *PaginatedApiVersions) SetTotalCount(v int) {
+ o.TotalCount = &v
+}
diff --git a/admin/model_paginated_group_user.go b/admin/model_paginated_group_user.go
new file mode 100644
index 000000000..5f0facd9b
--- /dev/null
+++ b/admin/model_paginated_group_user.go
@@ -0,0 +1,132 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// PaginatedGroupUser struct for PaginatedGroupUser
+type PaginatedGroupUser struct {
+ // 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.
+ // Read only field.
+ Links *[]Link `json:"links,omitempty"`
+ // List of returned documents that MongoDB Cloud provides when completing this request.
+ // Read only field.
+ Results *[]GroupUserResponse `json:"results,omitempty"`
+ // 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.
+ // Read only field.
+ TotalCount *int `json:"totalCount,omitempty"`
+}
+
+// NewPaginatedGroupUser instantiates a new PaginatedGroupUser object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewPaginatedGroupUser() *PaginatedGroupUser {
+ this := PaginatedGroupUser{}
+ return &this
+}
+
+// NewPaginatedGroupUserWithDefaults instantiates a new PaginatedGroupUser object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewPaginatedGroupUserWithDefaults() *PaginatedGroupUser {
+ this := PaginatedGroupUser{}
+ return &this
+}
+
+// GetLinks returns the Links field value if set, zero value otherwise
+func (o *PaginatedGroupUser) GetLinks() []Link {
+ if o == nil || IsNil(o.Links) {
+ var ret []Link
+ return ret
+ }
+ return *o.Links
+}
+
+// GetLinksOk returns a tuple with the Links field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *PaginatedGroupUser) GetLinksOk() (*[]Link, bool) {
+ if o == nil || IsNil(o.Links) {
+ return nil, false
+ }
+
+ return o.Links, true
+}
+
+// HasLinks returns a boolean if a field has been set.
+func (o *PaginatedGroupUser) HasLinks() bool {
+ if o != nil && !IsNil(o.Links) {
+ return true
+ }
+
+ return false
+}
+
+// SetLinks gets a reference to the given []Link and assigns it to the Links field.
+func (o *PaginatedGroupUser) SetLinks(v []Link) {
+ o.Links = &v
+}
+
+// GetResults returns the Results field value if set, zero value otherwise
+func (o *PaginatedGroupUser) GetResults() []GroupUserResponse {
+ if o == nil || IsNil(o.Results) {
+ var ret []GroupUserResponse
+ return ret
+ }
+ return *o.Results
+}
+
+// GetResultsOk returns a tuple with the Results field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *PaginatedGroupUser) GetResultsOk() (*[]GroupUserResponse, bool) {
+ if o == nil || IsNil(o.Results) {
+ return nil, false
+ }
+
+ return o.Results, true
+}
+
+// HasResults returns a boolean if a field has been set.
+func (o *PaginatedGroupUser) HasResults() bool {
+ if o != nil && !IsNil(o.Results) {
+ return true
+ }
+
+ return false
+}
+
+// SetResults gets a reference to the given []GroupUserResponse and assigns it to the Results field.
+func (o *PaginatedGroupUser) SetResults(v []GroupUserResponse) {
+ o.Results = &v
+}
+
+// GetTotalCount returns the TotalCount field value if set, zero value otherwise
+func (o *PaginatedGroupUser) GetTotalCount() int {
+ if o == nil || IsNil(o.TotalCount) {
+ var ret int
+ return ret
+ }
+ return *o.TotalCount
+}
+
+// GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *PaginatedGroupUser) GetTotalCountOk() (*int, bool) {
+ if o == nil || IsNil(o.TotalCount) {
+ return nil, false
+ }
+
+ return o.TotalCount, true
+}
+
+// HasTotalCount returns a boolean if a field has been set.
+func (o *PaginatedGroupUser) HasTotalCount() bool {
+ if o != nil && !IsNil(o.TotalCount) {
+ return true
+ }
+
+ return false
+}
+
+// SetTotalCount gets a reference to the given int and assigns it to the TotalCount field.
+func (o *PaginatedGroupUser) SetTotalCount(v int) {
+ o.TotalCount = &v
+}
diff --git a/admin/model_paginated_app_user.go b/admin/model_paginated_org_user.go
similarity index 69%
rename from admin/model_paginated_app_user.go
rename to admin/model_paginated_org_user.go
index b618675ee..aecbdce4b 100644
--- a/admin/model_paginated_app_user.go
+++ b/admin/model_paginated_org_user.go
@@ -2,38 +2,38 @@
package admin
-// PaginatedAppUser struct for PaginatedAppUser
-type PaginatedAppUser struct {
+// PaginatedOrgUser struct for PaginatedOrgUser
+type PaginatedOrgUser struct {
// 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.
// Read only field.
Links *[]Link `json:"links,omitempty"`
// List of returned documents that MongoDB Cloud provides when completing this request.
// Read only field.
- Results *[]CloudAppUser `json:"results,omitempty"`
+ Results *[]OrgUserResponse `json:"results,omitempty"`
// 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.
// Read only field.
TotalCount *int `json:"totalCount,omitempty"`
}
-// NewPaginatedAppUser instantiates a new PaginatedAppUser object
+// NewPaginatedOrgUser instantiates a new PaginatedOrgUser object
// This constructor will assign default values to properties that have it defined,
// and makes sure properties required by API are set, but the set of arguments
// will change when the set of required properties is changed
-func NewPaginatedAppUser() *PaginatedAppUser {
- this := PaginatedAppUser{}
+func NewPaginatedOrgUser() *PaginatedOrgUser {
+ this := PaginatedOrgUser{}
return &this
}
-// NewPaginatedAppUserWithDefaults instantiates a new PaginatedAppUser object
+// NewPaginatedOrgUserWithDefaults instantiates a new PaginatedOrgUser object
// This constructor will only assign default values to properties that have it defined,
// but it doesn't guarantee that properties required by API are set
-func NewPaginatedAppUserWithDefaults() *PaginatedAppUser {
- this := PaginatedAppUser{}
+func NewPaginatedOrgUserWithDefaults() *PaginatedOrgUser {
+ this := PaginatedOrgUser{}
return &this
}
// GetLinks returns the Links field value if set, zero value otherwise
-func (o *PaginatedAppUser) GetLinks() []Link {
+func (o *PaginatedOrgUser) GetLinks() []Link {
if o == nil || IsNil(o.Links) {
var ret []Link
return ret
@@ -43,7 +43,7 @@ func (o *PaginatedAppUser) GetLinks() []Link {
// GetLinksOk returns a tuple with the Links field value if set, nil otherwise
// and a boolean to check if the value has been set.
-func (o *PaginatedAppUser) GetLinksOk() (*[]Link, bool) {
+func (o *PaginatedOrgUser) GetLinksOk() (*[]Link, bool) {
if o == nil || IsNil(o.Links) {
return nil, false
}
@@ -52,7 +52,7 @@ func (o *PaginatedAppUser) GetLinksOk() (*[]Link, bool) {
}
// HasLinks returns a boolean if a field has been set.
-func (o *PaginatedAppUser) HasLinks() bool {
+func (o *PaginatedOrgUser) HasLinks() bool {
if o != nil && !IsNil(o.Links) {
return true
}
@@ -61,14 +61,14 @@ func (o *PaginatedAppUser) HasLinks() bool {
}
// SetLinks gets a reference to the given []Link and assigns it to the Links field.
-func (o *PaginatedAppUser) SetLinks(v []Link) {
+func (o *PaginatedOrgUser) SetLinks(v []Link) {
o.Links = &v
}
// GetResults returns the Results field value if set, zero value otherwise
-func (o *PaginatedAppUser) GetResults() []CloudAppUser {
+func (o *PaginatedOrgUser) GetResults() []OrgUserResponse {
if o == nil || IsNil(o.Results) {
- var ret []CloudAppUser
+ var ret []OrgUserResponse
return ret
}
return *o.Results
@@ -76,7 +76,7 @@ func (o *PaginatedAppUser) GetResults() []CloudAppUser {
// GetResultsOk returns a tuple with the Results field value if set, nil otherwise
// and a boolean to check if the value has been set.
-func (o *PaginatedAppUser) GetResultsOk() (*[]CloudAppUser, bool) {
+func (o *PaginatedOrgUser) GetResultsOk() (*[]OrgUserResponse, bool) {
if o == nil || IsNil(o.Results) {
return nil, false
}
@@ -85,7 +85,7 @@ func (o *PaginatedAppUser) GetResultsOk() (*[]CloudAppUser, bool) {
}
// HasResults returns a boolean if a field has been set.
-func (o *PaginatedAppUser) HasResults() bool {
+func (o *PaginatedOrgUser) HasResults() bool {
if o != nil && !IsNil(o.Results) {
return true
}
@@ -93,13 +93,13 @@ func (o *PaginatedAppUser) HasResults() bool {
return false
}
-// SetResults gets a reference to the given []CloudAppUser and assigns it to the Results field.
-func (o *PaginatedAppUser) SetResults(v []CloudAppUser) {
+// SetResults gets a reference to the given []OrgUserResponse and assigns it to the Results field.
+func (o *PaginatedOrgUser) SetResults(v []OrgUserResponse) {
o.Results = &v
}
// GetTotalCount returns the TotalCount field value if set, zero value otherwise
-func (o *PaginatedAppUser) GetTotalCount() int {
+func (o *PaginatedOrgUser) GetTotalCount() int {
if o == nil || IsNil(o.TotalCount) {
var ret int
return ret
@@ -109,7 +109,7 @@ func (o *PaginatedAppUser) GetTotalCount() int {
// GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise
// and a boolean to check if the value has been set.
-func (o *PaginatedAppUser) GetTotalCountOk() (*int, bool) {
+func (o *PaginatedOrgUser) GetTotalCountOk() (*int, bool) {
if o == nil || IsNil(o.TotalCount) {
return nil, false
}
@@ -118,7 +118,7 @@ func (o *PaginatedAppUser) GetTotalCountOk() (*int, bool) {
}
// HasTotalCount returns a boolean if a field has been set.
-func (o *PaginatedAppUser) HasTotalCount() bool {
+func (o *PaginatedOrgUser) HasTotalCount() bool {
if o != nil && !IsNil(o.TotalCount) {
return true
}
@@ -127,6 +127,6 @@ func (o *PaginatedAppUser) HasTotalCount() bool {
}
// SetTotalCount gets a reference to the given int and assigns it to the TotalCount field.
-func (o *PaginatedAppUser) SetTotalCount(v int) {
+func (o *PaginatedOrgUser) SetTotalCount(v int) {
o.TotalCount = &v
}
diff --git a/admin/model_raw.go b/admin/model_raw.go
index 2c9e9522d..ce6b47e7b 100644
--- a/admin/model_raw.go
+++ b/admin/model_raw.go
@@ -16,7 +16,7 @@ type Raw struct {
// Unique 24-hexadecimal digit string that identifies the project in which the event occurred.
// Read only field.
Cid *string `json:"cid,omitempty"`
- // Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
+ // Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
// Read only field.
Cre *time.Time `json:"cre,omitempty"`
// Description of the event.
diff --git a/admin/model_schema_advisor_item_recommendation.go b/admin/model_schema_advisor_item_recommendation.go
new file mode 100644
index 000000000..a90269699
--- /dev/null
+++ b/admin/model_schema_advisor_item_recommendation.go
@@ -0,0 +1,132 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// SchemaAdvisorItemRecommendation struct for SchemaAdvisorItemRecommendation
+type SchemaAdvisorItemRecommendation struct {
+ // List that contains the namespaces and information on why those namespaces triggered the recommendation.
+ // Read only field.
+ AffectedNamespaces *[]SchemaAdvisorNamespaceTriggers `json:"affectedNamespaces,omitempty"`
+ // Description of the specified recommendation.
+ // Read only field.
+ Description *string `json:"description,omitempty"`
+ // Type of recommendation.
+ // Read only field.
+ Recommendation *string `json:"recommendation,omitempty"`
+}
+
+// NewSchemaAdvisorItemRecommendation instantiates a new SchemaAdvisorItemRecommendation object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewSchemaAdvisorItemRecommendation() *SchemaAdvisorItemRecommendation {
+ this := SchemaAdvisorItemRecommendation{}
+ return &this
+}
+
+// NewSchemaAdvisorItemRecommendationWithDefaults instantiates a new SchemaAdvisorItemRecommendation object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewSchemaAdvisorItemRecommendationWithDefaults() *SchemaAdvisorItemRecommendation {
+ this := SchemaAdvisorItemRecommendation{}
+ return &this
+}
+
+// GetAffectedNamespaces returns the AffectedNamespaces field value if set, zero value otherwise
+func (o *SchemaAdvisorItemRecommendation) GetAffectedNamespaces() []SchemaAdvisorNamespaceTriggers {
+ if o == nil || IsNil(o.AffectedNamespaces) {
+ var ret []SchemaAdvisorNamespaceTriggers
+ return ret
+ }
+ return *o.AffectedNamespaces
+}
+
+// GetAffectedNamespacesOk returns a tuple with the AffectedNamespaces field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *SchemaAdvisorItemRecommendation) GetAffectedNamespacesOk() (*[]SchemaAdvisorNamespaceTriggers, bool) {
+ if o == nil || IsNil(o.AffectedNamespaces) {
+ return nil, false
+ }
+
+ return o.AffectedNamespaces, true
+}
+
+// HasAffectedNamespaces returns a boolean if a field has been set.
+func (o *SchemaAdvisorItemRecommendation) HasAffectedNamespaces() bool {
+ if o != nil && !IsNil(o.AffectedNamespaces) {
+ return true
+ }
+
+ return false
+}
+
+// SetAffectedNamespaces gets a reference to the given []SchemaAdvisorNamespaceTriggers and assigns it to the AffectedNamespaces field.
+func (o *SchemaAdvisorItemRecommendation) SetAffectedNamespaces(v []SchemaAdvisorNamespaceTriggers) {
+ o.AffectedNamespaces = &v
+}
+
+// GetDescription returns the Description field value if set, zero value otherwise
+func (o *SchemaAdvisorItemRecommendation) GetDescription() string {
+ if o == nil || IsNil(o.Description) {
+ var ret string
+ return ret
+ }
+ return *o.Description
+}
+
+// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *SchemaAdvisorItemRecommendation) GetDescriptionOk() (*string, bool) {
+ if o == nil || IsNil(o.Description) {
+ return nil, false
+ }
+
+ return o.Description, true
+}
+
+// HasDescription returns a boolean if a field has been set.
+func (o *SchemaAdvisorItemRecommendation) HasDescription() bool {
+ if o != nil && !IsNil(o.Description) {
+ return true
+ }
+
+ return false
+}
+
+// SetDescription gets a reference to the given string and assigns it to the Description field.
+func (o *SchemaAdvisorItemRecommendation) SetDescription(v string) {
+ o.Description = &v
+}
+
+// GetRecommendation returns the Recommendation field value if set, zero value otherwise
+func (o *SchemaAdvisorItemRecommendation) GetRecommendation() string {
+ if o == nil || IsNil(o.Recommendation) {
+ var ret string
+ return ret
+ }
+ return *o.Recommendation
+}
+
+// GetRecommendationOk returns a tuple with the Recommendation field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *SchemaAdvisorItemRecommendation) GetRecommendationOk() (*string, bool) {
+ if o == nil || IsNil(o.Recommendation) {
+ return nil, false
+ }
+
+ return o.Recommendation, true
+}
+
+// HasRecommendation returns a boolean if a field has been set.
+func (o *SchemaAdvisorItemRecommendation) HasRecommendation() bool {
+ if o != nil && !IsNil(o.Recommendation) {
+ return true
+ }
+
+ return false
+}
+
+// SetRecommendation gets a reference to the given string and assigns it to the Recommendation field.
+func (o *SchemaAdvisorItemRecommendation) SetRecommendation(v string) {
+ o.Recommendation = &v
+}
diff --git a/admin/model_schema_advisor_namespace_triggers.go b/admin/model_schema_advisor_namespace_triggers.go
new file mode 100644
index 000000000..0636ba63b
--- /dev/null
+++ b/admin/model_schema_advisor_namespace_triggers.go
@@ -0,0 +1,96 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// SchemaAdvisorNamespaceTriggers struct for SchemaAdvisorNamespaceTriggers
+type SchemaAdvisorNamespaceTriggers struct {
+ // Namespace of the affected collection. Will be null for REDUCE_NUMBER_OF_NAMESPACE recommendation.
+ // Read only field.
+ Namespace *string `json:"namespace,omitempty"`
+ // List of triggers that specify why the collection activated the recommendation.
+ // Read only field.
+ Triggers *[]SchemaAdvisorTriggerDetails `json:"triggers,omitempty"`
+}
+
+// NewSchemaAdvisorNamespaceTriggers instantiates a new SchemaAdvisorNamespaceTriggers object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewSchemaAdvisorNamespaceTriggers() *SchemaAdvisorNamespaceTriggers {
+ this := SchemaAdvisorNamespaceTriggers{}
+ return &this
+}
+
+// NewSchemaAdvisorNamespaceTriggersWithDefaults instantiates a new SchemaAdvisorNamespaceTriggers object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewSchemaAdvisorNamespaceTriggersWithDefaults() *SchemaAdvisorNamespaceTriggers {
+ this := SchemaAdvisorNamespaceTriggers{}
+ return &this
+}
+
+// GetNamespace returns the Namespace field value if set, zero value otherwise
+func (o *SchemaAdvisorNamespaceTriggers) GetNamespace() string {
+ if o == nil || IsNil(o.Namespace) {
+ var ret string
+ return ret
+ }
+ return *o.Namespace
+}
+
+// GetNamespaceOk returns a tuple with the Namespace field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *SchemaAdvisorNamespaceTriggers) GetNamespaceOk() (*string, bool) {
+ if o == nil || IsNil(o.Namespace) {
+ return nil, false
+ }
+
+ return o.Namespace, true
+}
+
+// HasNamespace returns a boolean if a field has been set.
+func (o *SchemaAdvisorNamespaceTriggers) HasNamespace() bool {
+ if o != nil && !IsNil(o.Namespace) {
+ return true
+ }
+
+ return false
+}
+
+// SetNamespace gets a reference to the given string and assigns it to the Namespace field.
+func (o *SchemaAdvisorNamespaceTriggers) SetNamespace(v string) {
+ o.Namespace = &v
+}
+
+// GetTriggers returns the Triggers field value if set, zero value otherwise
+func (o *SchemaAdvisorNamespaceTriggers) GetTriggers() []SchemaAdvisorTriggerDetails {
+ if o == nil || IsNil(o.Triggers) {
+ var ret []SchemaAdvisorTriggerDetails
+ return ret
+ }
+ return *o.Triggers
+}
+
+// GetTriggersOk returns a tuple with the Triggers field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *SchemaAdvisorNamespaceTriggers) GetTriggersOk() (*[]SchemaAdvisorTriggerDetails, bool) {
+ if o == nil || IsNil(o.Triggers) {
+ return nil, false
+ }
+
+ return o.Triggers, true
+}
+
+// HasTriggers returns a boolean if a field has been set.
+func (o *SchemaAdvisorNamespaceTriggers) HasTriggers() bool {
+ if o != nil && !IsNil(o.Triggers) {
+ return true
+ }
+
+ return false
+}
+
+// SetTriggers gets a reference to the given []SchemaAdvisorTriggerDetails and assigns it to the Triggers field.
+func (o *SchemaAdvisorNamespaceTriggers) SetTriggers(v []SchemaAdvisorTriggerDetails) {
+ o.Triggers = &v
+}
diff --git a/admin/model_schema_advisor_response.go b/admin/model_schema_advisor_response.go
new file mode 100644
index 000000000..d0e42a3b8
--- /dev/null
+++ b/admin/model_schema_advisor_response.go
@@ -0,0 +1,60 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// SchemaAdvisorResponse struct for SchemaAdvisorResponse
+type SchemaAdvisorResponse struct {
+ // List that contains the documents with information about the schema advice that Performance Advisor suggests.
+ // Read only field.
+ Recommendations *[]SchemaAdvisorItemRecommendation `json:"recommendations,omitempty"`
+}
+
+// NewSchemaAdvisorResponse instantiates a new SchemaAdvisorResponse object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewSchemaAdvisorResponse() *SchemaAdvisorResponse {
+ this := SchemaAdvisorResponse{}
+ return &this
+}
+
+// NewSchemaAdvisorResponseWithDefaults instantiates a new SchemaAdvisorResponse object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewSchemaAdvisorResponseWithDefaults() *SchemaAdvisorResponse {
+ this := SchemaAdvisorResponse{}
+ return &this
+}
+
+// GetRecommendations returns the Recommendations field value if set, zero value otherwise
+func (o *SchemaAdvisorResponse) GetRecommendations() []SchemaAdvisorItemRecommendation {
+ if o == nil || IsNil(o.Recommendations) {
+ var ret []SchemaAdvisorItemRecommendation
+ return ret
+ }
+ return *o.Recommendations
+}
+
+// GetRecommendationsOk returns a tuple with the Recommendations field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *SchemaAdvisorResponse) GetRecommendationsOk() (*[]SchemaAdvisorItemRecommendation, bool) {
+ if o == nil || IsNil(o.Recommendations) {
+ return nil, false
+ }
+
+ return o.Recommendations, true
+}
+
+// HasRecommendations returns a boolean if a field has been set.
+func (o *SchemaAdvisorResponse) HasRecommendations() bool {
+ if o != nil && !IsNil(o.Recommendations) {
+ return true
+ }
+
+ return false
+}
+
+// SetRecommendations gets a reference to the given []SchemaAdvisorItemRecommendation and assigns it to the Recommendations field.
+func (o *SchemaAdvisorResponse) SetRecommendations(v []SchemaAdvisorItemRecommendation) {
+ o.Recommendations = &v
+}
diff --git a/admin/model_schema_advisor_trigger_details.go b/admin/model_schema_advisor_trigger_details.go
new file mode 100644
index 000000000..55cfce452
--- /dev/null
+++ b/admin/model_schema_advisor_trigger_details.go
@@ -0,0 +1,96 @@
+// Code based on the AtlasAPI V2 OpenAPI file
+
+package admin
+
+// SchemaAdvisorTriggerDetails struct for SchemaAdvisorTriggerDetails
+type SchemaAdvisorTriggerDetails struct {
+ // Description of the trigger type.
+ // Read only field.
+ Description *string `json:"description,omitempty"`
+ // Type of trigger.
+ // Read only field.
+ TriggerType *string `json:"triggerType,omitempty"`
+}
+
+// NewSchemaAdvisorTriggerDetails instantiates a new SchemaAdvisorTriggerDetails object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewSchemaAdvisorTriggerDetails() *SchemaAdvisorTriggerDetails {
+ this := SchemaAdvisorTriggerDetails{}
+ return &this
+}
+
+// NewSchemaAdvisorTriggerDetailsWithDefaults instantiates a new SchemaAdvisorTriggerDetails object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewSchemaAdvisorTriggerDetailsWithDefaults() *SchemaAdvisorTriggerDetails {
+ this := SchemaAdvisorTriggerDetails{}
+ return &this
+}
+
+// GetDescription returns the Description field value if set, zero value otherwise
+func (o *SchemaAdvisorTriggerDetails) GetDescription() string {
+ if o == nil || IsNil(o.Description) {
+ var ret string
+ return ret
+ }
+ return *o.Description
+}
+
+// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *SchemaAdvisorTriggerDetails) GetDescriptionOk() (*string, bool) {
+ if o == nil || IsNil(o.Description) {
+ return nil, false
+ }
+
+ return o.Description, true
+}
+
+// HasDescription returns a boolean if a field has been set.
+func (o *SchemaAdvisorTriggerDetails) HasDescription() bool {
+ if o != nil && !IsNil(o.Description) {
+ return true
+ }
+
+ return false
+}
+
+// SetDescription gets a reference to the given string and assigns it to the Description field.
+func (o *SchemaAdvisorTriggerDetails) SetDescription(v string) {
+ o.Description = &v
+}
+
+// GetTriggerType returns the TriggerType field value if set, zero value otherwise
+func (o *SchemaAdvisorTriggerDetails) GetTriggerType() string {
+ if o == nil || IsNil(o.TriggerType) {
+ var ret string
+ return ret
+ }
+ return *o.TriggerType
+}
+
+// GetTriggerTypeOk returns a tuple with the TriggerType field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *SchemaAdvisorTriggerDetails) GetTriggerTypeOk() (*string, bool) {
+ if o == nil || IsNil(o.TriggerType) {
+ return nil, false
+ }
+
+ return o.TriggerType, true
+}
+
+// HasTriggerType returns a boolean if a field has been set.
+func (o *SchemaAdvisorTriggerDetails) HasTriggerType() bool {
+ if o != nil && !IsNil(o.TriggerType) {
+ return true
+ }
+
+ return false
+}
+
+// SetTriggerType gets a reference to the given string and assigns it to the TriggerType field.
+func (o *SchemaAdvisorTriggerDetails) SetTriggerType(v string) {
+ o.TriggerType = &v
+}
diff --git a/admin/model_serverless_provider_settings.go b/admin/model_serverless_provider_settings.go
index 75d6bc8fe..268a01a50 100644
--- a/admin/model_serverless_provider_settings.go
+++ b/admin/model_serverless_provider_settings.go
@@ -6,6 +6,15 @@ package admin
type ServerlessProviderSettings struct {
// Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
BackingProviderName string `json:"backingProviderName"`
+ // Storage capacity of instance data volumes expressed in gigabytes. This value is not configurable for Serverless or effectively Flex clusters.
+ // Read only field.
+ EffectiveDiskSizeGBLimit *int `json:"effectiveDiskSizeGBLimit,omitempty"`
+ // Instance size boundary to which your cluster can automatically scale.
+ // Read only field.
+ EffectiveInstanceSizeName *string `json:"effectiveInstanceSizeName,omitempty"`
+ // Cloud service provider on which MongoDB Cloud effectively provisioned the serverless instance.
+ // Read only field.
+ EffectiveProviderName *string `json:"effectiveProviderName,omitempty"`
// Human-readable label that identifies the cloud service provider.
ProviderName *string `json:"providerName,omitempty"`
// Human-readable label that identifies the geographic location of your MongoDB serverless instance. 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/).
@@ -59,6 +68,105 @@ func (o *ServerlessProviderSettings) SetBackingProviderName(v string) {
o.BackingProviderName = v
}
+// GetEffectiveDiskSizeGBLimit returns the EffectiveDiskSizeGBLimit field value if set, zero value otherwise
+func (o *ServerlessProviderSettings) GetEffectiveDiskSizeGBLimit() int {
+ if o == nil || IsNil(o.EffectiveDiskSizeGBLimit) {
+ var ret int
+ return ret
+ }
+ return *o.EffectiveDiskSizeGBLimit
+}
+
+// GetEffectiveDiskSizeGBLimitOk returns a tuple with the EffectiveDiskSizeGBLimit field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *ServerlessProviderSettings) GetEffectiveDiskSizeGBLimitOk() (*int, bool) {
+ if o == nil || IsNil(o.EffectiveDiskSizeGBLimit) {
+ return nil, false
+ }
+
+ return o.EffectiveDiskSizeGBLimit, true
+}
+
+// HasEffectiveDiskSizeGBLimit returns a boolean if a field has been set.
+func (o *ServerlessProviderSettings) HasEffectiveDiskSizeGBLimit() bool {
+ if o != nil && !IsNil(o.EffectiveDiskSizeGBLimit) {
+ return true
+ }
+
+ return false
+}
+
+// SetEffectiveDiskSizeGBLimit gets a reference to the given int and assigns it to the EffectiveDiskSizeGBLimit field.
+func (o *ServerlessProviderSettings) SetEffectiveDiskSizeGBLimit(v int) {
+ o.EffectiveDiskSizeGBLimit = &v
+}
+
+// GetEffectiveInstanceSizeName returns the EffectiveInstanceSizeName field value if set, zero value otherwise
+func (o *ServerlessProviderSettings) GetEffectiveInstanceSizeName() string {
+ if o == nil || IsNil(o.EffectiveInstanceSizeName) {
+ var ret string
+ return ret
+ }
+ return *o.EffectiveInstanceSizeName
+}
+
+// GetEffectiveInstanceSizeNameOk returns a tuple with the EffectiveInstanceSizeName field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *ServerlessProviderSettings) GetEffectiveInstanceSizeNameOk() (*string, bool) {
+ if o == nil || IsNil(o.EffectiveInstanceSizeName) {
+ return nil, false
+ }
+
+ return o.EffectiveInstanceSizeName, true
+}
+
+// HasEffectiveInstanceSizeName returns a boolean if a field has been set.
+func (o *ServerlessProviderSettings) HasEffectiveInstanceSizeName() bool {
+ if o != nil && !IsNil(o.EffectiveInstanceSizeName) {
+ return true
+ }
+
+ return false
+}
+
+// SetEffectiveInstanceSizeName gets a reference to the given string and assigns it to the EffectiveInstanceSizeName field.
+func (o *ServerlessProviderSettings) SetEffectiveInstanceSizeName(v string) {
+ o.EffectiveInstanceSizeName = &v
+}
+
+// GetEffectiveProviderName returns the EffectiveProviderName field value if set, zero value otherwise
+func (o *ServerlessProviderSettings) GetEffectiveProviderName() string {
+ if o == nil || IsNil(o.EffectiveProviderName) {
+ var ret string
+ return ret
+ }
+ return *o.EffectiveProviderName
+}
+
+// GetEffectiveProviderNameOk returns a tuple with the EffectiveProviderName field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *ServerlessProviderSettings) GetEffectiveProviderNameOk() (*string, bool) {
+ if o == nil || IsNil(o.EffectiveProviderName) {
+ return nil, false
+ }
+
+ return o.EffectiveProviderName, true
+}
+
+// HasEffectiveProviderName returns a boolean if a field has been set.
+func (o *ServerlessProviderSettings) HasEffectiveProviderName() bool {
+ if o != nil && !IsNil(o.EffectiveProviderName) {
+ return true
+ }
+
+ return false
+}
+
+// SetEffectiveProviderName gets a reference to the given string and assigns it to the EffectiveProviderName field.
+func (o *ServerlessProviderSettings) SetEffectiveProviderName(v string) {
+ o.EffectiveProviderName = &v
+}
+
// GetProviderName returns the ProviderName field value if set, zero value otherwise
func (o *ServerlessProviderSettings) GetProviderName() string {
if o == nil || IsNil(o.ProviderName) {
diff --git a/admin/model_streams_data_process_region.go b/admin/model_streams_data_process_region.go
index 51fb12eab..0da19941c 100644
--- a/admin/model_streams_data_process_region.go
+++ b/admin/model_streams_data_process_region.go
@@ -4,7 +4,7 @@ package admin
// StreamsDataProcessRegion Information about the cloud provider region in which MongoDB Cloud processes the stream.
type StreamsDataProcessRegion struct {
- // Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.
+ // Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter only supports AWS and AZURE.
CloudProvider string `json:"cloudProvider"`
// 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.
// Read only field.
diff --git a/admin/model_streams_private_link_connection.go b/admin/model_streams_private_link_connection.go
index 3a0f33fbe..cd8385ecc 100644
--- a/admin/model_streams_private_link_connection.go
+++ b/admin/model_streams_private_link_connection.go
@@ -5,23 +5,34 @@ package admin
// StreamsPrivateLinkConnection Container for metadata needed to create a Private Link connection.
type StreamsPrivateLinkConnection struct {
// The ID of the Private Link connection.
+ // Read only field.
Id *string `json:"_id,omitempty"`
+ // Amazon Resource Name (ARN).
+ Arn *string `json:"arn,omitempty"`
// Domain name of Privatelink connected cluster.
DnsDomain *string `json:"dnsDomain,omitempty"`
// Sub-Domain name of Confluent cluster. These are typically your availability zones.
DnsSubDomain *[]string `json:"dnsSubDomain,omitempty"`
+ // Error message if the state is FAILED.
+ // Read only field.
+ ErrorMessage *string `json:"errorMessage,omitempty"`
// Interface endpoint ID that is created from the service endpoint ID provided.
+ // Read only field.
InterfaceEndpointId *string `json:"interfaceEndpointId,omitempty"`
// 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.
// Read only field.
Links *[]Link `json:"links,omitempty"`
// Provider where the Kafka cluster is deployed.
Provider *string `json:"provider,omitempty"`
+ // Account ID from the cloud provider.
+ // Read only field.
+ ProviderAccountId *string `json:"providerAccountId,omitempty"`
// Domain name of Confluent cluster.
Region *string `json:"region,omitempty"`
// Service Endpoint ID.
ServiceEndpointId *string `json:"serviceEndpointId,omitempty"`
// State the connection is in.
+ // Read only field.
State *string `json:"state,omitempty"`
// Vendor who manages the Kafka cluster.
Vendor *string `json:"vendor,omitempty"`
@@ -77,6 +88,39 @@ func (o *StreamsPrivateLinkConnection) SetId(v string) {
o.Id = &v
}
+// GetArn returns the Arn field value if set, zero value otherwise
+func (o *StreamsPrivateLinkConnection) GetArn() string {
+ if o == nil || IsNil(o.Arn) {
+ var ret string
+ return ret
+ }
+ return *o.Arn
+}
+
+// GetArnOk returns a tuple with the Arn field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *StreamsPrivateLinkConnection) GetArnOk() (*string, bool) {
+ if o == nil || IsNil(o.Arn) {
+ return nil, false
+ }
+
+ return o.Arn, true
+}
+
+// HasArn returns a boolean if a field has been set.
+func (o *StreamsPrivateLinkConnection) HasArn() bool {
+ if o != nil && !IsNil(o.Arn) {
+ return true
+ }
+
+ return false
+}
+
+// SetArn gets a reference to the given string and assigns it to the Arn field.
+func (o *StreamsPrivateLinkConnection) SetArn(v string) {
+ o.Arn = &v
+}
+
// GetDnsDomain returns the DnsDomain field value if set, zero value otherwise
func (o *StreamsPrivateLinkConnection) GetDnsDomain() string {
if o == nil || IsNil(o.DnsDomain) {
@@ -143,6 +187,39 @@ func (o *StreamsPrivateLinkConnection) SetDnsSubDomain(v []string) {
o.DnsSubDomain = &v
}
+// GetErrorMessage returns the ErrorMessage field value if set, zero value otherwise
+func (o *StreamsPrivateLinkConnection) GetErrorMessage() string {
+ if o == nil || IsNil(o.ErrorMessage) {
+ var ret string
+ return ret
+ }
+ return *o.ErrorMessage
+}
+
+// GetErrorMessageOk returns a tuple with the ErrorMessage field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *StreamsPrivateLinkConnection) GetErrorMessageOk() (*string, bool) {
+ if o == nil || IsNil(o.ErrorMessage) {
+ return nil, false
+ }
+
+ return o.ErrorMessage, true
+}
+
+// HasErrorMessage returns a boolean if a field has been set.
+func (o *StreamsPrivateLinkConnection) HasErrorMessage() bool {
+ if o != nil && !IsNil(o.ErrorMessage) {
+ return true
+ }
+
+ return false
+}
+
+// SetErrorMessage gets a reference to the given string and assigns it to the ErrorMessage field.
+func (o *StreamsPrivateLinkConnection) SetErrorMessage(v string) {
+ o.ErrorMessage = &v
+}
+
// GetInterfaceEndpointId returns the InterfaceEndpointId field value if set, zero value otherwise
func (o *StreamsPrivateLinkConnection) GetInterfaceEndpointId() string {
if o == nil || IsNil(o.InterfaceEndpointId) {
@@ -242,6 +319,39 @@ func (o *StreamsPrivateLinkConnection) SetProvider(v string) {
o.Provider = &v
}
+// GetProviderAccountId returns the ProviderAccountId field value if set, zero value otherwise
+func (o *StreamsPrivateLinkConnection) GetProviderAccountId() string {
+ if o == nil || IsNil(o.ProviderAccountId) {
+ var ret string
+ return ret
+ }
+ return *o.ProviderAccountId
+}
+
+// GetProviderAccountIdOk returns a tuple with the ProviderAccountId field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *StreamsPrivateLinkConnection) GetProviderAccountIdOk() (*string, bool) {
+ if o == nil || IsNil(o.ProviderAccountId) {
+ return nil, false
+ }
+
+ return o.ProviderAccountId, true
+}
+
+// HasProviderAccountId returns a boolean if a field has been set.
+func (o *StreamsPrivateLinkConnection) HasProviderAccountId() bool {
+ if o != nil && !IsNil(o.ProviderAccountId) {
+ return true
+ }
+
+ return false
+}
+
+// SetProviderAccountId gets a reference to the given string and assigns it to the ProviderAccountId field.
+func (o *StreamsPrivateLinkConnection) SetProviderAccountId(v string) {
+ o.ProviderAccountId = &v
+}
+
// GetRegion returns the Region field value if set, zero value otherwise
func (o *StreamsPrivateLinkConnection) GetRegion() string {
if o == nil || IsNil(o.Region) {
diff --git a/admin/model_third_party_integration.go b/admin/model_third_party_integration.go
index e36a56606..6dbebfc7d 100644
--- a/admin/model_third_party_integration.go
+++ b/admin/model_third_party_integration.go
@@ -20,7 +20,7 @@ type ThirdPartyIntegration struct {
MicrosoftTeamsWebhookUrl *string `json:"microsoftTeamsWebhookUrl,omitempty"`
// Unique 40-hexadecimal digit string that identifies your New Relic account.
AccountId *string `json:"accountId,omitempty"`
- // Unique 40-hexadecimal digit string that identifies your New Relic license. **IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration. To learn more, see the New Relic Plugin EOL Statement Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.
+ // Unique 40-hexadecimal digit string that identifies your New Relic license. **IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.
LicenseKey *string `json:"licenseKey,omitempty"`
// Query key used to access your New Relic account.
ReadToken *string `json:"readToken,omitempty"`
diff --git a/auth/clientcredentials/clientcredentials.go b/auth/clientcredentials/clientcredentials.go
index 47914cbbd..5d92c7c0f 100644
--- a/auth/clientcredentials/clientcredentials.go
+++ b/auth/clientcredentials/clientcredentials.go
@@ -10,8 +10,8 @@ import (
"net/url"
"strings"
- "go.mongodb.org/atlas-sdk/v20241113004/auth"
- "go.mongodb.org/atlas-sdk/v20241113004/internal/core"
+ "github.com/mongodb/atlas-sdk-go/auth"
+ "github.com/mongodb/atlas-sdk-go/internal/core"
"golang.org/x/oauth2/clientcredentials"
)
diff --git a/auth/clientcredentials/clientcredentials_test.go b/auth/clientcredentials/clientcredentials_test.go
index aeb034278..20f431fc7 100644
--- a/auth/clientcredentials/clientcredentials_test.go
+++ b/auth/clientcredentials/clientcredentials_test.go
@@ -8,7 +8,7 @@ import (
"time"
"github.com/stretchr/testify/assert"
- "go.mongodb.org/atlas-sdk/v20241113004/auth"
+ "github.com/mongodb/atlas-sdk-go/auth"
)
// mockOAuthRevokeEndpoint creates a mock OAuth revoke endpoint,
diff --git a/auth/code/device_flow.go b/auth/code/device_flow.go
index 51126a347..6d353bddb 100644
--- a/auth/code/device_flow.go
+++ b/auth/code/device_flow.go
@@ -22,7 +22,7 @@ import (
"strings"
"time"
- core "go.mongodb.org/atlas-sdk/v20241113004/internal/core"
+ core "github.com/mongodb/atlas-sdk-go/internal/core"
)
const authExpiredError = "DEVICE_AUTHORIZATION_EXPIRED"
diff --git a/auth/code/oauth.go b/auth/code/oauth.go
index 49efc0d6e..f9e4a9bd5 100644
--- a/auth/code/oauth.go
+++ b/auth/code/oauth.go
@@ -26,7 +26,7 @@ import (
"runtime"
"strings"
- "go.mongodb.org/atlas-sdk/v20241113004/internal/core"
+ "github.com/mongodb/atlas-sdk-go/internal/core"
)
const defaultBaseURL = "https://cloud.mongodb.com/"
diff --git a/auth/code/oauth_test.go b/auth/code/oauth_test.go
index 8a3e42bd1..1234427b1 100644
--- a/auth/code/oauth_test.go
+++ b/auth/code/oauth_test.go
@@ -24,7 +24,7 @@ import (
"reflect"
"testing"
- core "go.mongodb.org/atlas-sdk/v20241113004/internal/core"
+ core "github.com/mongodb/atlas-sdk-go/internal/core"
)
const (
diff --git a/examples/aws_cluster/aws.go b/examples/aws_cluster/aws.go
index 09170e5b4..c12a81352 100644
--- a/examples/aws_cluster/aws.go
+++ b/examples/aws_cluster/aws.go
@@ -10,8 +10,8 @@ import (
"context"
- "go.mongodb.org/atlas-sdk/v20241113004/admin"
- "go.mongodb.org/atlas-sdk/v20241113004/examples"
+ "github.com/mongodb/atlas-sdk-go/admin"
+ "github.com/mongodb/atlas-sdk-go/examples"
)
/*
diff --git a/examples/basic/basic.go b/examples/basic/basic.go
index d44ca7818..731342a99 100644
--- a/examples/basic/basic.go
+++ b/examples/basic/basic.go
@@ -7,8 +7,8 @@ import (
"context"
- "go.mongodb.org/atlas-sdk/v20241113004/admin"
- "go.mongodb.org/atlas-sdk/v20241113004/examples"
+ "github.com/mongodb/atlas-sdk-go/admin"
+ "github.com/mongodb/atlas-sdk-go/examples"
)
/*
diff --git a/examples/db_users/db_users.go b/examples/db_users/db_users.go
index ff3ee8d1a..0ba40cbd5 100644
--- a/examples/db_users/db_users.go
+++ b/examples/db_users/db_users.go
@@ -6,8 +6,8 @@ import (
"context"
- "go.mongodb.org/atlas-sdk/v20241113004/admin"
- "go.mongodb.org/atlas-sdk/v20241113004/examples"
+ "github.com/mongodb/atlas-sdk-go/admin"
+ "github.com/mongodb/atlas-sdk-go/examples"
)
const (
diff --git a/examples/download/downloadLogs.go b/examples/download/downloadLogs.go
index 707ca19e2..7b1ca274f 100644
--- a/examples/download/downloadLogs.go
+++ b/examples/download/downloadLogs.go
@@ -7,8 +7,8 @@ import (
"context"
- "go.mongodb.org/atlas-sdk/v20241113004/admin"
- "go.mongodb.org/atlas-sdk/v20241113004/examples"
+ "github.com/mongodb/atlas-sdk-go/admin"
+ "github.com/mongodb/atlas-sdk-go/examples"
)
/*
diff --git a/examples/errors.go b/examples/errors.go
index d004e4c02..7c6a28ad7 100644
--- a/examples/errors.go
+++ b/examples/errors.go
@@ -5,7 +5,7 @@ import (
"log"
"net/http"
- "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ "github.com/mongodb/atlas-sdk-go/admin"
)
func HandleErr(err error, resp *http.Response) {
diff --git a/examples/go.mod b/examples/go.mod
index 49bc70cc2..ae4df8dbc 100644
--- a/examples/go.mod
+++ b/examples/go.mod
@@ -1,18 +1,20 @@
-module go.mongodb.org/atlas-sdk/v20241113004/examples
+module github.com/mongodb/atlas-sdk-go/examples
go 1.22.0
toolchain go1.23.1
-replace go.mongodb.org/atlas-sdk/v20241113004 => ../
+replace github.com/mongodb/atlas-sdk-go => ../
require (
github.com/hashicorp/go-retryablehttp v0.7.7
github.com/mongodb-forks/digest v1.1.0
- go.mongodb.org/atlas-sdk/v20241113004 v20241113004.1.0
)
-require golang.org/x/oauth2 v0.25.0 // indirect
+require (
+ github.com/mongodb/atlas-sdk-go v1.0.0 // indirect
+ golang.org/x/oauth2 v0.25.0 // indirect
+)
require (
github.com/davecgh/go-spew v1.1.1 // indirect
diff --git a/examples/invoice/invoice.go b/examples/invoice/invoice.go
index 4041a7d35..f5e41b040 100644
--- a/examples/invoice/invoice.go
+++ b/examples/invoice/invoice.go
@@ -7,8 +7,8 @@ import (
"context"
- "go.mongodb.org/atlas-sdk/v20241113004/admin"
- "go.mongodb.org/atlas-sdk/v20241113004/examples"
+ "github.com/mongodb/atlas-sdk-go/admin"
+ "github.com/mongodb/atlas-sdk-go/examples"
)
func main() {
diff --git a/examples/mock/cluster_test.go b/examples/mock/cluster_test.go
index e98b0fcff..087433514 100644
--- a/examples/mock/cluster_test.go
+++ b/examples/mock/cluster_test.go
@@ -7,8 +7,8 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
- "go.mongodb.org/atlas-sdk/v20241113004/admin"
- "go.mongodb.org/atlas-sdk/v20241113004/mockadmin"
+ "github.com/mongodb/atlas-sdk-go/admin"
+ "github.com/mongodb/atlas-sdk-go/mockadmin"
)
func myFunctionCallingListClusters(clusterAPI admin.ClustersApi) (int, error) {
diff --git a/examples/regions/regions.go b/examples/regions/regions.go
index 4a6cac62d..25e110610 100644
--- a/examples/regions/regions.go
+++ b/examples/regions/regions.go
@@ -7,8 +7,8 @@ import (
"context"
- "go.mongodb.org/atlas-sdk/v20241113004/admin"
- "go.mongodb.org/atlas-sdk/v20241113004/examples"
+ "github.com/mongodb/atlas-sdk-go/admin"
+ "github.com/mongodb/atlas-sdk-go/examples"
)
/*
diff --git a/examples/retry/retry.go b/examples/retry/retry.go
index e9b6e64fc..420790b1c 100644
--- a/examples/retry/retry.go
+++ b/examples/retry/retry.go
@@ -8,7 +8,7 @@ import (
"context"
- "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ "github.com/mongodb/atlas-sdk-go/admin"
retryablehttp "github.com/hashicorp/go-retryablehttp"
"github.com/mongodb-forks/digest"
diff --git a/examples/service_account_management/sa_management.go b/examples/service_account_management/sa_management.go
index 767f4ba79..04b2a9b9d 100644
--- a/examples/service_account_management/sa_management.go
+++ b/examples/service_account_management/sa_management.go
@@ -6,7 +6,7 @@ import (
"log"
"os"
- "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ "github.com/mongodb/atlas-sdk-go/admin"
)
// Example for Service Account Management API
diff --git a/examples/service_account_token_store/cached_token.go b/examples/service_account_token_store/cached_token.go
index fd83a4297..d11bead22 100644
--- a/examples/service_account_token_store/cached_token.go
+++ b/examples/service_account_token_store/cached_token.go
@@ -4,13 +4,13 @@ import (
"context"
"encoding/json"
"fmt"
- "go.mongodb.org/atlas-sdk/v20241113004/auth"
+ "github.com/mongodb/atlas-sdk-go/auth"
"log"
"os"
"strings"
- "go.mongodb.org/atlas-sdk/v20241113004/admin"
- "go.mongodb.org/atlas-sdk/v20241113004/auth/clientcredentials"
+ "github.com/mongodb/atlas-sdk-go/admin"
+ "github.com/mongodb/atlas-sdk-go/auth/clientcredentials"
)
// Variable provided as example.
diff --git a/go.mod b/go.mod
index c61e6b43c..56c6da854 100644
--- a/go.mod
+++ b/go.mod
@@ -1,4 +1,4 @@
-module go.mongodb.org/atlas-sdk/v20241113004
+module github.com/mongodb/atlas-sdk-go
go 1.22.0
diff --git a/mockadmin/access_tracking_api.go b/mockadmin/access_tracking_api.go
index 6664b3c99..727d3feaf 100644
--- a/mockadmin/access_tracking_api.go
+++ b/mockadmin/access_tracking_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/alert_configurations_api.go b/mockadmin/alert_configurations_api.go
index 917b8313a..09d640271 100644
--- a/mockadmin/alert_configurations_api.go
+++ b/mockadmin/alert_configurations_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/alerts_api.go b/mockadmin/alerts_api.go
index 5779a75d3..dd7b998b4 100644
--- a/mockadmin/alerts_api.go
+++ b/mockadmin/alerts_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/atlas_search_api.go b/mockadmin/atlas_search_api.go
index 300804410..c4f6e606d 100644
--- a/mockadmin/atlas_search_api.go
+++ b/mockadmin/atlas_search_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/auditing_api.go b/mockadmin/auditing_api.go
index da522a81f..d76a7ec84 100644
--- a/mockadmin/auditing_api.go
+++ b/mockadmin/auditing_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/aws_clusters_dns_api.go b/mockadmin/aws_clusters_dns_api.go
index d8a1b3fda..6f8f303a1 100644
--- a/mockadmin/aws_clusters_dns_api.go
+++ b/mockadmin/aws_clusters_dns_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/cloud_backups_api.go b/mockadmin/cloud_backups_api.go
index 289fc98cc..fac63e119 100644
--- a/mockadmin/cloud_backups_api.go
+++ b/mockadmin/cloud_backups_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/cloud_migration_service_api.go b/mockadmin/cloud_migration_service_api.go
index 470295102..c67324cfd 100644
--- a/mockadmin/cloud_migration_service_api.go
+++ b/mockadmin/cloud_migration_service_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/cloud_provider_access_api.go b/mockadmin/cloud_provider_access_api.go
index dd205171d..5dcdb3d0e 100644
--- a/mockadmin/cloud_provider_access_api.go
+++ b/mockadmin/cloud_provider_access_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/cluster_outage_simulation_api.go b/mockadmin/cluster_outage_simulation_api.go
index 09d8d1c90..964087740 100644
--- a/mockadmin/cluster_outage_simulation_api.go
+++ b/mockadmin/cluster_outage_simulation_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/clusters_api.go b/mockadmin/clusters_api.go
index 5571bc913..81e472302 100644
--- a/mockadmin/clusters_api.go
+++ b/mockadmin/clusters_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/collection_level_metrics_api.go b/mockadmin/collection_level_metrics_api.go
index daf6e1bed..f4e5debc7 100644
--- a/mockadmin/collection_level_metrics_api.go
+++ b/mockadmin/collection_level_metrics_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/custom_database_roles_api.go b/mockadmin/custom_database_roles_api.go
index f1533e9b5..ed0cb9dbb 100644
--- a/mockadmin/custom_database_roles_api.go
+++ b/mockadmin/custom_database_roles_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/data_federation_api.go b/mockadmin/data_federation_api.go
index 728fc1b2f..72a4da14f 100644
--- a/mockadmin/data_federation_api.go
+++ b/mockadmin/data_federation_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/data_lake_pipelines_api.go b/mockadmin/data_lake_pipelines_api.go
index b1776b1af..f82e84c03 100644
--- a/mockadmin/data_lake_pipelines_api.go
+++ b/mockadmin/data_lake_pipelines_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/database_users_api.go b/mockadmin/database_users_api.go
index 19b71568a..ee2e2c8a4 100644
--- a/mockadmin/database_users_api.go
+++ b/mockadmin/database_users_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/encryption_at_rest_using_customer_key_management_api.go b/mockadmin/encryption_at_rest_using_customer_key_management_api.go
index 684fa917f..d380d4307 100644
--- a/mockadmin/encryption_at_rest_using_customer_key_management_api.go
+++ b/mockadmin/encryption_at_rest_using_customer_key_management_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/events_api.go b/mockadmin/events_api.go
index c81bdf12a..f4a8dc183 100644
--- a/mockadmin/events_api.go
+++ b/mockadmin/events_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/federated_authentication_api.go b/mockadmin/federated_authentication_api.go
index ad0ff226a..85b2fb59c 100644
--- a/mockadmin/federated_authentication_api.go
+++ b/mockadmin/federated_authentication_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/flex_clusters_api.go b/mockadmin/flex_clusters_api.go
index 7f34f9cdc..f82013d06 100644
--- a/mockadmin/flex_clusters_api.go
+++ b/mockadmin/flex_clusters_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/flex_restore_jobs_api.go b/mockadmin/flex_restore_jobs_api.go
index 0b23250db..c643a3965 100644
--- a/mockadmin/flex_restore_jobs_api.go
+++ b/mockadmin/flex_restore_jobs_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/flex_snapshots_api.go b/mockadmin/flex_snapshots_api.go
index 010475d86..c8e9f18a9 100644
--- a/mockadmin/flex_snapshots_api.go
+++ b/mockadmin/flex_snapshots_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/global_clusters_api.go b/mockadmin/global_clusters_api.go
index fd487fe03..3aad43d49 100644
--- a/mockadmin/global_clusters_api.go
+++ b/mockadmin/global_clusters_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/invoices_api.go b/mockadmin/invoices_api.go
index b45f8d08e..5c1b3eb18 100644
--- a/mockadmin/invoices_api.go
+++ b/mockadmin/invoices_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/ldap_configuration_api.go b/mockadmin/ldap_configuration_api.go
index 0e6a39e6c..c3e6a5669 100644
--- a/mockadmin/ldap_configuration_api.go
+++ b/mockadmin/ldap_configuration_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/legacy_backup_api.go b/mockadmin/legacy_backup_api.go
index fe4109042..3e941d5cc 100644
--- a/mockadmin/legacy_backup_api.go
+++ b/mockadmin/legacy_backup_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/maintenance_windows_api.go b/mockadmin/maintenance_windows_api.go
index a8a0a0b73..ec4bda7f9 100644
--- a/mockadmin/maintenance_windows_api.go
+++ b/mockadmin/maintenance_windows_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/mongo_db_cloud_users_api.go b/mockadmin/mongo_db_cloud_users_api.go
index 326e71207..dbcaa3488 100644
--- a/mockadmin/mongo_db_cloud_users_api.go
+++ b/mockadmin/mongo_db_cloud_users_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
@@ -25,76 +25,1698 @@ func (_m *MongoDBCloudUsersApi) EXPECT() *MongoDBCloudUsersApi_Expecter {
return &MongoDBCloudUsersApi_Expecter{mock: &_m.Mock}
}
+// AddOrganizationRole provides a mock function with given fields: ctx, orgId, userId, addOrRemoveOrgRole
+func (_m *MongoDBCloudUsersApi) AddOrganizationRole(ctx context.Context, orgId string, userId string, addOrRemoveOrgRole *admin.AddOrRemoveOrgRole) admin.AddOrganizationRoleApiRequest {
+ ret := _m.Called(ctx, orgId, userId, addOrRemoveOrgRole)
+
+ if len(ret) == 0 {
+ panic("no return value specified for AddOrganizationRole")
+ }
+
+ var r0 admin.AddOrganizationRoleApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string, string, *admin.AddOrRemoveOrgRole) admin.AddOrganizationRoleApiRequest); ok {
+ r0 = rf(ctx, orgId, userId, addOrRemoveOrgRole)
+ } else {
+ r0 = ret.Get(0).(admin.AddOrganizationRoleApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_AddOrganizationRole_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'AddOrganizationRole'
+type MongoDBCloudUsersApi_AddOrganizationRole_Call struct {
+ *mock.Call
+}
+
+// AddOrganizationRole is a helper method to define mock.On call
+// - ctx context.Context
+// - orgId string
+// - userId string
+// - addOrRemoveOrgRole *admin.AddOrRemoveOrgRole
+func (_e *MongoDBCloudUsersApi_Expecter) AddOrganizationRole(ctx any, orgId any, userId any, addOrRemoveOrgRole any) *MongoDBCloudUsersApi_AddOrganizationRole_Call {
+ return &MongoDBCloudUsersApi_AddOrganizationRole_Call{Call: _e.mock.On("AddOrganizationRole", ctx, orgId, userId, addOrRemoveOrgRole)}
+}
+
+func (_c *MongoDBCloudUsersApi_AddOrganizationRole_Call) Run(run func(ctx context.Context, orgId string, userId string, addOrRemoveOrgRole *admin.AddOrRemoveOrgRole)) *MongoDBCloudUsersApi_AddOrganizationRole_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(string), args[2].(string), args[3].(*admin.AddOrRemoveOrgRole))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddOrganizationRole_Call) Return(_a0 admin.AddOrganizationRoleApiRequest) *MongoDBCloudUsersApi_AddOrganizationRole_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddOrganizationRole_Call) RunAndReturn(run func(context.Context, string, string, *admin.AddOrRemoveOrgRole) admin.AddOrganizationRoleApiRequest) *MongoDBCloudUsersApi_AddOrganizationRole_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// AddOrganizationRoleExecute provides a mock function with given fields: r
+func (_m *MongoDBCloudUsersApi) AddOrganizationRoleExecute(r admin.AddOrganizationRoleApiRequest) (*admin.OrgUserResponse, *http.Response, error) {
+ ret := _m.Called(r)
+
+ if len(ret) == 0 {
+ panic("no return value specified for AddOrganizationRoleExecute")
+ }
+
+ var r0 *admin.OrgUserResponse
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.AddOrganizationRoleApiRequest) (*admin.OrgUserResponse, *http.Response, error)); ok {
+ return rf(r)
+ }
+ if rf, ok := ret.Get(0).(func(admin.AddOrganizationRoleApiRequest) *admin.OrgUserResponse); ok {
+ r0 = rf(r)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*admin.OrgUserResponse)
+ }
+ }
+
+ if rf, ok := ret.Get(1).(func(admin.AddOrganizationRoleApiRequest) *http.Response); ok {
+ r1 = rf(r)
+ } else {
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(2).(func(admin.AddOrganizationRoleApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
+}
+
+// MongoDBCloudUsersApi_AddOrganizationRoleExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'AddOrganizationRoleExecute'
+type MongoDBCloudUsersApi_AddOrganizationRoleExecute_Call struct {
+ *mock.Call
+}
+
+// AddOrganizationRoleExecute is a helper method to define mock.On call
+// - r admin.AddOrganizationRoleApiRequest
+func (_e *MongoDBCloudUsersApi_Expecter) AddOrganizationRoleExecute(r any) *MongoDBCloudUsersApi_AddOrganizationRoleExecute_Call {
+ return &MongoDBCloudUsersApi_AddOrganizationRoleExecute_Call{Call: _e.mock.On("AddOrganizationRoleExecute", r)}
+}
+
+func (_c *MongoDBCloudUsersApi_AddOrganizationRoleExecute_Call) Run(run func(r admin.AddOrganizationRoleApiRequest)) *MongoDBCloudUsersApi_AddOrganizationRoleExecute_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(admin.AddOrganizationRoleApiRequest))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddOrganizationRoleExecute_Call) Return(_a0 *admin.OrgUserResponse, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_AddOrganizationRoleExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddOrganizationRoleExecute_Call) RunAndReturn(run func(admin.AddOrganizationRoleApiRequest) (*admin.OrgUserResponse, *http.Response, error)) *MongoDBCloudUsersApi_AddOrganizationRoleExecute_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// AddOrganizationRoleWithParams provides a mock function with given fields: ctx, args
+func (_m *MongoDBCloudUsersApi) AddOrganizationRoleWithParams(ctx context.Context, args *admin.AddOrganizationRoleApiParams) admin.AddOrganizationRoleApiRequest {
+ ret := _m.Called(ctx, args)
+
+ if len(ret) == 0 {
+ panic("no return value specified for AddOrganizationRoleWithParams")
+ }
+
+ var r0 admin.AddOrganizationRoleApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.AddOrganizationRoleApiParams) admin.AddOrganizationRoleApiRequest); ok {
+ r0 = rf(ctx, args)
+ } else {
+ r0 = ret.Get(0).(admin.AddOrganizationRoleApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_AddOrganizationRoleWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'AddOrganizationRoleWithParams'
+type MongoDBCloudUsersApi_AddOrganizationRoleWithParams_Call struct {
+ *mock.Call
+}
+
+// AddOrganizationRoleWithParams is a helper method to define mock.On call
+// - ctx context.Context
+// - args *admin.AddOrganizationRoleApiParams
+func (_e *MongoDBCloudUsersApi_Expecter) AddOrganizationRoleWithParams(ctx any, args any) *MongoDBCloudUsersApi_AddOrganizationRoleWithParams_Call {
+ return &MongoDBCloudUsersApi_AddOrganizationRoleWithParams_Call{Call: _e.mock.On("AddOrganizationRoleWithParams", ctx, args)}
+}
+
+func (_c *MongoDBCloudUsersApi_AddOrganizationRoleWithParams_Call) Run(run func(ctx context.Context, args *admin.AddOrganizationRoleApiParams)) *MongoDBCloudUsersApi_AddOrganizationRoleWithParams_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(*admin.AddOrganizationRoleApiParams))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddOrganizationRoleWithParams_Call) Return(_a0 admin.AddOrganizationRoleApiRequest) *MongoDBCloudUsersApi_AddOrganizationRoleWithParams_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddOrganizationRoleWithParams_Call) RunAndReturn(run func(context.Context, *admin.AddOrganizationRoleApiParams) admin.AddOrganizationRoleApiRequest) *MongoDBCloudUsersApi_AddOrganizationRoleWithParams_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// AddProjectRole provides a mock function with given fields: ctx, groupId, userId, addOrRemoveGroupRole
+func (_m *MongoDBCloudUsersApi) AddProjectRole(ctx context.Context, groupId string, userId string, addOrRemoveGroupRole *admin.AddOrRemoveGroupRole) admin.AddProjectRoleApiRequest {
+ ret := _m.Called(ctx, groupId, userId, addOrRemoveGroupRole)
+
+ if len(ret) == 0 {
+ panic("no return value specified for AddProjectRole")
+ }
+
+ var r0 admin.AddProjectRoleApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string, string, *admin.AddOrRemoveGroupRole) admin.AddProjectRoleApiRequest); ok {
+ r0 = rf(ctx, groupId, userId, addOrRemoveGroupRole)
+ } else {
+ r0 = ret.Get(0).(admin.AddProjectRoleApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_AddProjectRole_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'AddProjectRole'
+type MongoDBCloudUsersApi_AddProjectRole_Call struct {
+ *mock.Call
+}
+
+// AddProjectRole is a helper method to define mock.On call
+// - ctx context.Context
+// - groupId string
+// - userId string
+// - addOrRemoveGroupRole *admin.AddOrRemoveGroupRole
+func (_e *MongoDBCloudUsersApi_Expecter) AddProjectRole(ctx any, groupId any, userId any, addOrRemoveGroupRole any) *MongoDBCloudUsersApi_AddProjectRole_Call {
+ return &MongoDBCloudUsersApi_AddProjectRole_Call{Call: _e.mock.On("AddProjectRole", ctx, groupId, userId, addOrRemoveGroupRole)}
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectRole_Call) Run(run func(ctx context.Context, groupId string, userId string, addOrRemoveGroupRole *admin.AddOrRemoveGroupRole)) *MongoDBCloudUsersApi_AddProjectRole_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(string), args[2].(string), args[3].(*admin.AddOrRemoveGroupRole))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectRole_Call) Return(_a0 admin.AddProjectRoleApiRequest) *MongoDBCloudUsersApi_AddProjectRole_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectRole_Call) RunAndReturn(run func(context.Context, string, string, *admin.AddOrRemoveGroupRole) admin.AddProjectRoleApiRequest) *MongoDBCloudUsersApi_AddProjectRole_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// AddProjectRoleExecute provides a mock function with given fields: r
+func (_m *MongoDBCloudUsersApi) AddProjectRoleExecute(r admin.AddProjectRoleApiRequest) (*admin.OrgUserResponse, *http.Response, error) {
+ ret := _m.Called(r)
+
+ if len(ret) == 0 {
+ panic("no return value specified for AddProjectRoleExecute")
+ }
+
+ var r0 *admin.OrgUserResponse
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.AddProjectRoleApiRequest) (*admin.OrgUserResponse, *http.Response, error)); ok {
+ return rf(r)
+ }
+ if rf, ok := ret.Get(0).(func(admin.AddProjectRoleApiRequest) *admin.OrgUserResponse); ok {
+ r0 = rf(r)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*admin.OrgUserResponse)
+ }
+ }
+
+ if rf, ok := ret.Get(1).(func(admin.AddProjectRoleApiRequest) *http.Response); ok {
+ r1 = rf(r)
+ } else {
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(2).(func(admin.AddProjectRoleApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
+}
+
+// MongoDBCloudUsersApi_AddProjectRoleExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'AddProjectRoleExecute'
+type MongoDBCloudUsersApi_AddProjectRoleExecute_Call struct {
+ *mock.Call
+}
+
+// AddProjectRoleExecute is a helper method to define mock.On call
+// - r admin.AddProjectRoleApiRequest
+func (_e *MongoDBCloudUsersApi_Expecter) AddProjectRoleExecute(r any) *MongoDBCloudUsersApi_AddProjectRoleExecute_Call {
+ return &MongoDBCloudUsersApi_AddProjectRoleExecute_Call{Call: _e.mock.On("AddProjectRoleExecute", r)}
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectRoleExecute_Call) Run(run func(r admin.AddProjectRoleApiRequest)) *MongoDBCloudUsersApi_AddProjectRoleExecute_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(admin.AddProjectRoleApiRequest))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectRoleExecute_Call) Return(_a0 *admin.OrgUserResponse, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_AddProjectRoleExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectRoleExecute_Call) RunAndReturn(run func(admin.AddProjectRoleApiRequest) (*admin.OrgUserResponse, *http.Response, error)) *MongoDBCloudUsersApi_AddProjectRoleExecute_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// AddProjectRoleWithParams provides a mock function with given fields: ctx, args
+func (_m *MongoDBCloudUsersApi) AddProjectRoleWithParams(ctx context.Context, args *admin.AddProjectRoleApiParams) admin.AddProjectRoleApiRequest {
+ ret := _m.Called(ctx, args)
+
+ if len(ret) == 0 {
+ panic("no return value specified for AddProjectRoleWithParams")
+ }
+
+ var r0 admin.AddProjectRoleApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.AddProjectRoleApiParams) admin.AddProjectRoleApiRequest); ok {
+ r0 = rf(ctx, args)
+ } else {
+ r0 = ret.Get(0).(admin.AddProjectRoleApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_AddProjectRoleWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'AddProjectRoleWithParams'
+type MongoDBCloudUsersApi_AddProjectRoleWithParams_Call struct {
+ *mock.Call
+}
+
+// AddProjectRoleWithParams is a helper method to define mock.On call
+// - ctx context.Context
+// - args *admin.AddProjectRoleApiParams
+func (_e *MongoDBCloudUsersApi_Expecter) AddProjectRoleWithParams(ctx any, args any) *MongoDBCloudUsersApi_AddProjectRoleWithParams_Call {
+ return &MongoDBCloudUsersApi_AddProjectRoleWithParams_Call{Call: _e.mock.On("AddProjectRoleWithParams", ctx, args)}
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectRoleWithParams_Call) Run(run func(ctx context.Context, args *admin.AddProjectRoleApiParams)) *MongoDBCloudUsersApi_AddProjectRoleWithParams_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(*admin.AddProjectRoleApiParams))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectRoleWithParams_Call) Return(_a0 admin.AddProjectRoleApiRequest) *MongoDBCloudUsersApi_AddProjectRoleWithParams_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectRoleWithParams_Call) RunAndReturn(run func(context.Context, *admin.AddProjectRoleApiParams) admin.AddProjectRoleApiRequest) *MongoDBCloudUsersApi_AddProjectRoleWithParams_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// AddProjectUser provides a mock function with given fields: ctx, groupId, groupUserRequest
+func (_m *MongoDBCloudUsersApi) AddProjectUser(ctx context.Context, groupId string, groupUserRequest *admin.GroupUserRequest) admin.AddProjectUserApiRequest {
+ ret := _m.Called(ctx, groupId, groupUserRequest)
+
+ if len(ret) == 0 {
+ panic("no return value specified for AddProjectUser")
+ }
+
+ var r0 admin.AddProjectUserApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string, *admin.GroupUserRequest) admin.AddProjectUserApiRequest); ok {
+ r0 = rf(ctx, groupId, groupUserRequest)
+ } else {
+ r0 = ret.Get(0).(admin.AddProjectUserApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_AddProjectUser_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'AddProjectUser'
+type MongoDBCloudUsersApi_AddProjectUser_Call struct {
+ *mock.Call
+}
+
+// AddProjectUser is a helper method to define mock.On call
+// - ctx context.Context
+// - groupId string
+// - groupUserRequest *admin.GroupUserRequest
+func (_e *MongoDBCloudUsersApi_Expecter) AddProjectUser(ctx any, groupId any, groupUserRequest any) *MongoDBCloudUsersApi_AddProjectUser_Call {
+ return &MongoDBCloudUsersApi_AddProjectUser_Call{Call: _e.mock.On("AddProjectUser", ctx, groupId, groupUserRequest)}
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectUser_Call) Run(run func(ctx context.Context, groupId string, groupUserRequest *admin.GroupUserRequest)) *MongoDBCloudUsersApi_AddProjectUser_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(string), args[2].(*admin.GroupUserRequest))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectUser_Call) Return(_a0 admin.AddProjectUserApiRequest) *MongoDBCloudUsersApi_AddProjectUser_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectUser_Call) RunAndReturn(run func(context.Context, string, *admin.GroupUserRequest) admin.AddProjectUserApiRequest) *MongoDBCloudUsersApi_AddProjectUser_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// AddProjectUserExecute provides a mock function with given fields: r
+func (_m *MongoDBCloudUsersApi) AddProjectUserExecute(r admin.AddProjectUserApiRequest) (*admin.GroupUserResponse, *http.Response, error) {
+ ret := _m.Called(r)
+
+ if len(ret) == 0 {
+ panic("no return value specified for AddProjectUserExecute")
+ }
+
+ var r0 *admin.GroupUserResponse
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.AddProjectUserApiRequest) (*admin.GroupUserResponse, *http.Response, error)); ok {
+ return rf(r)
+ }
+ if rf, ok := ret.Get(0).(func(admin.AddProjectUserApiRequest) *admin.GroupUserResponse); ok {
+ r0 = rf(r)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*admin.GroupUserResponse)
+ }
+ }
+
+ if rf, ok := ret.Get(1).(func(admin.AddProjectUserApiRequest) *http.Response); ok {
+ r1 = rf(r)
+ } else {
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(2).(func(admin.AddProjectUserApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
+}
+
+// MongoDBCloudUsersApi_AddProjectUserExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'AddProjectUserExecute'
+type MongoDBCloudUsersApi_AddProjectUserExecute_Call struct {
+ *mock.Call
+}
+
+// AddProjectUserExecute is a helper method to define mock.On call
+// - r admin.AddProjectUserApiRequest
+func (_e *MongoDBCloudUsersApi_Expecter) AddProjectUserExecute(r any) *MongoDBCloudUsersApi_AddProjectUserExecute_Call {
+ return &MongoDBCloudUsersApi_AddProjectUserExecute_Call{Call: _e.mock.On("AddProjectUserExecute", r)}
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectUserExecute_Call) Run(run func(r admin.AddProjectUserApiRequest)) *MongoDBCloudUsersApi_AddProjectUserExecute_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(admin.AddProjectUserApiRequest))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectUserExecute_Call) Return(_a0 *admin.GroupUserResponse, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_AddProjectUserExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectUserExecute_Call) RunAndReturn(run func(admin.AddProjectUserApiRequest) (*admin.GroupUserResponse, *http.Response, error)) *MongoDBCloudUsersApi_AddProjectUserExecute_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// AddProjectUserWithParams provides a mock function with given fields: ctx, args
+func (_m *MongoDBCloudUsersApi) AddProjectUserWithParams(ctx context.Context, args *admin.AddProjectUserApiParams) admin.AddProjectUserApiRequest {
+ ret := _m.Called(ctx, args)
+
+ if len(ret) == 0 {
+ panic("no return value specified for AddProjectUserWithParams")
+ }
+
+ var r0 admin.AddProjectUserApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.AddProjectUserApiParams) admin.AddProjectUserApiRequest); ok {
+ r0 = rf(ctx, args)
+ } else {
+ r0 = ret.Get(0).(admin.AddProjectUserApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_AddProjectUserWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'AddProjectUserWithParams'
+type MongoDBCloudUsersApi_AddProjectUserWithParams_Call struct {
+ *mock.Call
+}
+
+// AddProjectUserWithParams is a helper method to define mock.On call
+// - ctx context.Context
+// - args *admin.AddProjectUserApiParams
+func (_e *MongoDBCloudUsersApi_Expecter) AddProjectUserWithParams(ctx any, args any) *MongoDBCloudUsersApi_AddProjectUserWithParams_Call {
+ return &MongoDBCloudUsersApi_AddProjectUserWithParams_Call{Call: _e.mock.On("AddProjectUserWithParams", ctx, args)}
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectUserWithParams_Call) Run(run func(ctx context.Context, args *admin.AddProjectUserApiParams)) *MongoDBCloudUsersApi_AddProjectUserWithParams_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(*admin.AddProjectUserApiParams))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectUserWithParams_Call) Return(_a0 admin.AddProjectUserApiRequest) *MongoDBCloudUsersApi_AddProjectUserWithParams_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddProjectUserWithParams_Call) RunAndReturn(run func(context.Context, *admin.AddProjectUserApiParams) admin.AddProjectUserApiRequest) *MongoDBCloudUsersApi_AddProjectUserWithParams_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// AddUserToTeam provides a mock function with given fields: ctx, orgId, teamId, addOrRemoveUserFromTeam
+func (_m *MongoDBCloudUsersApi) AddUserToTeam(ctx context.Context, orgId string, teamId string, addOrRemoveUserFromTeam *admin.AddOrRemoveUserFromTeam) admin.AddUserToTeamApiRequest {
+ ret := _m.Called(ctx, orgId, teamId, addOrRemoveUserFromTeam)
+
+ if len(ret) == 0 {
+ panic("no return value specified for AddUserToTeam")
+ }
+
+ var r0 admin.AddUserToTeamApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string, string, *admin.AddOrRemoveUserFromTeam) admin.AddUserToTeamApiRequest); ok {
+ r0 = rf(ctx, orgId, teamId, addOrRemoveUserFromTeam)
+ } else {
+ r0 = ret.Get(0).(admin.AddUserToTeamApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_AddUserToTeam_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'AddUserToTeam'
+type MongoDBCloudUsersApi_AddUserToTeam_Call struct {
+ *mock.Call
+}
+
+// AddUserToTeam is a helper method to define mock.On call
+// - ctx context.Context
+// - orgId string
+// - teamId string
+// - addOrRemoveUserFromTeam *admin.AddOrRemoveUserFromTeam
+func (_e *MongoDBCloudUsersApi_Expecter) AddUserToTeam(ctx any, orgId any, teamId any, addOrRemoveUserFromTeam any) *MongoDBCloudUsersApi_AddUserToTeam_Call {
+ return &MongoDBCloudUsersApi_AddUserToTeam_Call{Call: _e.mock.On("AddUserToTeam", ctx, orgId, teamId, addOrRemoveUserFromTeam)}
+}
+
+func (_c *MongoDBCloudUsersApi_AddUserToTeam_Call) Run(run func(ctx context.Context, orgId string, teamId string, addOrRemoveUserFromTeam *admin.AddOrRemoveUserFromTeam)) *MongoDBCloudUsersApi_AddUserToTeam_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(string), args[2].(string), args[3].(*admin.AddOrRemoveUserFromTeam))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddUserToTeam_Call) Return(_a0 admin.AddUserToTeamApiRequest) *MongoDBCloudUsersApi_AddUserToTeam_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddUserToTeam_Call) RunAndReturn(run func(context.Context, string, string, *admin.AddOrRemoveUserFromTeam) admin.AddUserToTeamApiRequest) *MongoDBCloudUsersApi_AddUserToTeam_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// AddUserToTeamExecute provides a mock function with given fields: r
+func (_m *MongoDBCloudUsersApi) AddUserToTeamExecute(r admin.AddUserToTeamApiRequest) (*admin.OrgUserResponse, *http.Response, error) {
+ ret := _m.Called(r)
+
+ if len(ret) == 0 {
+ panic("no return value specified for AddUserToTeamExecute")
+ }
+
+ var r0 *admin.OrgUserResponse
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.AddUserToTeamApiRequest) (*admin.OrgUserResponse, *http.Response, error)); ok {
+ return rf(r)
+ }
+ if rf, ok := ret.Get(0).(func(admin.AddUserToTeamApiRequest) *admin.OrgUserResponse); ok {
+ r0 = rf(r)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*admin.OrgUserResponse)
+ }
+ }
+
+ if rf, ok := ret.Get(1).(func(admin.AddUserToTeamApiRequest) *http.Response); ok {
+ r1 = rf(r)
+ } else {
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(2).(func(admin.AddUserToTeamApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
+}
+
+// MongoDBCloudUsersApi_AddUserToTeamExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'AddUserToTeamExecute'
+type MongoDBCloudUsersApi_AddUserToTeamExecute_Call struct {
+ *mock.Call
+}
+
+// AddUserToTeamExecute is a helper method to define mock.On call
+// - r admin.AddUserToTeamApiRequest
+func (_e *MongoDBCloudUsersApi_Expecter) AddUserToTeamExecute(r any) *MongoDBCloudUsersApi_AddUserToTeamExecute_Call {
+ return &MongoDBCloudUsersApi_AddUserToTeamExecute_Call{Call: _e.mock.On("AddUserToTeamExecute", r)}
+}
+
+func (_c *MongoDBCloudUsersApi_AddUserToTeamExecute_Call) Run(run func(r admin.AddUserToTeamApiRequest)) *MongoDBCloudUsersApi_AddUserToTeamExecute_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(admin.AddUserToTeamApiRequest))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddUserToTeamExecute_Call) Return(_a0 *admin.OrgUserResponse, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_AddUserToTeamExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddUserToTeamExecute_Call) RunAndReturn(run func(admin.AddUserToTeamApiRequest) (*admin.OrgUserResponse, *http.Response, error)) *MongoDBCloudUsersApi_AddUserToTeamExecute_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// AddUserToTeamWithParams provides a mock function with given fields: ctx, args
+func (_m *MongoDBCloudUsersApi) AddUserToTeamWithParams(ctx context.Context, args *admin.AddUserToTeamApiParams) admin.AddUserToTeamApiRequest {
+ ret := _m.Called(ctx, args)
+
+ if len(ret) == 0 {
+ panic("no return value specified for AddUserToTeamWithParams")
+ }
+
+ var r0 admin.AddUserToTeamApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.AddUserToTeamApiParams) admin.AddUserToTeamApiRequest); ok {
+ r0 = rf(ctx, args)
+ } else {
+ r0 = ret.Get(0).(admin.AddUserToTeamApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_AddUserToTeamWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'AddUserToTeamWithParams'
+type MongoDBCloudUsersApi_AddUserToTeamWithParams_Call struct {
+ *mock.Call
+}
+
+// AddUserToTeamWithParams is a helper method to define mock.On call
+// - ctx context.Context
+// - args *admin.AddUserToTeamApiParams
+func (_e *MongoDBCloudUsersApi_Expecter) AddUserToTeamWithParams(ctx any, args any) *MongoDBCloudUsersApi_AddUserToTeamWithParams_Call {
+ return &MongoDBCloudUsersApi_AddUserToTeamWithParams_Call{Call: _e.mock.On("AddUserToTeamWithParams", ctx, args)}
+}
+
+func (_c *MongoDBCloudUsersApi_AddUserToTeamWithParams_Call) Run(run func(ctx context.Context, args *admin.AddUserToTeamApiParams)) *MongoDBCloudUsersApi_AddUserToTeamWithParams_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(*admin.AddUserToTeamApiParams))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddUserToTeamWithParams_Call) Return(_a0 admin.AddUserToTeamApiRequest) *MongoDBCloudUsersApi_AddUserToTeamWithParams_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_AddUserToTeamWithParams_Call) RunAndReturn(run func(context.Context, *admin.AddUserToTeamApiParams) admin.AddUserToTeamApiRequest) *MongoDBCloudUsersApi_AddUserToTeamWithParams_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// CreateOrganizationUser provides a mock function with given fields: ctx, orgId, orgUserRequest
+func (_m *MongoDBCloudUsersApi) CreateOrganizationUser(ctx context.Context, orgId string, orgUserRequest *admin.OrgUserRequest) admin.CreateOrganizationUserApiRequest {
+ ret := _m.Called(ctx, orgId, orgUserRequest)
+
+ if len(ret) == 0 {
+ panic("no return value specified for CreateOrganizationUser")
+ }
+
+ var r0 admin.CreateOrganizationUserApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string, *admin.OrgUserRequest) admin.CreateOrganizationUserApiRequest); ok {
+ r0 = rf(ctx, orgId, orgUserRequest)
+ } else {
+ r0 = ret.Get(0).(admin.CreateOrganizationUserApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_CreateOrganizationUser_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'CreateOrganizationUser'
+type MongoDBCloudUsersApi_CreateOrganizationUser_Call struct {
+ *mock.Call
+}
+
+// CreateOrganizationUser is a helper method to define mock.On call
+// - ctx context.Context
+// - orgId string
+// - orgUserRequest *admin.OrgUserRequest
+func (_e *MongoDBCloudUsersApi_Expecter) CreateOrganizationUser(ctx any, orgId any, orgUserRequest any) *MongoDBCloudUsersApi_CreateOrganizationUser_Call {
+ return &MongoDBCloudUsersApi_CreateOrganizationUser_Call{Call: _e.mock.On("CreateOrganizationUser", ctx, orgId, orgUserRequest)}
+}
+
+func (_c *MongoDBCloudUsersApi_CreateOrganizationUser_Call) Run(run func(ctx context.Context, orgId string, orgUserRequest *admin.OrgUserRequest)) *MongoDBCloudUsersApi_CreateOrganizationUser_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(string), args[2].(*admin.OrgUserRequest))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_CreateOrganizationUser_Call) Return(_a0 admin.CreateOrganizationUserApiRequest) *MongoDBCloudUsersApi_CreateOrganizationUser_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_CreateOrganizationUser_Call) RunAndReturn(run func(context.Context, string, *admin.OrgUserRequest) admin.CreateOrganizationUserApiRequest) *MongoDBCloudUsersApi_CreateOrganizationUser_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// CreateOrganizationUserExecute provides a mock function with given fields: r
+func (_m *MongoDBCloudUsersApi) CreateOrganizationUserExecute(r admin.CreateOrganizationUserApiRequest) (*admin.OrgUserResponse, *http.Response, error) {
+ ret := _m.Called(r)
+
+ if len(ret) == 0 {
+ panic("no return value specified for CreateOrganizationUserExecute")
+ }
+
+ var r0 *admin.OrgUserResponse
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.CreateOrganizationUserApiRequest) (*admin.OrgUserResponse, *http.Response, error)); ok {
+ return rf(r)
+ }
+ if rf, ok := ret.Get(0).(func(admin.CreateOrganizationUserApiRequest) *admin.OrgUserResponse); ok {
+ r0 = rf(r)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*admin.OrgUserResponse)
+ }
+ }
+
+ if rf, ok := ret.Get(1).(func(admin.CreateOrganizationUserApiRequest) *http.Response); ok {
+ r1 = rf(r)
+ } else {
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(2).(func(admin.CreateOrganizationUserApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
+}
+
+// MongoDBCloudUsersApi_CreateOrganizationUserExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'CreateOrganizationUserExecute'
+type MongoDBCloudUsersApi_CreateOrganizationUserExecute_Call struct {
+ *mock.Call
+}
+
+// CreateOrganizationUserExecute is a helper method to define mock.On call
+// - r admin.CreateOrganizationUserApiRequest
+func (_e *MongoDBCloudUsersApi_Expecter) CreateOrganizationUserExecute(r any) *MongoDBCloudUsersApi_CreateOrganizationUserExecute_Call {
+ return &MongoDBCloudUsersApi_CreateOrganizationUserExecute_Call{Call: _e.mock.On("CreateOrganizationUserExecute", r)}
+}
+
+func (_c *MongoDBCloudUsersApi_CreateOrganizationUserExecute_Call) Run(run func(r admin.CreateOrganizationUserApiRequest)) *MongoDBCloudUsersApi_CreateOrganizationUserExecute_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(admin.CreateOrganizationUserApiRequest))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_CreateOrganizationUserExecute_Call) Return(_a0 *admin.OrgUserResponse, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_CreateOrganizationUserExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_CreateOrganizationUserExecute_Call) RunAndReturn(run func(admin.CreateOrganizationUserApiRequest) (*admin.OrgUserResponse, *http.Response, error)) *MongoDBCloudUsersApi_CreateOrganizationUserExecute_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// CreateOrganizationUserWithParams provides a mock function with given fields: ctx, args
+func (_m *MongoDBCloudUsersApi) CreateOrganizationUserWithParams(ctx context.Context, args *admin.CreateOrganizationUserApiParams) admin.CreateOrganizationUserApiRequest {
+ ret := _m.Called(ctx, args)
+
+ if len(ret) == 0 {
+ panic("no return value specified for CreateOrganizationUserWithParams")
+ }
+
+ var r0 admin.CreateOrganizationUserApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.CreateOrganizationUserApiParams) admin.CreateOrganizationUserApiRequest); ok {
+ r0 = rf(ctx, args)
+ } else {
+ r0 = ret.Get(0).(admin.CreateOrganizationUserApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_CreateOrganizationUserWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'CreateOrganizationUserWithParams'
+type MongoDBCloudUsersApi_CreateOrganizationUserWithParams_Call struct {
+ *mock.Call
+}
+
+// CreateOrganizationUserWithParams is a helper method to define mock.On call
+// - ctx context.Context
+// - args *admin.CreateOrganizationUserApiParams
+func (_e *MongoDBCloudUsersApi_Expecter) CreateOrganizationUserWithParams(ctx any, args any) *MongoDBCloudUsersApi_CreateOrganizationUserWithParams_Call {
+ return &MongoDBCloudUsersApi_CreateOrganizationUserWithParams_Call{Call: _e.mock.On("CreateOrganizationUserWithParams", ctx, args)}
+}
+
+func (_c *MongoDBCloudUsersApi_CreateOrganizationUserWithParams_Call) Run(run func(ctx context.Context, args *admin.CreateOrganizationUserApiParams)) *MongoDBCloudUsersApi_CreateOrganizationUserWithParams_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(*admin.CreateOrganizationUserApiParams))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_CreateOrganizationUserWithParams_Call) Return(_a0 admin.CreateOrganizationUserApiRequest) *MongoDBCloudUsersApi_CreateOrganizationUserWithParams_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_CreateOrganizationUserWithParams_Call) RunAndReturn(run func(context.Context, *admin.CreateOrganizationUserApiParams) admin.CreateOrganizationUserApiRequest) *MongoDBCloudUsersApi_CreateOrganizationUserWithParams_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
// CreateUser provides a mock function with given fields: ctx, cloudAppUser
func (_m *MongoDBCloudUsersApi) CreateUser(ctx context.Context, cloudAppUser *admin.CloudAppUser) admin.CreateUserApiRequest {
ret := _m.Called(ctx, cloudAppUser)
if len(ret) == 0 {
- panic("no return value specified for CreateUser")
+ panic("no return value specified for CreateUser")
+ }
+
+ var r0 admin.CreateUserApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.CloudAppUser) admin.CreateUserApiRequest); ok {
+ r0 = rf(ctx, cloudAppUser)
+ } else {
+ r0 = ret.Get(0).(admin.CreateUserApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_CreateUser_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'CreateUser'
+type MongoDBCloudUsersApi_CreateUser_Call struct {
+ *mock.Call
+}
+
+// CreateUser is a helper method to define mock.On call
+// - ctx context.Context
+// - cloudAppUser *admin.CloudAppUser
+func (_e *MongoDBCloudUsersApi_Expecter) CreateUser(ctx any, cloudAppUser any) *MongoDBCloudUsersApi_CreateUser_Call {
+ return &MongoDBCloudUsersApi_CreateUser_Call{Call: _e.mock.On("CreateUser", ctx, cloudAppUser)}
+}
+
+func (_c *MongoDBCloudUsersApi_CreateUser_Call) Run(run func(ctx context.Context, cloudAppUser *admin.CloudAppUser)) *MongoDBCloudUsersApi_CreateUser_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(*admin.CloudAppUser))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_CreateUser_Call) Return(_a0 admin.CreateUserApiRequest) *MongoDBCloudUsersApi_CreateUser_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_CreateUser_Call) RunAndReturn(run func(context.Context, *admin.CloudAppUser) admin.CreateUserApiRequest) *MongoDBCloudUsersApi_CreateUser_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// CreateUserExecute provides a mock function with given fields: r
+func (_m *MongoDBCloudUsersApi) CreateUserExecute(r admin.CreateUserApiRequest) (*admin.CloudAppUser, *http.Response, error) {
+ ret := _m.Called(r)
+
+ if len(ret) == 0 {
+ panic("no return value specified for CreateUserExecute")
+ }
+
+ var r0 *admin.CloudAppUser
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.CreateUserApiRequest) (*admin.CloudAppUser, *http.Response, error)); ok {
+ return rf(r)
+ }
+ if rf, ok := ret.Get(0).(func(admin.CreateUserApiRequest) *admin.CloudAppUser); ok {
+ r0 = rf(r)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*admin.CloudAppUser)
+ }
+ }
+
+ if rf, ok := ret.Get(1).(func(admin.CreateUserApiRequest) *http.Response); ok {
+ r1 = rf(r)
+ } else {
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(2).(func(admin.CreateUserApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
+}
+
+// MongoDBCloudUsersApi_CreateUserExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'CreateUserExecute'
+type MongoDBCloudUsersApi_CreateUserExecute_Call struct {
+ *mock.Call
+}
+
+// CreateUserExecute is a helper method to define mock.On call
+// - r admin.CreateUserApiRequest
+func (_e *MongoDBCloudUsersApi_Expecter) CreateUserExecute(r any) *MongoDBCloudUsersApi_CreateUserExecute_Call {
+ return &MongoDBCloudUsersApi_CreateUserExecute_Call{Call: _e.mock.On("CreateUserExecute", r)}
+}
+
+func (_c *MongoDBCloudUsersApi_CreateUserExecute_Call) Run(run func(r admin.CreateUserApiRequest)) *MongoDBCloudUsersApi_CreateUserExecute_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(admin.CreateUserApiRequest))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_CreateUserExecute_Call) Return(_a0 *admin.CloudAppUser, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_CreateUserExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_CreateUserExecute_Call) RunAndReturn(run func(admin.CreateUserApiRequest) (*admin.CloudAppUser, *http.Response, error)) *MongoDBCloudUsersApi_CreateUserExecute_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// CreateUserWithParams provides a mock function with given fields: ctx, args
+func (_m *MongoDBCloudUsersApi) CreateUserWithParams(ctx context.Context, args *admin.CreateUserApiParams) admin.CreateUserApiRequest {
+ ret := _m.Called(ctx, args)
+
+ if len(ret) == 0 {
+ panic("no return value specified for CreateUserWithParams")
+ }
+
+ var r0 admin.CreateUserApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.CreateUserApiParams) admin.CreateUserApiRequest); ok {
+ r0 = rf(ctx, args)
+ } else {
+ r0 = ret.Get(0).(admin.CreateUserApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_CreateUserWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'CreateUserWithParams'
+type MongoDBCloudUsersApi_CreateUserWithParams_Call struct {
+ *mock.Call
+}
+
+// CreateUserWithParams is a helper method to define mock.On call
+// - ctx context.Context
+// - args *admin.CreateUserApiParams
+func (_e *MongoDBCloudUsersApi_Expecter) CreateUserWithParams(ctx any, args any) *MongoDBCloudUsersApi_CreateUserWithParams_Call {
+ return &MongoDBCloudUsersApi_CreateUserWithParams_Call{Call: _e.mock.On("CreateUserWithParams", ctx, args)}
+}
+
+func (_c *MongoDBCloudUsersApi_CreateUserWithParams_Call) Run(run func(ctx context.Context, args *admin.CreateUserApiParams)) *MongoDBCloudUsersApi_CreateUserWithParams_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(*admin.CreateUserApiParams))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_CreateUserWithParams_Call) Return(_a0 admin.CreateUserApiRequest) *MongoDBCloudUsersApi_CreateUserWithParams_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_CreateUserWithParams_Call) RunAndReturn(run func(context.Context, *admin.CreateUserApiParams) admin.CreateUserApiRequest) *MongoDBCloudUsersApi_CreateUserWithParams_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetOrganizationUser provides a mock function with given fields: ctx, orgId, userId
+func (_m *MongoDBCloudUsersApi) GetOrganizationUser(ctx context.Context, orgId string, userId string) admin.GetOrganizationUserApiRequest {
+ ret := _m.Called(ctx, orgId, userId)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetOrganizationUser")
+ }
+
+ var r0 admin.GetOrganizationUserApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string, string) admin.GetOrganizationUserApiRequest); ok {
+ r0 = rf(ctx, orgId, userId)
+ } else {
+ r0 = ret.Get(0).(admin.GetOrganizationUserApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_GetOrganizationUser_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetOrganizationUser'
+type MongoDBCloudUsersApi_GetOrganizationUser_Call struct {
+ *mock.Call
+}
+
+// GetOrganizationUser is a helper method to define mock.On call
+// - ctx context.Context
+// - orgId string
+// - userId string
+func (_e *MongoDBCloudUsersApi_Expecter) GetOrganizationUser(ctx any, orgId any, userId any) *MongoDBCloudUsersApi_GetOrganizationUser_Call {
+ return &MongoDBCloudUsersApi_GetOrganizationUser_Call{Call: _e.mock.On("GetOrganizationUser", ctx, orgId, userId)}
+}
+
+func (_c *MongoDBCloudUsersApi_GetOrganizationUser_Call) Run(run func(ctx context.Context, orgId string, userId string)) *MongoDBCloudUsersApi_GetOrganizationUser_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(string), args[2].(string))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetOrganizationUser_Call) Return(_a0 admin.GetOrganizationUserApiRequest) *MongoDBCloudUsersApi_GetOrganizationUser_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetOrganizationUser_Call) RunAndReturn(run func(context.Context, string, string) admin.GetOrganizationUserApiRequest) *MongoDBCloudUsersApi_GetOrganizationUser_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetOrganizationUserExecute provides a mock function with given fields: r
+func (_m *MongoDBCloudUsersApi) GetOrganizationUserExecute(r admin.GetOrganizationUserApiRequest) (*admin.OrgUserResponse, *http.Response, error) {
+ ret := _m.Called(r)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetOrganizationUserExecute")
+ }
+
+ var r0 *admin.OrgUserResponse
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.GetOrganizationUserApiRequest) (*admin.OrgUserResponse, *http.Response, error)); ok {
+ return rf(r)
+ }
+ if rf, ok := ret.Get(0).(func(admin.GetOrganizationUserApiRequest) *admin.OrgUserResponse); ok {
+ r0 = rf(r)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*admin.OrgUserResponse)
+ }
+ }
+
+ if rf, ok := ret.Get(1).(func(admin.GetOrganizationUserApiRequest) *http.Response); ok {
+ r1 = rf(r)
+ } else {
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(2).(func(admin.GetOrganizationUserApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
+}
+
+// MongoDBCloudUsersApi_GetOrganizationUserExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetOrganizationUserExecute'
+type MongoDBCloudUsersApi_GetOrganizationUserExecute_Call struct {
+ *mock.Call
+}
+
+// GetOrganizationUserExecute is a helper method to define mock.On call
+// - r admin.GetOrganizationUserApiRequest
+func (_e *MongoDBCloudUsersApi_Expecter) GetOrganizationUserExecute(r any) *MongoDBCloudUsersApi_GetOrganizationUserExecute_Call {
+ return &MongoDBCloudUsersApi_GetOrganizationUserExecute_Call{Call: _e.mock.On("GetOrganizationUserExecute", r)}
+}
+
+func (_c *MongoDBCloudUsersApi_GetOrganizationUserExecute_Call) Run(run func(r admin.GetOrganizationUserApiRequest)) *MongoDBCloudUsersApi_GetOrganizationUserExecute_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(admin.GetOrganizationUserApiRequest))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetOrganizationUserExecute_Call) Return(_a0 *admin.OrgUserResponse, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_GetOrganizationUserExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetOrganizationUserExecute_Call) RunAndReturn(run func(admin.GetOrganizationUserApiRequest) (*admin.OrgUserResponse, *http.Response, error)) *MongoDBCloudUsersApi_GetOrganizationUserExecute_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetOrganizationUserWithParams provides a mock function with given fields: ctx, args
+func (_m *MongoDBCloudUsersApi) GetOrganizationUserWithParams(ctx context.Context, args *admin.GetOrganizationUserApiParams) admin.GetOrganizationUserApiRequest {
+ ret := _m.Called(ctx, args)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetOrganizationUserWithParams")
+ }
+
+ var r0 admin.GetOrganizationUserApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.GetOrganizationUserApiParams) admin.GetOrganizationUserApiRequest); ok {
+ r0 = rf(ctx, args)
+ } else {
+ r0 = ret.Get(0).(admin.GetOrganizationUserApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_GetOrganizationUserWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetOrganizationUserWithParams'
+type MongoDBCloudUsersApi_GetOrganizationUserWithParams_Call struct {
+ *mock.Call
+}
+
+// GetOrganizationUserWithParams is a helper method to define mock.On call
+// - ctx context.Context
+// - args *admin.GetOrganizationUserApiParams
+func (_e *MongoDBCloudUsersApi_Expecter) GetOrganizationUserWithParams(ctx any, args any) *MongoDBCloudUsersApi_GetOrganizationUserWithParams_Call {
+ return &MongoDBCloudUsersApi_GetOrganizationUserWithParams_Call{Call: _e.mock.On("GetOrganizationUserWithParams", ctx, args)}
+}
+
+func (_c *MongoDBCloudUsersApi_GetOrganizationUserWithParams_Call) Run(run func(ctx context.Context, args *admin.GetOrganizationUserApiParams)) *MongoDBCloudUsersApi_GetOrganizationUserWithParams_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(*admin.GetOrganizationUserApiParams))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetOrganizationUserWithParams_Call) Return(_a0 admin.GetOrganizationUserApiRequest) *MongoDBCloudUsersApi_GetOrganizationUserWithParams_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetOrganizationUserWithParams_Call) RunAndReturn(run func(context.Context, *admin.GetOrganizationUserApiParams) admin.GetOrganizationUserApiRequest) *MongoDBCloudUsersApi_GetOrganizationUserWithParams_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetProjectUser provides a mock function with given fields: ctx, groupId, userId
+func (_m *MongoDBCloudUsersApi) GetProjectUser(ctx context.Context, groupId string, userId string) admin.GetProjectUserApiRequest {
+ ret := _m.Called(ctx, groupId, userId)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetProjectUser")
+ }
+
+ var r0 admin.GetProjectUserApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string, string) admin.GetProjectUserApiRequest); ok {
+ r0 = rf(ctx, groupId, userId)
+ } else {
+ r0 = ret.Get(0).(admin.GetProjectUserApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_GetProjectUser_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetProjectUser'
+type MongoDBCloudUsersApi_GetProjectUser_Call struct {
+ *mock.Call
+}
+
+// GetProjectUser is a helper method to define mock.On call
+// - ctx context.Context
+// - groupId string
+// - userId string
+func (_e *MongoDBCloudUsersApi_Expecter) GetProjectUser(ctx any, groupId any, userId any) *MongoDBCloudUsersApi_GetProjectUser_Call {
+ return &MongoDBCloudUsersApi_GetProjectUser_Call{Call: _e.mock.On("GetProjectUser", ctx, groupId, userId)}
+}
+
+func (_c *MongoDBCloudUsersApi_GetProjectUser_Call) Run(run func(ctx context.Context, groupId string, userId string)) *MongoDBCloudUsersApi_GetProjectUser_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(string), args[2].(string))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetProjectUser_Call) Return(_a0 admin.GetProjectUserApiRequest) *MongoDBCloudUsersApi_GetProjectUser_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetProjectUser_Call) RunAndReturn(run func(context.Context, string, string) admin.GetProjectUserApiRequest) *MongoDBCloudUsersApi_GetProjectUser_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetProjectUserExecute provides a mock function with given fields: r
+func (_m *MongoDBCloudUsersApi) GetProjectUserExecute(r admin.GetProjectUserApiRequest) (*admin.GroupUserResponse, *http.Response, error) {
+ ret := _m.Called(r)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetProjectUserExecute")
+ }
+
+ var r0 *admin.GroupUserResponse
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.GetProjectUserApiRequest) (*admin.GroupUserResponse, *http.Response, error)); ok {
+ return rf(r)
+ }
+ if rf, ok := ret.Get(0).(func(admin.GetProjectUserApiRequest) *admin.GroupUserResponse); ok {
+ r0 = rf(r)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*admin.GroupUserResponse)
+ }
+ }
+
+ if rf, ok := ret.Get(1).(func(admin.GetProjectUserApiRequest) *http.Response); ok {
+ r1 = rf(r)
+ } else {
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(2).(func(admin.GetProjectUserApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
+}
+
+// MongoDBCloudUsersApi_GetProjectUserExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetProjectUserExecute'
+type MongoDBCloudUsersApi_GetProjectUserExecute_Call struct {
+ *mock.Call
+}
+
+// GetProjectUserExecute is a helper method to define mock.On call
+// - r admin.GetProjectUserApiRequest
+func (_e *MongoDBCloudUsersApi_Expecter) GetProjectUserExecute(r any) *MongoDBCloudUsersApi_GetProjectUserExecute_Call {
+ return &MongoDBCloudUsersApi_GetProjectUserExecute_Call{Call: _e.mock.On("GetProjectUserExecute", r)}
+}
+
+func (_c *MongoDBCloudUsersApi_GetProjectUserExecute_Call) Run(run func(r admin.GetProjectUserApiRequest)) *MongoDBCloudUsersApi_GetProjectUserExecute_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(admin.GetProjectUserApiRequest))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetProjectUserExecute_Call) Return(_a0 *admin.GroupUserResponse, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_GetProjectUserExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetProjectUserExecute_Call) RunAndReturn(run func(admin.GetProjectUserApiRequest) (*admin.GroupUserResponse, *http.Response, error)) *MongoDBCloudUsersApi_GetProjectUserExecute_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetProjectUserWithParams provides a mock function with given fields: ctx, args
+func (_m *MongoDBCloudUsersApi) GetProjectUserWithParams(ctx context.Context, args *admin.GetProjectUserApiParams) admin.GetProjectUserApiRequest {
+ ret := _m.Called(ctx, args)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetProjectUserWithParams")
+ }
+
+ var r0 admin.GetProjectUserApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.GetProjectUserApiParams) admin.GetProjectUserApiRequest); ok {
+ r0 = rf(ctx, args)
+ } else {
+ r0 = ret.Get(0).(admin.GetProjectUserApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_GetProjectUserWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetProjectUserWithParams'
+type MongoDBCloudUsersApi_GetProjectUserWithParams_Call struct {
+ *mock.Call
+}
+
+// GetProjectUserWithParams is a helper method to define mock.On call
+// - ctx context.Context
+// - args *admin.GetProjectUserApiParams
+func (_e *MongoDBCloudUsersApi_Expecter) GetProjectUserWithParams(ctx any, args any) *MongoDBCloudUsersApi_GetProjectUserWithParams_Call {
+ return &MongoDBCloudUsersApi_GetProjectUserWithParams_Call{Call: _e.mock.On("GetProjectUserWithParams", ctx, args)}
+}
+
+func (_c *MongoDBCloudUsersApi_GetProjectUserWithParams_Call) Run(run func(ctx context.Context, args *admin.GetProjectUserApiParams)) *MongoDBCloudUsersApi_GetProjectUserWithParams_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(*admin.GetProjectUserApiParams))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetProjectUserWithParams_Call) Return(_a0 admin.GetProjectUserApiRequest) *MongoDBCloudUsersApi_GetProjectUserWithParams_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetProjectUserWithParams_Call) RunAndReturn(run func(context.Context, *admin.GetProjectUserApiParams) admin.GetProjectUserApiRequest) *MongoDBCloudUsersApi_GetProjectUserWithParams_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetUser provides a mock function with given fields: ctx, userId
+func (_m *MongoDBCloudUsersApi) GetUser(ctx context.Context, userId string) admin.GetUserApiRequest {
+ ret := _m.Called(ctx, userId)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetUser")
+ }
+
+ var r0 admin.GetUserApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string) admin.GetUserApiRequest); ok {
+ r0 = rf(ctx, userId)
+ } else {
+ r0 = ret.Get(0).(admin.GetUserApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_GetUser_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetUser'
+type MongoDBCloudUsersApi_GetUser_Call struct {
+ *mock.Call
+}
+
+// GetUser is a helper method to define mock.On call
+// - ctx context.Context
+// - userId string
+func (_e *MongoDBCloudUsersApi_Expecter) GetUser(ctx any, userId any) *MongoDBCloudUsersApi_GetUser_Call {
+ return &MongoDBCloudUsersApi_GetUser_Call{Call: _e.mock.On("GetUser", ctx, userId)}
+}
+
+func (_c *MongoDBCloudUsersApi_GetUser_Call) Run(run func(ctx context.Context, userId string)) *MongoDBCloudUsersApi_GetUser_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(string))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetUser_Call) Return(_a0 admin.GetUserApiRequest) *MongoDBCloudUsersApi_GetUser_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetUser_Call) RunAndReturn(run func(context.Context, string) admin.GetUserApiRequest) *MongoDBCloudUsersApi_GetUser_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetUserByUsername provides a mock function with given fields: ctx, userName
+func (_m *MongoDBCloudUsersApi) GetUserByUsername(ctx context.Context, userName string) admin.GetUserByUsernameApiRequest {
+ ret := _m.Called(ctx, userName)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetUserByUsername")
+ }
+
+ var r0 admin.GetUserByUsernameApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string) admin.GetUserByUsernameApiRequest); ok {
+ r0 = rf(ctx, userName)
+ } else {
+ r0 = ret.Get(0).(admin.GetUserByUsernameApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_GetUserByUsername_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetUserByUsername'
+type MongoDBCloudUsersApi_GetUserByUsername_Call struct {
+ *mock.Call
+}
+
+// GetUserByUsername is a helper method to define mock.On call
+// - ctx context.Context
+// - userName string
+func (_e *MongoDBCloudUsersApi_Expecter) GetUserByUsername(ctx any, userName any) *MongoDBCloudUsersApi_GetUserByUsername_Call {
+ return &MongoDBCloudUsersApi_GetUserByUsername_Call{Call: _e.mock.On("GetUserByUsername", ctx, userName)}
+}
+
+func (_c *MongoDBCloudUsersApi_GetUserByUsername_Call) Run(run func(ctx context.Context, userName string)) *MongoDBCloudUsersApi_GetUserByUsername_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(string))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetUserByUsername_Call) Return(_a0 admin.GetUserByUsernameApiRequest) *MongoDBCloudUsersApi_GetUserByUsername_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetUserByUsername_Call) RunAndReturn(run func(context.Context, string) admin.GetUserByUsernameApiRequest) *MongoDBCloudUsersApi_GetUserByUsername_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetUserByUsernameExecute provides a mock function with given fields: r
+func (_m *MongoDBCloudUsersApi) GetUserByUsernameExecute(r admin.GetUserByUsernameApiRequest) (*admin.CloudAppUser, *http.Response, error) {
+ ret := _m.Called(r)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetUserByUsernameExecute")
}
- var r0 admin.CreateUserApiRequest
- if rf, ok := ret.Get(0).(func(context.Context, *admin.CloudAppUser) admin.CreateUserApiRequest); ok {
- r0 = rf(ctx, cloudAppUser)
+ var r0 *admin.CloudAppUser
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.GetUserByUsernameApiRequest) (*admin.CloudAppUser, *http.Response, error)); ok {
+ return rf(r)
+ }
+ if rf, ok := ret.Get(0).(func(admin.GetUserByUsernameApiRequest) *admin.CloudAppUser); ok {
+ r0 = rf(r)
} else {
- r0 = ret.Get(0).(admin.CreateUserApiRequest)
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*admin.CloudAppUser)
+ }
+ }
+
+ if rf, ok := ret.Get(1).(func(admin.GetUserByUsernameApiRequest) *http.Response); ok {
+ r1 = rf(r)
+ } else {
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(2).(func(admin.GetUserByUsernameApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
+}
+
+// MongoDBCloudUsersApi_GetUserByUsernameExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetUserByUsernameExecute'
+type MongoDBCloudUsersApi_GetUserByUsernameExecute_Call struct {
+ *mock.Call
+}
+
+// GetUserByUsernameExecute is a helper method to define mock.On call
+// - r admin.GetUserByUsernameApiRequest
+func (_e *MongoDBCloudUsersApi_Expecter) GetUserByUsernameExecute(r any) *MongoDBCloudUsersApi_GetUserByUsernameExecute_Call {
+ return &MongoDBCloudUsersApi_GetUserByUsernameExecute_Call{Call: _e.mock.On("GetUserByUsernameExecute", r)}
+}
+
+func (_c *MongoDBCloudUsersApi_GetUserByUsernameExecute_Call) Run(run func(r admin.GetUserByUsernameApiRequest)) *MongoDBCloudUsersApi_GetUserByUsernameExecute_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(admin.GetUserByUsernameApiRequest))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetUserByUsernameExecute_Call) Return(_a0 *admin.CloudAppUser, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_GetUserByUsernameExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetUserByUsernameExecute_Call) RunAndReturn(run func(admin.GetUserByUsernameApiRequest) (*admin.CloudAppUser, *http.Response, error)) *MongoDBCloudUsersApi_GetUserByUsernameExecute_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetUserByUsernameWithParams provides a mock function with given fields: ctx, args
+func (_m *MongoDBCloudUsersApi) GetUserByUsernameWithParams(ctx context.Context, args *admin.GetUserByUsernameApiParams) admin.GetUserByUsernameApiRequest {
+ ret := _m.Called(ctx, args)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetUserByUsernameWithParams")
+ }
+
+ var r0 admin.GetUserByUsernameApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.GetUserByUsernameApiParams) admin.GetUserByUsernameApiRequest); ok {
+ r0 = rf(ctx, args)
+ } else {
+ r0 = ret.Get(0).(admin.GetUserByUsernameApiRequest)
}
return r0
}
-// MongoDBCloudUsersApi_CreateUser_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'CreateUser'
-type MongoDBCloudUsersApi_CreateUser_Call struct {
+// MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetUserByUsernameWithParams'
+type MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call struct {
*mock.Call
}
-// CreateUser is a helper method to define mock.On call
+// GetUserByUsernameWithParams is a helper method to define mock.On call
// - ctx context.Context
-// - cloudAppUser *admin.CloudAppUser
-func (_e *MongoDBCloudUsersApi_Expecter) CreateUser(ctx any, cloudAppUser any) *MongoDBCloudUsersApi_CreateUser_Call {
- return &MongoDBCloudUsersApi_CreateUser_Call{Call: _e.mock.On("CreateUser", ctx, cloudAppUser)}
+// - args *admin.GetUserByUsernameApiParams
+func (_e *MongoDBCloudUsersApi_Expecter) GetUserByUsernameWithParams(ctx any, args any) *MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call {
+ return &MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call{Call: _e.mock.On("GetUserByUsernameWithParams", ctx, args)}
+}
+
+func (_c *MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call) Run(run func(ctx context.Context, args *admin.GetUserByUsernameApiParams)) *MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(*admin.GetUserByUsernameApiParams))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call) Return(_a0 admin.GetUserByUsernameApiRequest) *MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call) RunAndReturn(run func(context.Context, *admin.GetUserByUsernameApiParams) admin.GetUserByUsernameApiRequest) *MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetUserExecute provides a mock function with given fields: r
+func (_m *MongoDBCloudUsersApi) GetUserExecute(r admin.GetUserApiRequest) (*admin.CloudAppUser, *http.Response, error) {
+ ret := _m.Called(r)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetUserExecute")
+ }
+
+ var r0 *admin.CloudAppUser
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.GetUserApiRequest) (*admin.CloudAppUser, *http.Response, error)); ok {
+ return rf(r)
+ }
+ if rf, ok := ret.Get(0).(func(admin.GetUserApiRequest) *admin.CloudAppUser); ok {
+ r0 = rf(r)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*admin.CloudAppUser)
+ }
+ }
+
+ if rf, ok := ret.Get(1).(func(admin.GetUserApiRequest) *http.Response); ok {
+ r1 = rf(r)
+ } else {
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(2).(func(admin.GetUserApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
+}
+
+// MongoDBCloudUsersApi_GetUserExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetUserExecute'
+type MongoDBCloudUsersApi_GetUserExecute_Call struct {
+ *mock.Call
+}
+
+// GetUserExecute is a helper method to define mock.On call
+// - r admin.GetUserApiRequest
+func (_e *MongoDBCloudUsersApi_Expecter) GetUserExecute(r any) *MongoDBCloudUsersApi_GetUserExecute_Call {
+ return &MongoDBCloudUsersApi_GetUserExecute_Call{Call: _e.mock.On("GetUserExecute", r)}
+}
+
+func (_c *MongoDBCloudUsersApi_GetUserExecute_Call) Run(run func(r admin.GetUserApiRequest)) *MongoDBCloudUsersApi_GetUserExecute_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(admin.GetUserApiRequest))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetUserExecute_Call) Return(_a0 *admin.CloudAppUser, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_GetUserExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetUserExecute_Call) RunAndReturn(run func(admin.GetUserApiRequest) (*admin.CloudAppUser, *http.Response, error)) *MongoDBCloudUsersApi_GetUserExecute_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetUserWithParams provides a mock function with given fields: ctx, args
+func (_m *MongoDBCloudUsersApi) GetUserWithParams(ctx context.Context, args *admin.GetUserApiParams) admin.GetUserApiRequest {
+ ret := _m.Called(ctx, args)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetUserWithParams")
+ }
+
+ var r0 admin.GetUserApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.GetUserApiParams) admin.GetUserApiRequest); ok {
+ r0 = rf(ctx, args)
+ } else {
+ r0 = ret.Get(0).(admin.GetUserApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_GetUserWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetUserWithParams'
+type MongoDBCloudUsersApi_GetUserWithParams_Call struct {
+ *mock.Call
+}
+
+// GetUserWithParams is a helper method to define mock.On call
+// - ctx context.Context
+// - args *admin.GetUserApiParams
+func (_e *MongoDBCloudUsersApi_Expecter) GetUserWithParams(ctx any, args any) *MongoDBCloudUsersApi_GetUserWithParams_Call {
+ return &MongoDBCloudUsersApi_GetUserWithParams_Call{Call: _e.mock.On("GetUserWithParams", ctx, args)}
+}
+
+func (_c *MongoDBCloudUsersApi_GetUserWithParams_Call) Run(run func(ctx context.Context, args *admin.GetUserApiParams)) *MongoDBCloudUsersApi_GetUserWithParams_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(*admin.GetUserApiParams))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetUserWithParams_Call) Return(_a0 admin.GetUserApiRequest) *MongoDBCloudUsersApi_GetUserWithParams_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_GetUserWithParams_Call) RunAndReturn(run func(context.Context, *admin.GetUserApiParams) admin.GetUserApiRequest) *MongoDBCloudUsersApi_GetUserWithParams_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// RemoveOrganizationRole provides a mock function with given fields: ctx, orgId, userId, addOrRemoveOrgRole
+func (_m *MongoDBCloudUsersApi) RemoveOrganizationRole(ctx context.Context, orgId string, userId string, addOrRemoveOrgRole *admin.AddOrRemoveOrgRole) admin.RemoveOrganizationRoleApiRequest {
+ ret := _m.Called(ctx, orgId, userId, addOrRemoveOrgRole)
+
+ if len(ret) == 0 {
+ panic("no return value specified for RemoveOrganizationRole")
+ }
+
+ var r0 admin.RemoveOrganizationRoleApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string, string, *admin.AddOrRemoveOrgRole) admin.RemoveOrganizationRoleApiRequest); ok {
+ r0 = rf(ctx, orgId, userId, addOrRemoveOrgRole)
+ } else {
+ r0 = ret.Get(0).(admin.RemoveOrganizationRoleApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_RemoveOrganizationRole_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'RemoveOrganizationRole'
+type MongoDBCloudUsersApi_RemoveOrganizationRole_Call struct {
+ *mock.Call
+}
+
+// RemoveOrganizationRole is a helper method to define mock.On call
+// - ctx context.Context
+// - orgId string
+// - userId string
+// - addOrRemoveOrgRole *admin.AddOrRemoveOrgRole
+func (_e *MongoDBCloudUsersApi_Expecter) RemoveOrganizationRole(ctx any, orgId any, userId any, addOrRemoveOrgRole any) *MongoDBCloudUsersApi_RemoveOrganizationRole_Call {
+ return &MongoDBCloudUsersApi_RemoveOrganizationRole_Call{Call: _e.mock.On("RemoveOrganizationRole", ctx, orgId, userId, addOrRemoveOrgRole)}
}
-func (_c *MongoDBCloudUsersApi_CreateUser_Call) Run(run func(ctx context.Context, cloudAppUser *admin.CloudAppUser)) *MongoDBCloudUsersApi_CreateUser_Call {
+func (_c *MongoDBCloudUsersApi_RemoveOrganizationRole_Call) Run(run func(ctx context.Context, orgId string, userId string, addOrRemoveOrgRole *admin.AddOrRemoveOrgRole)) *MongoDBCloudUsersApi_RemoveOrganizationRole_Call {
_c.Call.Run(func(args mock.Arguments) {
- run(args[0].(context.Context), args[1].(*admin.CloudAppUser))
+ run(args[0].(context.Context), args[1].(string), args[2].(string), args[3].(*admin.AddOrRemoveOrgRole))
})
return _c
}
-func (_c *MongoDBCloudUsersApi_CreateUser_Call) Return(_a0 admin.CreateUserApiRequest) *MongoDBCloudUsersApi_CreateUser_Call {
+func (_c *MongoDBCloudUsersApi_RemoveOrganizationRole_Call) Return(_a0 admin.RemoveOrganizationRoleApiRequest) *MongoDBCloudUsersApi_RemoveOrganizationRole_Call {
_c.Call.Return(_a0)
return _c
}
-func (_c *MongoDBCloudUsersApi_CreateUser_Call) RunAndReturn(run func(context.Context, *admin.CloudAppUser) admin.CreateUserApiRequest) *MongoDBCloudUsersApi_CreateUser_Call {
+func (_c *MongoDBCloudUsersApi_RemoveOrganizationRole_Call) RunAndReturn(run func(context.Context, string, string, *admin.AddOrRemoveOrgRole) admin.RemoveOrganizationRoleApiRequest) *MongoDBCloudUsersApi_RemoveOrganizationRole_Call {
_c.Call.Return(run)
return _c
}
-// CreateUserExecute provides a mock function with given fields: r
-func (_m *MongoDBCloudUsersApi) CreateUserExecute(r admin.CreateUserApiRequest) (*admin.CloudAppUser, *http.Response, error) {
+// RemoveOrganizationRoleExecute provides a mock function with given fields: r
+func (_m *MongoDBCloudUsersApi) RemoveOrganizationRoleExecute(r admin.RemoveOrganizationRoleApiRequest) (*admin.OrgUserResponse, *http.Response, error) {
ret := _m.Called(r)
if len(ret) == 0 {
- panic("no return value specified for CreateUserExecute")
+ panic("no return value specified for RemoveOrganizationRoleExecute")
}
- var r0 *admin.CloudAppUser
+ var r0 *admin.OrgUserResponse
var r1 *http.Response
var r2 error
- if rf, ok := ret.Get(0).(func(admin.CreateUserApiRequest) (*admin.CloudAppUser, *http.Response, error)); ok {
+ if rf, ok := ret.Get(0).(func(admin.RemoveOrganizationRoleApiRequest) (*admin.OrgUserResponse, *http.Response, error)); ok {
return rf(r)
}
- if rf, ok := ret.Get(0).(func(admin.CreateUserApiRequest) *admin.CloudAppUser); ok {
+ if rf, ok := ret.Get(0).(func(admin.RemoveOrganizationRoleApiRequest) *admin.OrgUserResponse); ok {
r0 = rf(r)
} else {
if ret.Get(0) != nil {
- r0 = ret.Get(0).(*admin.CloudAppUser)
+ r0 = ret.Get(0).(*admin.OrgUserResponse)
}
}
- if rf, ok := ret.Get(1).(func(admin.CreateUserApiRequest) *http.Response); ok {
+ if rf, ok := ret.Get(1).(func(admin.RemoveOrganizationRoleApiRequest) *http.Response); ok {
r1 = rf(r)
} else {
if ret.Get(1) != nil {
@@ -102,7 +1724,7 @@ func (_m *MongoDBCloudUsersApi) CreateUserExecute(r admin.CreateUserApiRequest)
}
}
- if rf, ok := ret.Get(2).(func(admin.CreateUserApiRequest) error); ok {
+ if rf, ok := ret.Get(2).(func(admin.RemoveOrganizationRoleApiRequest) error); ok {
r2 = rf(r)
} else {
r2 = ret.Error(2)
@@ -111,198 +1733,316 @@ func (_m *MongoDBCloudUsersApi) CreateUserExecute(r admin.CreateUserApiRequest)
return r0, r1, r2
}
-// MongoDBCloudUsersApi_CreateUserExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'CreateUserExecute'
-type MongoDBCloudUsersApi_CreateUserExecute_Call struct {
+// MongoDBCloudUsersApi_RemoveOrganizationRoleExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'RemoveOrganizationRoleExecute'
+type MongoDBCloudUsersApi_RemoveOrganizationRoleExecute_Call struct {
*mock.Call
}
-// CreateUserExecute is a helper method to define mock.On call
-// - r admin.CreateUserApiRequest
-func (_e *MongoDBCloudUsersApi_Expecter) CreateUserExecute(r any) *MongoDBCloudUsersApi_CreateUserExecute_Call {
- return &MongoDBCloudUsersApi_CreateUserExecute_Call{Call: _e.mock.On("CreateUserExecute", r)}
+// RemoveOrganizationRoleExecute is a helper method to define mock.On call
+// - r admin.RemoveOrganizationRoleApiRequest
+func (_e *MongoDBCloudUsersApi_Expecter) RemoveOrganizationRoleExecute(r any) *MongoDBCloudUsersApi_RemoveOrganizationRoleExecute_Call {
+ return &MongoDBCloudUsersApi_RemoveOrganizationRoleExecute_Call{Call: _e.mock.On("RemoveOrganizationRoleExecute", r)}
}
-func (_c *MongoDBCloudUsersApi_CreateUserExecute_Call) Run(run func(r admin.CreateUserApiRequest)) *MongoDBCloudUsersApi_CreateUserExecute_Call {
+func (_c *MongoDBCloudUsersApi_RemoveOrganizationRoleExecute_Call) Run(run func(r admin.RemoveOrganizationRoleApiRequest)) *MongoDBCloudUsersApi_RemoveOrganizationRoleExecute_Call {
_c.Call.Run(func(args mock.Arguments) {
- run(args[0].(admin.CreateUserApiRequest))
+ run(args[0].(admin.RemoveOrganizationRoleApiRequest))
})
return _c
}
-func (_c *MongoDBCloudUsersApi_CreateUserExecute_Call) Return(_a0 *admin.CloudAppUser, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_CreateUserExecute_Call {
+func (_c *MongoDBCloudUsersApi_RemoveOrganizationRoleExecute_Call) Return(_a0 *admin.OrgUserResponse, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_RemoveOrganizationRoleExecute_Call {
_c.Call.Return(_a0, _a1, _a2)
return _c
}
-func (_c *MongoDBCloudUsersApi_CreateUserExecute_Call) RunAndReturn(run func(admin.CreateUserApiRequest) (*admin.CloudAppUser, *http.Response, error)) *MongoDBCloudUsersApi_CreateUserExecute_Call {
+func (_c *MongoDBCloudUsersApi_RemoveOrganizationRoleExecute_Call) RunAndReturn(run func(admin.RemoveOrganizationRoleApiRequest) (*admin.OrgUserResponse, *http.Response, error)) *MongoDBCloudUsersApi_RemoveOrganizationRoleExecute_Call {
_c.Call.Return(run)
return _c
}
-// CreateUserWithParams provides a mock function with given fields: ctx, args
-func (_m *MongoDBCloudUsersApi) CreateUserWithParams(ctx context.Context, args *admin.CreateUserApiParams) admin.CreateUserApiRequest {
+// RemoveOrganizationRoleWithParams provides a mock function with given fields: ctx, args
+func (_m *MongoDBCloudUsersApi) RemoveOrganizationRoleWithParams(ctx context.Context, args *admin.RemoveOrganizationRoleApiParams) admin.RemoveOrganizationRoleApiRequest {
ret := _m.Called(ctx, args)
if len(ret) == 0 {
- panic("no return value specified for CreateUserWithParams")
+ panic("no return value specified for RemoveOrganizationRoleWithParams")
}
- var r0 admin.CreateUserApiRequest
- if rf, ok := ret.Get(0).(func(context.Context, *admin.CreateUserApiParams) admin.CreateUserApiRequest); ok {
+ var r0 admin.RemoveOrganizationRoleApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.RemoveOrganizationRoleApiParams) admin.RemoveOrganizationRoleApiRequest); ok {
r0 = rf(ctx, args)
} else {
- r0 = ret.Get(0).(admin.CreateUserApiRequest)
+ r0 = ret.Get(0).(admin.RemoveOrganizationRoleApiRequest)
}
return r0
}
-// MongoDBCloudUsersApi_CreateUserWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'CreateUserWithParams'
-type MongoDBCloudUsersApi_CreateUserWithParams_Call struct {
+// MongoDBCloudUsersApi_RemoveOrganizationRoleWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'RemoveOrganizationRoleWithParams'
+type MongoDBCloudUsersApi_RemoveOrganizationRoleWithParams_Call struct {
*mock.Call
}
-// CreateUserWithParams is a helper method to define mock.On call
+// RemoveOrganizationRoleWithParams is a helper method to define mock.On call
// - ctx context.Context
-// - args *admin.CreateUserApiParams
-func (_e *MongoDBCloudUsersApi_Expecter) CreateUserWithParams(ctx any, args any) *MongoDBCloudUsersApi_CreateUserWithParams_Call {
- return &MongoDBCloudUsersApi_CreateUserWithParams_Call{Call: _e.mock.On("CreateUserWithParams", ctx, args)}
+// - args *admin.RemoveOrganizationRoleApiParams
+func (_e *MongoDBCloudUsersApi_Expecter) RemoveOrganizationRoleWithParams(ctx any, args any) *MongoDBCloudUsersApi_RemoveOrganizationRoleWithParams_Call {
+ return &MongoDBCloudUsersApi_RemoveOrganizationRoleWithParams_Call{Call: _e.mock.On("RemoveOrganizationRoleWithParams", ctx, args)}
}
-func (_c *MongoDBCloudUsersApi_CreateUserWithParams_Call) Run(run func(ctx context.Context, args *admin.CreateUserApiParams)) *MongoDBCloudUsersApi_CreateUserWithParams_Call {
+func (_c *MongoDBCloudUsersApi_RemoveOrganizationRoleWithParams_Call) Run(run func(ctx context.Context, args *admin.RemoveOrganizationRoleApiParams)) *MongoDBCloudUsersApi_RemoveOrganizationRoleWithParams_Call {
_c.Call.Run(func(args mock.Arguments) {
- run(args[0].(context.Context), args[1].(*admin.CreateUserApiParams))
+ run(args[0].(context.Context), args[1].(*admin.RemoveOrganizationRoleApiParams))
})
return _c
}
-func (_c *MongoDBCloudUsersApi_CreateUserWithParams_Call) Return(_a0 admin.CreateUserApiRequest) *MongoDBCloudUsersApi_CreateUserWithParams_Call {
+func (_c *MongoDBCloudUsersApi_RemoveOrganizationRoleWithParams_Call) Return(_a0 admin.RemoveOrganizationRoleApiRequest) *MongoDBCloudUsersApi_RemoveOrganizationRoleWithParams_Call {
_c.Call.Return(_a0)
return _c
}
-func (_c *MongoDBCloudUsersApi_CreateUserWithParams_Call) RunAndReturn(run func(context.Context, *admin.CreateUserApiParams) admin.CreateUserApiRequest) *MongoDBCloudUsersApi_CreateUserWithParams_Call {
+func (_c *MongoDBCloudUsersApi_RemoveOrganizationRoleWithParams_Call) RunAndReturn(run func(context.Context, *admin.RemoveOrganizationRoleApiParams) admin.RemoveOrganizationRoleApiRequest) *MongoDBCloudUsersApi_RemoveOrganizationRoleWithParams_Call {
_c.Call.Return(run)
return _c
}
-// GetUser provides a mock function with given fields: ctx, userId
-func (_m *MongoDBCloudUsersApi) GetUser(ctx context.Context, userId string) admin.GetUserApiRequest {
- ret := _m.Called(ctx, userId)
+// RemoveProjectRole provides a mock function with given fields: ctx, groupId, userId, addOrRemoveGroupRole
+func (_m *MongoDBCloudUsersApi) RemoveProjectRole(ctx context.Context, groupId string, userId string, addOrRemoveGroupRole *admin.AddOrRemoveGroupRole) admin.RemoveProjectRoleApiRequest {
+ ret := _m.Called(ctx, groupId, userId, addOrRemoveGroupRole)
if len(ret) == 0 {
- panic("no return value specified for GetUser")
+ panic("no return value specified for RemoveProjectRole")
}
- var r0 admin.GetUserApiRequest
- if rf, ok := ret.Get(0).(func(context.Context, string) admin.GetUserApiRequest); ok {
- r0 = rf(ctx, userId)
+ var r0 admin.RemoveProjectRoleApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string, string, *admin.AddOrRemoveGroupRole) admin.RemoveProjectRoleApiRequest); ok {
+ r0 = rf(ctx, groupId, userId, addOrRemoveGroupRole)
} else {
- r0 = ret.Get(0).(admin.GetUserApiRequest)
+ r0 = ret.Get(0).(admin.RemoveProjectRoleApiRequest)
}
return r0
}
-// MongoDBCloudUsersApi_GetUser_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetUser'
-type MongoDBCloudUsersApi_GetUser_Call struct {
+// MongoDBCloudUsersApi_RemoveProjectRole_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'RemoveProjectRole'
+type MongoDBCloudUsersApi_RemoveProjectRole_Call struct {
*mock.Call
}
-// GetUser is a helper method to define mock.On call
+// RemoveProjectRole is a helper method to define mock.On call
// - ctx context.Context
+// - groupId string
// - userId string
-func (_e *MongoDBCloudUsersApi_Expecter) GetUser(ctx any, userId any) *MongoDBCloudUsersApi_GetUser_Call {
- return &MongoDBCloudUsersApi_GetUser_Call{Call: _e.mock.On("GetUser", ctx, userId)}
+// - addOrRemoveGroupRole *admin.AddOrRemoveGroupRole
+func (_e *MongoDBCloudUsersApi_Expecter) RemoveProjectRole(ctx any, groupId any, userId any, addOrRemoveGroupRole any) *MongoDBCloudUsersApi_RemoveProjectRole_Call {
+ return &MongoDBCloudUsersApi_RemoveProjectRole_Call{Call: _e.mock.On("RemoveProjectRole", ctx, groupId, userId, addOrRemoveGroupRole)}
}
-func (_c *MongoDBCloudUsersApi_GetUser_Call) Run(run func(ctx context.Context, userId string)) *MongoDBCloudUsersApi_GetUser_Call {
+func (_c *MongoDBCloudUsersApi_RemoveProjectRole_Call) Run(run func(ctx context.Context, groupId string, userId string, addOrRemoveGroupRole *admin.AddOrRemoveGroupRole)) *MongoDBCloudUsersApi_RemoveProjectRole_Call {
_c.Call.Run(func(args mock.Arguments) {
- run(args[0].(context.Context), args[1].(string))
+ run(args[0].(context.Context), args[1].(string), args[2].(string), args[3].(*admin.AddOrRemoveGroupRole))
})
return _c
}
-func (_c *MongoDBCloudUsersApi_GetUser_Call) Return(_a0 admin.GetUserApiRequest) *MongoDBCloudUsersApi_GetUser_Call {
+func (_c *MongoDBCloudUsersApi_RemoveProjectRole_Call) Return(_a0 admin.RemoveProjectRoleApiRequest) *MongoDBCloudUsersApi_RemoveProjectRole_Call {
_c.Call.Return(_a0)
return _c
}
-func (_c *MongoDBCloudUsersApi_GetUser_Call) RunAndReturn(run func(context.Context, string) admin.GetUserApiRequest) *MongoDBCloudUsersApi_GetUser_Call {
+func (_c *MongoDBCloudUsersApi_RemoveProjectRole_Call) RunAndReturn(run func(context.Context, string, string, *admin.AddOrRemoveGroupRole) admin.RemoveProjectRoleApiRequest) *MongoDBCloudUsersApi_RemoveProjectRole_Call {
_c.Call.Return(run)
return _c
}
-// GetUserByUsername provides a mock function with given fields: ctx, userName
-func (_m *MongoDBCloudUsersApi) GetUserByUsername(ctx context.Context, userName string) admin.GetUserByUsernameApiRequest {
- ret := _m.Called(ctx, userName)
+// RemoveProjectRoleExecute provides a mock function with given fields: r
+func (_m *MongoDBCloudUsersApi) RemoveProjectRoleExecute(r admin.RemoveProjectRoleApiRequest) (*admin.OrgUserResponse, *http.Response, error) {
+ ret := _m.Called(r)
if len(ret) == 0 {
- panic("no return value specified for GetUserByUsername")
+ panic("no return value specified for RemoveProjectRoleExecute")
}
- var r0 admin.GetUserByUsernameApiRequest
- if rf, ok := ret.Get(0).(func(context.Context, string) admin.GetUserByUsernameApiRequest); ok {
- r0 = rf(ctx, userName)
+ var r0 *admin.OrgUserResponse
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.RemoveProjectRoleApiRequest) (*admin.OrgUserResponse, *http.Response, error)); ok {
+ return rf(r)
+ }
+ if rf, ok := ret.Get(0).(func(admin.RemoveProjectRoleApiRequest) *admin.OrgUserResponse); ok {
+ r0 = rf(r)
} else {
- r0 = ret.Get(0).(admin.GetUserByUsernameApiRequest)
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*admin.OrgUserResponse)
+ }
+ }
+
+ if rf, ok := ret.Get(1).(func(admin.RemoveProjectRoleApiRequest) *http.Response); ok {
+ r1 = rf(r)
+ } else {
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(2).(func(admin.RemoveProjectRoleApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
+}
+
+// MongoDBCloudUsersApi_RemoveProjectRoleExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'RemoveProjectRoleExecute'
+type MongoDBCloudUsersApi_RemoveProjectRoleExecute_Call struct {
+ *mock.Call
+}
+
+// RemoveProjectRoleExecute is a helper method to define mock.On call
+// - r admin.RemoveProjectRoleApiRequest
+func (_e *MongoDBCloudUsersApi_Expecter) RemoveProjectRoleExecute(r any) *MongoDBCloudUsersApi_RemoveProjectRoleExecute_Call {
+ return &MongoDBCloudUsersApi_RemoveProjectRoleExecute_Call{Call: _e.mock.On("RemoveProjectRoleExecute", r)}
+}
+
+func (_c *MongoDBCloudUsersApi_RemoveProjectRoleExecute_Call) Run(run func(r admin.RemoveProjectRoleApiRequest)) *MongoDBCloudUsersApi_RemoveProjectRoleExecute_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(admin.RemoveProjectRoleApiRequest))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_RemoveProjectRoleExecute_Call) Return(_a0 *admin.OrgUserResponse, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_RemoveProjectRoleExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_RemoveProjectRoleExecute_Call) RunAndReturn(run func(admin.RemoveProjectRoleApiRequest) (*admin.OrgUserResponse, *http.Response, error)) *MongoDBCloudUsersApi_RemoveProjectRoleExecute_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// RemoveProjectRoleWithParams provides a mock function with given fields: ctx, args
+func (_m *MongoDBCloudUsersApi) RemoveProjectRoleWithParams(ctx context.Context, args *admin.RemoveProjectRoleApiParams) admin.RemoveProjectRoleApiRequest {
+ ret := _m.Called(ctx, args)
+
+ if len(ret) == 0 {
+ panic("no return value specified for RemoveProjectRoleWithParams")
+ }
+
+ var r0 admin.RemoveProjectRoleApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.RemoveProjectRoleApiParams) admin.RemoveProjectRoleApiRequest); ok {
+ r0 = rf(ctx, args)
+ } else {
+ r0 = ret.Get(0).(admin.RemoveProjectRoleApiRequest)
}
return r0
}
-// MongoDBCloudUsersApi_GetUserByUsername_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetUserByUsername'
-type MongoDBCloudUsersApi_GetUserByUsername_Call struct {
+// MongoDBCloudUsersApi_RemoveProjectRoleWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'RemoveProjectRoleWithParams'
+type MongoDBCloudUsersApi_RemoveProjectRoleWithParams_Call struct {
*mock.Call
}
-// GetUserByUsername is a helper method to define mock.On call
+// RemoveProjectRoleWithParams is a helper method to define mock.On call
// - ctx context.Context
-// - userName string
-func (_e *MongoDBCloudUsersApi_Expecter) GetUserByUsername(ctx any, userName any) *MongoDBCloudUsersApi_GetUserByUsername_Call {
- return &MongoDBCloudUsersApi_GetUserByUsername_Call{Call: _e.mock.On("GetUserByUsername", ctx, userName)}
+// - args *admin.RemoveProjectRoleApiParams
+func (_e *MongoDBCloudUsersApi_Expecter) RemoveProjectRoleWithParams(ctx any, args any) *MongoDBCloudUsersApi_RemoveProjectRoleWithParams_Call {
+ return &MongoDBCloudUsersApi_RemoveProjectRoleWithParams_Call{Call: _e.mock.On("RemoveProjectRoleWithParams", ctx, args)}
}
-func (_c *MongoDBCloudUsersApi_GetUserByUsername_Call) Run(run func(ctx context.Context, userName string)) *MongoDBCloudUsersApi_GetUserByUsername_Call {
+func (_c *MongoDBCloudUsersApi_RemoveProjectRoleWithParams_Call) Run(run func(ctx context.Context, args *admin.RemoveProjectRoleApiParams)) *MongoDBCloudUsersApi_RemoveProjectRoleWithParams_Call {
_c.Call.Run(func(args mock.Arguments) {
- run(args[0].(context.Context), args[1].(string))
+ run(args[0].(context.Context), args[1].(*admin.RemoveProjectRoleApiParams))
})
return _c
}
-func (_c *MongoDBCloudUsersApi_GetUserByUsername_Call) Return(_a0 admin.GetUserByUsernameApiRequest) *MongoDBCloudUsersApi_GetUserByUsername_Call {
+func (_c *MongoDBCloudUsersApi_RemoveProjectRoleWithParams_Call) Return(_a0 admin.RemoveProjectRoleApiRequest) *MongoDBCloudUsersApi_RemoveProjectRoleWithParams_Call {
_c.Call.Return(_a0)
return _c
}
-func (_c *MongoDBCloudUsersApi_GetUserByUsername_Call) RunAndReturn(run func(context.Context, string) admin.GetUserByUsernameApiRequest) *MongoDBCloudUsersApi_GetUserByUsername_Call {
+func (_c *MongoDBCloudUsersApi_RemoveProjectRoleWithParams_Call) RunAndReturn(run func(context.Context, *admin.RemoveProjectRoleApiParams) admin.RemoveProjectRoleApiRequest) *MongoDBCloudUsersApi_RemoveProjectRoleWithParams_Call {
_c.Call.Return(run)
return _c
}
-// GetUserByUsernameExecute provides a mock function with given fields: r
-func (_m *MongoDBCloudUsersApi) GetUserByUsernameExecute(r admin.GetUserByUsernameApiRequest) (*admin.CloudAppUser, *http.Response, error) {
+// RemoveUserFromTeam provides a mock function with given fields: ctx, orgId, teamId, addOrRemoveUserFromTeam
+func (_m *MongoDBCloudUsersApi) RemoveUserFromTeam(ctx context.Context, orgId string, teamId string, addOrRemoveUserFromTeam *admin.AddOrRemoveUserFromTeam) admin.RemoveUserFromTeamApiRequest {
+ ret := _m.Called(ctx, orgId, teamId, addOrRemoveUserFromTeam)
+
+ if len(ret) == 0 {
+ panic("no return value specified for RemoveUserFromTeam")
+ }
+
+ var r0 admin.RemoveUserFromTeamApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string, string, *admin.AddOrRemoveUserFromTeam) admin.RemoveUserFromTeamApiRequest); ok {
+ r0 = rf(ctx, orgId, teamId, addOrRemoveUserFromTeam)
+ } else {
+ r0 = ret.Get(0).(admin.RemoveUserFromTeamApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_RemoveUserFromTeam_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'RemoveUserFromTeam'
+type MongoDBCloudUsersApi_RemoveUserFromTeam_Call struct {
+ *mock.Call
+}
+
+// RemoveUserFromTeam is a helper method to define mock.On call
+// - ctx context.Context
+// - orgId string
+// - teamId string
+// - addOrRemoveUserFromTeam *admin.AddOrRemoveUserFromTeam
+func (_e *MongoDBCloudUsersApi_Expecter) RemoveUserFromTeam(ctx any, orgId any, teamId any, addOrRemoveUserFromTeam any) *MongoDBCloudUsersApi_RemoveUserFromTeam_Call {
+ return &MongoDBCloudUsersApi_RemoveUserFromTeam_Call{Call: _e.mock.On("RemoveUserFromTeam", ctx, orgId, teamId, addOrRemoveUserFromTeam)}
+}
+
+func (_c *MongoDBCloudUsersApi_RemoveUserFromTeam_Call) Run(run func(ctx context.Context, orgId string, teamId string, addOrRemoveUserFromTeam *admin.AddOrRemoveUserFromTeam)) *MongoDBCloudUsersApi_RemoveUserFromTeam_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(string), args[2].(string), args[3].(*admin.AddOrRemoveUserFromTeam))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_RemoveUserFromTeam_Call) Return(_a0 admin.RemoveUserFromTeamApiRequest) *MongoDBCloudUsersApi_RemoveUserFromTeam_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_RemoveUserFromTeam_Call) RunAndReturn(run func(context.Context, string, string, *admin.AddOrRemoveUserFromTeam) admin.RemoveUserFromTeamApiRequest) *MongoDBCloudUsersApi_RemoveUserFromTeam_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// RemoveUserFromTeamExecute provides a mock function with given fields: r
+func (_m *MongoDBCloudUsersApi) RemoveUserFromTeamExecute(r admin.RemoveUserFromTeamApiRequest) (*admin.OrgUserResponse, *http.Response, error) {
ret := _m.Called(r)
if len(ret) == 0 {
- panic("no return value specified for GetUserByUsernameExecute")
+ panic("no return value specified for RemoveUserFromTeamExecute")
}
- var r0 *admin.CloudAppUser
+ var r0 *admin.OrgUserResponse
var r1 *http.Response
var r2 error
- if rf, ok := ret.Get(0).(func(admin.GetUserByUsernameApiRequest) (*admin.CloudAppUser, *http.Response, error)); ok {
+ if rf, ok := ret.Get(0).(func(admin.RemoveUserFromTeamApiRequest) (*admin.OrgUserResponse, *http.Response, error)); ok {
return rf(r)
}
- if rf, ok := ret.Get(0).(func(admin.GetUserByUsernameApiRequest) *admin.CloudAppUser); ok {
+ if rf, ok := ret.Get(0).(func(admin.RemoveUserFromTeamApiRequest) *admin.OrgUserResponse); ok {
r0 = rf(r)
} else {
if ret.Get(0) != nil {
- r0 = ret.Get(0).(*admin.CloudAppUser)
+ r0 = ret.Get(0).(*admin.OrgUserResponse)
}
}
- if rf, ok := ret.Get(1).(func(admin.GetUserByUsernameApiRequest) *http.Response); ok {
+ if rf, ok := ret.Get(1).(func(admin.RemoveUserFromTeamApiRequest) *http.Response); ok {
r1 = rf(r)
} else {
if ret.Get(1) != nil {
@@ -310,7 +2050,7 @@ func (_m *MongoDBCloudUsersApi) GetUserByUsernameExecute(r admin.GetUserByUserna
}
}
- if rf, ok := ret.Get(2).(func(admin.GetUserByUsernameApiRequest) error); ok {
+ if rf, ok := ret.Get(2).(func(admin.RemoveUserFromTeamApiRequest) error); ok {
r2 = rf(r)
} else {
r2 = ret.Error(2)
@@ -319,104 +2059,153 @@ func (_m *MongoDBCloudUsersApi) GetUserByUsernameExecute(r admin.GetUserByUserna
return r0, r1, r2
}
-// MongoDBCloudUsersApi_GetUserByUsernameExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetUserByUsernameExecute'
-type MongoDBCloudUsersApi_GetUserByUsernameExecute_Call struct {
+// MongoDBCloudUsersApi_RemoveUserFromTeamExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'RemoveUserFromTeamExecute'
+type MongoDBCloudUsersApi_RemoveUserFromTeamExecute_Call struct {
*mock.Call
}
-// GetUserByUsernameExecute is a helper method to define mock.On call
-// - r admin.GetUserByUsernameApiRequest
-func (_e *MongoDBCloudUsersApi_Expecter) GetUserByUsernameExecute(r any) *MongoDBCloudUsersApi_GetUserByUsernameExecute_Call {
- return &MongoDBCloudUsersApi_GetUserByUsernameExecute_Call{Call: _e.mock.On("GetUserByUsernameExecute", r)}
+// RemoveUserFromTeamExecute is a helper method to define mock.On call
+// - r admin.RemoveUserFromTeamApiRequest
+func (_e *MongoDBCloudUsersApi_Expecter) RemoveUserFromTeamExecute(r any) *MongoDBCloudUsersApi_RemoveUserFromTeamExecute_Call {
+ return &MongoDBCloudUsersApi_RemoveUserFromTeamExecute_Call{Call: _e.mock.On("RemoveUserFromTeamExecute", r)}
}
-func (_c *MongoDBCloudUsersApi_GetUserByUsernameExecute_Call) Run(run func(r admin.GetUserByUsernameApiRequest)) *MongoDBCloudUsersApi_GetUserByUsernameExecute_Call {
+func (_c *MongoDBCloudUsersApi_RemoveUserFromTeamExecute_Call) Run(run func(r admin.RemoveUserFromTeamApiRequest)) *MongoDBCloudUsersApi_RemoveUserFromTeamExecute_Call {
_c.Call.Run(func(args mock.Arguments) {
- run(args[0].(admin.GetUserByUsernameApiRequest))
+ run(args[0].(admin.RemoveUserFromTeamApiRequest))
})
return _c
}
-func (_c *MongoDBCloudUsersApi_GetUserByUsernameExecute_Call) Return(_a0 *admin.CloudAppUser, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_GetUserByUsernameExecute_Call {
+func (_c *MongoDBCloudUsersApi_RemoveUserFromTeamExecute_Call) Return(_a0 *admin.OrgUserResponse, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_RemoveUserFromTeamExecute_Call {
_c.Call.Return(_a0, _a1, _a2)
return _c
}
-func (_c *MongoDBCloudUsersApi_GetUserByUsernameExecute_Call) RunAndReturn(run func(admin.GetUserByUsernameApiRequest) (*admin.CloudAppUser, *http.Response, error)) *MongoDBCloudUsersApi_GetUserByUsernameExecute_Call {
+func (_c *MongoDBCloudUsersApi_RemoveUserFromTeamExecute_Call) RunAndReturn(run func(admin.RemoveUserFromTeamApiRequest) (*admin.OrgUserResponse, *http.Response, error)) *MongoDBCloudUsersApi_RemoveUserFromTeamExecute_Call {
_c.Call.Return(run)
return _c
}
-// GetUserByUsernameWithParams provides a mock function with given fields: ctx, args
-func (_m *MongoDBCloudUsersApi) GetUserByUsernameWithParams(ctx context.Context, args *admin.GetUserByUsernameApiParams) admin.GetUserByUsernameApiRequest {
+// RemoveUserFromTeamWithParams provides a mock function with given fields: ctx, args
+func (_m *MongoDBCloudUsersApi) RemoveUserFromTeamWithParams(ctx context.Context, args *admin.RemoveUserFromTeamApiParams) admin.RemoveUserFromTeamApiRequest {
ret := _m.Called(ctx, args)
if len(ret) == 0 {
- panic("no return value specified for GetUserByUsernameWithParams")
+ panic("no return value specified for RemoveUserFromTeamWithParams")
}
- var r0 admin.GetUserByUsernameApiRequest
- if rf, ok := ret.Get(0).(func(context.Context, *admin.GetUserByUsernameApiParams) admin.GetUserByUsernameApiRequest); ok {
+ var r0 admin.RemoveUserFromTeamApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.RemoveUserFromTeamApiParams) admin.RemoveUserFromTeamApiRequest); ok {
r0 = rf(ctx, args)
} else {
- r0 = ret.Get(0).(admin.GetUserByUsernameApiRequest)
+ r0 = ret.Get(0).(admin.RemoveUserFromTeamApiRequest)
}
return r0
}
-// MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetUserByUsernameWithParams'
-type MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call struct {
+// MongoDBCloudUsersApi_RemoveUserFromTeamWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'RemoveUserFromTeamWithParams'
+type MongoDBCloudUsersApi_RemoveUserFromTeamWithParams_Call struct {
*mock.Call
}
-// GetUserByUsernameWithParams is a helper method to define mock.On call
+// RemoveUserFromTeamWithParams is a helper method to define mock.On call
// - ctx context.Context
-// - args *admin.GetUserByUsernameApiParams
-func (_e *MongoDBCloudUsersApi_Expecter) GetUserByUsernameWithParams(ctx any, args any) *MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call {
- return &MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call{Call: _e.mock.On("GetUserByUsernameWithParams", ctx, args)}
+// - args *admin.RemoveUserFromTeamApiParams
+func (_e *MongoDBCloudUsersApi_Expecter) RemoveUserFromTeamWithParams(ctx any, args any) *MongoDBCloudUsersApi_RemoveUserFromTeamWithParams_Call {
+ return &MongoDBCloudUsersApi_RemoveUserFromTeamWithParams_Call{Call: _e.mock.On("RemoveUserFromTeamWithParams", ctx, args)}
}
-func (_c *MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call) Run(run func(ctx context.Context, args *admin.GetUserByUsernameApiParams)) *MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call {
+func (_c *MongoDBCloudUsersApi_RemoveUserFromTeamWithParams_Call) Run(run func(ctx context.Context, args *admin.RemoveUserFromTeamApiParams)) *MongoDBCloudUsersApi_RemoveUserFromTeamWithParams_Call {
_c.Call.Run(func(args mock.Arguments) {
- run(args[0].(context.Context), args[1].(*admin.GetUserByUsernameApiParams))
+ run(args[0].(context.Context), args[1].(*admin.RemoveUserFromTeamApiParams))
})
return _c
}
-func (_c *MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call) Return(_a0 admin.GetUserByUsernameApiRequest) *MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call {
+func (_c *MongoDBCloudUsersApi_RemoveUserFromTeamWithParams_Call) Return(_a0 admin.RemoveUserFromTeamApiRequest) *MongoDBCloudUsersApi_RemoveUserFromTeamWithParams_Call {
_c.Call.Return(_a0)
return _c
}
-func (_c *MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call) RunAndReturn(run func(context.Context, *admin.GetUserByUsernameApiParams) admin.GetUserByUsernameApiRequest) *MongoDBCloudUsersApi_GetUserByUsernameWithParams_Call {
+func (_c *MongoDBCloudUsersApi_RemoveUserFromTeamWithParams_Call) RunAndReturn(run func(context.Context, *admin.RemoveUserFromTeamApiParams) admin.RemoveUserFromTeamApiRequest) *MongoDBCloudUsersApi_RemoveUserFromTeamWithParams_Call {
_c.Call.Return(run)
return _c
}
-// GetUserExecute provides a mock function with given fields: r
-func (_m *MongoDBCloudUsersApi) GetUserExecute(r admin.GetUserApiRequest) (*admin.CloudAppUser, *http.Response, error) {
+// UpdateOrganizationUser provides a mock function with given fields: ctx, orgId, userId, orgUserUpdateRequest
+func (_m *MongoDBCloudUsersApi) UpdateOrganizationUser(ctx context.Context, orgId string, userId string, orgUserUpdateRequest *admin.OrgUserUpdateRequest) admin.UpdateOrganizationUserApiRequest {
+ ret := _m.Called(ctx, orgId, userId, orgUserUpdateRequest)
+
+ if len(ret) == 0 {
+ panic("no return value specified for UpdateOrganizationUser")
+ }
+
+ var r0 admin.UpdateOrganizationUserApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string, string, *admin.OrgUserUpdateRequest) admin.UpdateOrganizationUserApiRequest); ok {
+ r0 = rf(ctx, orgId, userId, orgUserUpdateRequest)
+ } else {
+ r0 = ret.Get(0).(admin.UpdateOrganizationUserApiRequest)
+ }
+
+ return r0
+}
+
+// MongoDBCloudUsersApi_UpdateOrganizationUser_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'UpdateOrganizationUser'
+type MongoDBCloudUsersApi_UpdateOrganizationUser_Call struct {
+ *mock.Call
+}
+
+// UpdateOrganizationUser is a helper method to define mock.On call
+// - ctx context.Context
+// - orgId string
+// - userId string
+// - orgUserUpdateRequest *admin.OrgUserUpdateRequest
+func (_e *MongoDBCloudUsersApi_Expecter) UpdateOrganizationUser(ctx any, orgId any, userId any, orgUserUpdateRequest any) *MongoDBCloudUsersApi_UpdateOrganizationUser_Call {
+ return &MongoDBCloudUsersApi_UpdateOrganizationUser_Call{Call: _e.mock.On("UpdateOrganizationUser", ctx, orgId, userId, orgUserUpdateRequest)}
+}
+
+func (_c *MongoDBCloudUsersApi_UpdateOrganizationUser_Call) Run(run func(ctx context.Context, orgId string, userId string, orgUserUpdateRequest *admin.OrgUserUpdateRequest)) *MongoDBCloudUsersApi_UpdateOrganizationUser_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(string), args[2].(string), args[3].(*admin.OrgUserUpdateRequest))
+ })
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_UpdateOrganizationUser_Call) Return(_a0 admin.UpdateOrganizationUserApiRequest) *MongoDBCloudUsersApi_UpdateOrganizationUser_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *MongoDBCloudUsersApi_UpdateOrganizationUser_Call) RunAndReturn(run func(context.Context, string, string, *admin.OrgUserUpdateRequest) admin.UpdateOrganizationUserApiRequest) *MongoDBCloudUsersApi_UpdateOrganizationUser_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// UpdateOrganizationUserExecute provides a mock function with given fields: r
+func (_m *MongoDBCloudUsersApi) UpdateOrganizationUserExecute(r admin.UpdateOrganizationUserApiRequest) (*admin.OrgUserResponse, *http.Response, error) {
ret := _m.Called(r)
if len(ret) == 0 {
- panic("no return value specified for GetUserExecute")
+ panic("no return value specified for UpdateOrganizationUserExecute")
}
- var r0 *admin.CloudAppUser
+ var r0 *admin.OrgUserResponse
var r1 *http.Response
var r2 error
- if rf, ok := ret.Get(0).(func(admin.GetUserApiRequest) (*admin.CloudAppUser, *http.Response, error)); ok {
+ if rf, ok := ret.Get(0).(func(admin.UpdateOrganizationUserApiRequest) (*admin.OrgUserResponse, *http.Response, error)); ok {
return rf(r)
}
- if rf, ok := ret.Get(0).(func(admin.GetUserApiRequest) *admin.CloudAppUser); ok {
+ if rf, ok := ret.Get(0).(func(admin.UpdateOrganizationUserApiRequest) *admin.OrgUserResponse); ok {
r0 = rf(r)
} else {
if ret.Get(0) != nil {
- r0 = ret.Get(0).(*admin.CloudAppUser)
+ r0 = ret.Get(0).(*admin.OrgUserResponse)
}
}
- if rf, ok := ret.Get(1).(func(admin.GetUserApiRequest) *http.Response); ok {
+ if rf, ok := ret.Get(1).(func(admin.UpdateOrganizationUserApiRequest) *http.Response); ok {
r1 = rf(r)
} else {
if ret.Get(1) != nil {
@@ -424,7 +2213,7 @@ func (_m *MongoDBCloudUsersApi) GetUserExecute(r admin.GetUserApiRequest) (*admi
}
}
- if rf, ok := ret.Get(2).(func(admin.GetUserApiRequest) error); ok {
+ if rf, ok := ret.Get(2).(func(admin.UpdateOrganizationUserApiRequest) error); ok {
r2 = rf(r)
} else {
r2 = ret.Error(2)
@@ -433,77 +2222,77 @@ func (_m *MongoDBCloudUsersApi) GetUserExecute(r admin.GetUserApiRequest) (*admi
return r0, r1, r2
}
-// MongoDBCloudUsersApi_GetUserExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetUserExecute'
-type MongoDBCloudUsersApi_GetUserExecute_Call struct {
+// MongoDBCloudUsersApi_UpdateOrganizationUserExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'UpdateOrganizationUserExecute'
+type MongoDBCloudUsersApi_UpdateOrganizationUserExecute_Call struct {
*mock.Call
}
-// GetUserExecute is a helper method to define mock.On call
-// - r admin.GetUserApiRequest
-func (_e *MongoDBCloudUsersApi_Expecter) GetUserExecute(r any) *MongoDBCloudUsersApi_GetUserExecute_Call {
- return &MongoDBCloudUsersApi_GetUserExecute_Call{Call: _e.mock.On("GetUserExecute", r)}
+// UpdateOrganizationUserExecute is a helper method to define mock.On call
+// - r admin.UpdateOrganizationUserApiRequest
+func (_e *MongoDBCloudUsersApi_Expecter) UpdateOrganizationUserExecute(r any) *MongoDBCloudUsersApi_UpdateOrganizationUserExecute_Call {
+ return &MongoDBCloudUsersApi_UpdateOrganizationUserExecute_Call{Call: _e.mock.On("UpdateOrganizationUserExecute", r)}
}
-func (_c *MongoDBCloudUsersApi_GetUserExecute_Call) Run(run func(r admin.GetUserApiRequest)) *MongoDBCloudUsersApi_GetUserExecute_Call {
+func (_c *MongoDBCloudUsersApi_UpdateOrganizationUserExecute_Call) Run(run func(r admin.UpdateOrganizationUserApiRequest)) *MongoDBCloudUsersApi_UpdateOrganizationUserExecute_Call {
_c.Call.Run(func(args mock.Arguments) {
- run(args[0].(admin.GetUserApiRequest))
+ run(args[0].(admin.UpdateOrganizationUserApiRequest))
})
return _c
}
-func (_c *MongoDBCloudUsersApi_GetUserExecute_Call) Return(_a0 *admin.CloudAppUser, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_GetUserExecute_Call {
+func (_c *MongoDBCloudUsersApi_UpdateOrganizationUserExecute_Call) Return(_a0 *admin.OrgUserResponse, _a1 *http.Response, _a2 error) *MongoDBCloudUsersApi_UpdateOrganizationUserExecute_Call {
_c.Call.Return(_a0, _a1, _a2)
return _c
}
-func (_c *MongoDBCloudUsersApi_GetUserExecute_Call) RunAndReturn(run func(admin.GetUserApiRequest) (*admin.CloudAppUser, *http.Response, error)) *MongoDBCloudUsersApi_GetUserExecute_Call {
+func (_c *MongoDBCloudUsersApi_UpdateOrganizationUserExecute_Call) RunAndReturn(run func(admin.UpdateOrganizationUserApiRequest) (*admin.OrgUserResponse, *http.Response, error)) *MongoDBCloudUsersApi_UpdateOrganizationUserExecute_Call {
_c.Call.Return(run)
return _c
}
-// GetUserWithParams provides a mock function with given fields: ctx, args
-func (_m *MongoDBCloudUsersApi) GetUserWithParams(ctx context.Context, args *admin.GetUserApiParams) admin.GetUserApiRequest {
+// UpdateOrganizationUserWithParams provides a mock function with given fields: ctx, args
+func (_m *MongoDBCloudUsersApi) UpdateOrganizationUserWithParams(ctx context.Context, args *admin.UpdateOrganizationUserApiParams) admin.UpdateOrganizationUserApiRequest {
ret := _m.Called(ctx, args)
if len(ret) == 0 {
- panic("no return value specified for GetUserWithParams")
+ panic("no return value specified for UpdateOrganizationUserWithParams")
}
- var r0 admin.GetUserApiRequest
- if rf, ok := ret.Get(0).(func(context.Context, *admin.GetUserApiParams) admin.GetUserApiRequest); ok {
+ var r0 admin.UpdateOrganizationUserApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.UpdateOrganizationUserApiParams) admin.UpdateOrganizationUserApiRequest); ok {
r0 = rf(ctx, args)
} else {
- r0 = ret.Get(0).(admin.GetUserApiRequest)
+ r0 = ret.Get(0).(admin.UpdateOrganizationUserApiRequest)
}
return r0
}
-// MongoDBCloudUsersApi_GetUserWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetUserWithParams'
-type MongoDBCloudUsersApi_GetUserWithParams_Call struct {
+// MongoDBCloudUsersApi_UpdateOrganizationUserWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'UpdateOrganizationUserWithParams'
+type MongoDBCloudUsersApi_UpdateOrganizationUserWithParams_Call struct {
*mock.Call
}
-// GetUserWithParams is a helper method to define mock.On call
+// UpdateOrganizationUserWithParams is a helper method to define mock.On call
// - ctx context.Context
-// - args *admin.GetUserApiParams
-func (_e *MongoDBCloudUsersApi_Expecter) GetUserWithParams(ctx any, args any) *MongoDBCloudUsersApi_GetUserWithParams_Call {
- return &MongoDBCloudUsersApi_GetUserWithParams_Call{Call: _e.mock.On("GetUserWithParams", ctx, args)}
+// - args *admin.UpdateOrganizationUserApiParams
+func (_e *MongoDBCloudUsersApi_Expecter) UpdateOrganizationUserWithParams(ctx any, args any) *MongoDBCloudUsersApi_UpdateOrganizationUserWithParams_Call {
+ return &MongoDBCloudUsersApi_UpdateOrganizationUserWithParams_Call{Call: _e.mock.On("UpdateOrganizationUserWithParams", ctx, args)}
}
-func (_c *MongoDBCloudUsersApi_GetUserWithParams_Call) Run(run func(ctx context.Context, args *admin.GetUserApiParams)) *MongoDBCloudUsersApi_GetUserWithParams_Call {
+func (_c *MongoDBCloudUsersApi_UpdateOrganizationUserWithParams_Call) Run(run func(ctx context.Context, args *admin.UpdateOrganizationUserApiParams)) *MongoDBCloudUsersApi_UpdateOrganizationUserWithParams_Call {
_c.Call.Run(func(args mock.Arguments) {
- run(args[0].(context.Context), args[1].(*admin.GetUserApiParams))
+ run(args[0].(context.Context), args[1].(*admin.UpdateOrganizationUserApiParams))
})
return _c
}
-func (_c *MongoDBCloudUsersApi_GetUserWithParams_Call) Return(_a0 admin.GetUserApiRequest) *MongoDBCloudUsersApi_GetUserWithParams_Call {
+func (_c *MongoDBCloudUsersApi_UpdateOrganizationUserWithParams_Call) Return(_a0 admin.UpdateOrganizationUserApiRequest) *MongoDBCloudUsersApi_UpdateOrganizationUserWithParams_Call {
_c.Call.Return(_a0)
return _c
}
-func (_c *MongoDBCloudUsersApi_GetUserWithParams_Call) RunAndReturn(run func(context.Context, *admin.GetUserApiParams) admin.GetUserApiRequest) *MongoDBCloudUsersApi_GetUserWithParams_Call {
+func (_c *MongoDBCloudUsersApi_UpdateOrganizationUserWithParams_Call) RunAndReturn(run func(context.Context, *admin.UpdateOrganizationUserApiParams) admin.UpdateOrganizationUserApiRequest) *MongoDBCloudUsersApi_UpdateOrganizationUserWithParams_Call {
_c.Call.Return(run)
return _c
}
diff --git a/mockadmin/monitoring_and_logs_api.go b/mockadmin/monitoring_and_logs_api.go
index 50a356b3b..537e8e117 100644
--- a/mockadmin/monitoring_and_logs_api.go
+++ b/mockadmin/monitoring_and_logs_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/network_peering_api.go b/mockadmin/network_peering_api.go
index 1934ccd95..d2b2c4835 100644
--- a/mockadmin/network_peering_api.go
+++ b/mockadmin/network_peering_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/online_archive_api.go b/mockadmin/online_archive_api.go
index 24f33f0b4..7a3806042 100644
--- a/mockadmin/online_archive_api.go
+++ b/mockadmin/online_archive_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/open_api_api.go b/mockadmin/open_api_api.go
new file mode 100644
index 000000000..242eed4ed
--- /dev/null
+++ b/mockadmin/open_api_api.go
@@ -0,0 +1,200 @@
+// Code generated by mockery. DO NOT EDIT.
+
+package mockadmin
+
+import (
+ context "context"
+
+ admin "github.com/mongodb/atlas-sdk-go/admin"
+
+ http "net/http"
+
+ mock "github.com/stretchr/testify/mock"
+)
+
+// OpenAPIApi is an autogenerated mock type for the OpenAPIApi type
+type OpenAPIApi struct {
+ mock.Mock
+}
+
+type OpenAPIApi_Expecter struct {
+ mock *mock.Mock
+}
+
+func (_m *OpenAPIApi) EXPECT() *OpenAPIApi_Expecter {
+ return &OpenAPIApi_Expecter{mock: &_m.Mock}
+}
+
+// GetApiVersions provides a mock function with given fields: ctx
+func (_m *OpenAPIApi) GetApiVersions(ctx context.Context) admin.GetApiVersionsApiRequest {
+ ret := _m.Called(ctx)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetApiVersions")
+ }
+
+ var r0 admin.GetApiVersionsApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context) admin.GetApiVersionsApiRequest); ok {
+ r0 = rf(ctx)
+ } else {
+ r0 = ret.Get(0).(admin.GetApiVersionsApiRequest)
+ }
+
+ return r0
+}
+
+// OpenAPIApi_GetApiVersions_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetApiVersions'
+type OpenAPIApi_GetApiVersions_Call struct {
+ *mock.Call
+}
+
+// GetApiVersions is a helper method to define mock.On call
+// - ctx context.Context
+func (_e *OpenAPIApi_Expecter) GetApiVersions(ctx any) *OpenAPIApi_GetApiVersions_Call {
+ return &OpenAPIApi_GetApiVersions_Call{Call: _e.mock.On("GetApiVersions", ctx)}
+}
+
+func (_c *OpenAPIApi_GetApiVersions_Call) Run(run func(ctx context.Context)) *OpenAPIApi_GetApiVersions_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context))
+ })
+ return _c
+}
+
+func (_c *OpenAPIApi_GetApiVersions_Call) Return(_a0 admin.GetApiVersionsApiRequest) *OpenAPIApi_GetApiVersions_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *OpenAPIApi_GetApiVersions_Call) RunAndReturn(run func(context.Context) admin.GetApiVersionsApiRequest) *OpenAPIApi_GetApiVersions_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetApiVersionsExecute provides a mock function with given fields: r
+func (_m *OpenAPIApi) GetApiVersionsExecute(r admin.GetApiVersionsApiRequest) (*admin.PaginatedApiVersions, *http.Response, error) {
+ ret := _m.Called(r)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetApiVersionsExecute")
+ }
+
+ var r0 *admin.PaginatedApiVersions
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.GetApiVersionsApiRequest) (*admin.PaginatedApiVersions, *http.Response, error)); ok {
+ return rf(r)
+ }
+ if rf, ok := ret.Get(0).(func(admin.GetApiVersionsApiRequest) *admin.PaginatedApiVersions); ok {
+ r0 = rf(r)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*admin.PaginatedApiVersions)
+ }
+ }
+
+ if rf, ok := ret.Get(1).(func(admin.GetApiVersionsApiRequest) *http.Response); ok {
+ r1 = rf(r)
+ } else {
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(2).(func(admin.GetApiVersionsApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
+}
+
+// OpenAPIApi_GetApiVersionsExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetApiVersionsExecute'
+type OpenAPIApi_GetApiVersionsExecute_Call struct {
+ *mock.Call
+}
+
+// GetApiVersionsExecute is a helper method to define mock.On call
+// - r admin.GetApiVersionsApiRequest
+func (_e *OpenAPIApi_Expecter) GetApiVersionsExecute(r any) *OpenAPIApi_GetApiVersionsExecute_Call {
+ return &OpenAPIApi_GetApiVersionsExecute_Call{Call: _e.mock.On("GetApiVersionsExecute", r)}
+}
+
+func (_c *OpenAPIApi_GetApiVersionsExecute_Call) Run(run func(r admin.GetApiVersionsApiRequest)) *OpenAPIApi_GetApiVersionsExecute_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(admin.GetApiVersionsApiRequest))
+ })
+ return _c
+}
+
+func (_c *OpenAPIApi_GetApiVersionsExecute_Call) Return(_a0 *admin.PaginatedApiVersions, _a1 *http.Response, _a2 error) *OpenAPIApi_GetApiVersionsExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
+ return _c
+}
+
+func (_c *OpenAPIApi_GetApiVersionsExecute_Call) RunAndReturn(run func(admin.GetApiVersionsApiRequest) (*admin.PaginatedApiVersions, *http.Response, error)) *OpenAPIApi_GetApiVersionsExecute_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetApiVersionsWithParams provides a mock function with given fields: ctx, args
+func (_m *OpenAPIApi) GetApiVersionsWithParams(ctx context.Context, args *admin.GetApiVersionsApiParams) admin.GetApiVersionsApiRequest {
+ ret := _m.Called(ctx, args)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetApiVersionsWithParams")
+ }
+
+ var r0 admin.GetApiVersionsApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.GetApiVersionsApiParams) admin.GetApiVersionsApiRequest); ok {
+ r0 = rf(ctx, args)
+ } else {
+ r0 = ret.Get(0).(admin.GetApiVersionsApiRequest)
+ }
+
+ return r0
+}
+
+// OpenAPIApi_GetApiVersionsWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetApiVersionsWithParams'
+type OpenAPIApi_GetApiVersionsWithParams_Call struct {
+ *mock.Call
+}
+
+// GetApiVersionsWithParams is a helper method to define mock.On call
+// - ctx context.Context
+// - args *admin.GetApiVersionsApiParams
+func (_e *OpenAPIApi_Expecter) GetApiVersionsWithParams(ctx any, args any) *OpenAPIApi_GetApiVersionsWithParams_Call {
+ return &OpenAPIApi_GetApiVersionsWithParams_Call{Call: _e.mock.On("GetApiVersionsWithParams", ctx, args)}
+}
+
+func (_c *OpenAPIApi_GetApiVersionsWithParams_Call) Run(run func(ctx context.Context, args *admin.GetApiVersionsApiParams)) *OpenAPIApi_GetApiVersionsWithParams_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(*admin.GetApiVersionsApiParams))
+ })
+ return _c
+}
+
+func (_c *OpenAPIApi_GetApiVersionsWithParams_Call) Return(_a0 admin.GetApiVersionsApiRequest) *OpenAPIApi_GetApiVersionsWithParams_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *OpenAPIApi_GetApiVersionsWithParams_Call) RunAndReturn(run func(context.Context, *admin.GetApiVersionsApiParams) admin.GetApiVersionsApiRequest) *OpenAPIApi_GetApiVersionsWithParams_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// NewOpenAPIApi creates a new instance of OpenAPIApi. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
+// The first argument is typically a *testing.T value.
+func NewOpenAPIApi(t interface {
+ mock.TestingT
+ Cleanup(func())
+}) *OpenAPIApi {
+ mock := &OpenAPIApi{}
+ mock.Mock.Test(t)
+
+ t.Cleanup(func() { mock.AssertExpectations(t) })
+
+ return mock
+}
diff --git a/mockadmin/organizations_api.go b/mockadmin/organizations_api.go
index bfc7de56e..67ef780ba 100644
--- a/mockadmin/organizations_api.go
+++ b/mockadmin/organizations_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
@@ -1525,24 +1525,24 @@ func (_c *OrganizationsApi_ListOrganizationUsers_Call) RunAndReturn(run func(con
}
// ListOrganizationUsersExecute provides a mock function with given fields: r
-func (_m *OrganizationsApi) ListOrganizationUsersExecute(r admin.ListOrganizationUsersApiRequest) (*admin.PaginatedAppUser, *http.Response, error) {
+func (_m *OrganizationsApi) ListOrganizationUsersExecute(r admin.ListOrganizationUsersApiRequest) (*admin.PaginatedOrgUser, *http.Response, error) {
ret := _m.Called(r)
if len(ret) == 0 {
panic("no return value specified for ListOrganizationUsersExecute")
}
- var r0 *admin.PaginatedAppUser
+ var r0 *admin.PaginatedOrgUser
var r1 *http.Response
var r2 error
- if rf, ok := ret.Get(0).(func(admin.ListOrganizationUsersApiRequest) (*admin.PaginatedAppUser, *http.Response, error)); ok {
+ if rf, ok := ret.Get(0).(func(admin.ListOrganizationUsersApiRequest) (*admin.PaginatedOrgUser, *http.Response, error)); ok {
return rf(r)
}
- if rf, ok := ret.Get(0).(func(admin.ListOrganizationUsersApiRequest) *admin.PaginatedAppUser); ok {
+ if rf, ok := ret.Get(0).(func(admin.ListOrganizationUsersApiRequest) *admin.PaginatedOrgUser); ok {
r0 = rf(r)
} else {
if ret.Get(0) != nil {
- r0 = ret.Get(0).(*admin.PaginatedAppUser)
+ r0 = ret.Get(0).(*admin.PaginatedOrgUser)
}
}
@@ -1581,12 +1581,12 @@ func (_c *OrganizationsApi_ListOrganizationUsersExecute_Call) Run(run func(r adm
return _c
}
-func (_c *OrganizationsApi_ListOrganizationUsersExecute_Call) Return(_a0 *admin.PaginatedAppUser, _a1 *http.Response, _a2 error) *OrganizationsApi_ListOrganizationUsersExecute_Call {
+func (_c *OrganizationsApi_ListOrganizationUsersExecute_Call) Return(_a0 *admin.PaginatedOrgUser, _a1 *http.Response, _a2 error) *OrganizationsApi_ListOrganizationUsersExecute_Call {
_c.Call.Return(_a0, _a1, _a2)
return _c
}
-func (_c *OrganizationsApi_ListOrganizationUsersExecute_Call) RunAndReturn(run func(admin.ListOrganizationUsersApiRequest) (*admin.PaginatedAppUser, *http.Response, error)) *OrganizationsApi_ListOrganizationUsersExecute_Call {
+func (_c *OrganizationsApi_ListOrganizationUsersExecute_Call) RunAndReturn(run func(admin.ListOrganizationUsersApiRequest) (*admin.PaginatedOrgUser, *http.Response, error)) *OrganizationsApi_ListOrganizationUsersExecute_Call {
_c.Call.Return(run)
return _c
}
diff --git a/mockadmin/performance_advisor_api.go b/mockadmin/performance_advisor_api.go
index 1c5e561d8..414d75542 100644
--- a/mockadmin/performance_advisor_api.go
+++ b/mockadmin/performance_advisor_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
@@ -377,33 +377,40 @@ func (_c *PerformanceAdvisorApi_GetManagedSlowMs_Call) RunAndReturn(run func(con
}
// GetManagedSlowMsExecute provides a mock function with given fields: r
-func (_m *PerformanceAdvisorApi) GetManagedSlowMsExecute(r admin.GetManagedSlowMsApiRequest) (*http.Response, error) {
+func (_m *PerformanceAdvisorApi) GetManagedSlowMsExecute(r admin.GetManagedSlowMsApiRequest) (bool, *http.Response, error) {
ret := _m.Called(r)
if len(ret) == 0 {
panic("no return value specified for GetManagedSlowMsExecute")
}
- var r0 *http.Response
- var r1 error
- if rf, ok := ret.Get(0).(func(admin.GetManagedSlowMsApiRequest) (*http.Response, error)); ok {
+ var r0 bool
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.GetManagedSlowMsApiRequest) (bool, *http.Response, error)); ok {
return rf(r)
}
- if rf, ok := ret.Get(0).(func(admin.GetManagedSlowMsApiRequest) *http.Response); ok {
+ if rf, ok := ret.Get(0).(func(admin.GetManagedSlowMsApiRequest) bool); ok {
r0 = rf(r)
} else {
- if ret.Get(0) != nil {
- r0 = ret.Get(0).(*http.Response)
- }
+ r0 = ret.Get(0).(bool)
}
- if rf, ok := ret.Get(1).(func(admin.GetManagedSlowMsApiRequest) error); ok {
+ if rf, ok := ret.Get(1).(func(admin.GetManagedSlowMsApiRequest) *http.Response); ok {
r1 = rf(r)
} else {
- r1 = ret.Error(1)
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
}
- return r0, r1
+ if rf, ok := ret.Get(2).(func(admin.GetManagedSlowMsApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
}
// PerformanceAdvisorApi_GetManagedSlowMsExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetManagedSlowMsExecute'
@@ -424,12 +431,12 @@ func (_c *PerformanceAdvisorApi_GetManagedSlowMsExecute_Call) Run(run func(r adm
return _c
}
-func (_c *PerformanceAdvisorApi_GetManagedSlowMsExecute_Call) Return(_a0 *http.Response, _a1 error) *PerformanceAdvisorApi_GetManagedSlowMsExecute_Call {
- _c.Call.Return(_a0, _a1)
+func (_c *PerformanceAdvisorApi_GetManagedSlowMsExecute_Call) Return(_a0 bool, _a1 *http.Response, _a2 error) *PerformanceAdvisorApi_GetManagedSlowMsExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
return _c
}
-func (_c *PerformanceAdvisorApi_GetManagedSlowMsExecute_Call) RunAndReturn(run func(admin.GetManagedSlowMsApiRequest) (*http.Response, error)) *PerformanceAdvisorApi_GetManagedSlowMsExecute_Call {
+func (_c *PerformanceAdvisorApi_GetManagedSlowMsExecute_Call) RunAndReturn(run func(admin.GetManagedSlowMsApiRequest) (bool, *http.Response, error)) *PerformanceAdvisorApi_GetManagedSlowMsExecute_Call {
_c.Call.Return(run)
return _c
}
@@ -803,6 +810,330 @@ func (_c *PerformanceAdvisorApi_ListClusterSuggestedIndexesWithParams_Call) RunA
return _c
}
+// ListDropIndexes provides a mock function with given fields: ctx, groupId, clusterName
+func (_m *PerformanceAdvisorApi) ListDropIndexes(ctx context.Context, groupId string, clusterName string) admin.ListDropIndexesApiRequest {
+ ret := _m.Called(ctx, groupId, clusterName)
+
+ if len(ret) == 0 {
+ panic("no return value specified for ListDropIndexes")
+ }
+
+ var r0 admin.ListDropIndexesApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string, string) admin.ListDropIndexesApiRequest); ok {
+ r0 = rf(ctx, groupId, clusterName)
+ } else {
+ r0 = ret.Get(0).(admin.ListDropIndexesApiRequest)
+ }
+
+ return r0
+}
+
+// PerformanceAdvisorApi_ListDropIndexes_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'ListDropIndexes'
+type PerformanceAdvisorApi_ListDropIndexes_Call struct {
+ *mock.Call
+}
+
+// ListDropIndexes is a helper method to define mock.On call
+// - ctx context.Context
+// - groupId string
+// - clusterName string
+func (_e *PerformanceAdvisorApi_Expecter) ListDropIndexes(ctx any, groupId any, clusterName any) *PerformanceAdvisorApi_ListDropIndexes_Call {
+ return &PerformanceAdvisorApi_ListDropIndexes_Call{Call: _e.mock.On("ListDropIndexes", ctx, groupId, clusterName)}
+}
+
+func (_c *PerformanceAdvisorApi_ListDropIndexes_Call) Run(run func(ctx context.Context, groupId string, clusterName string)) *PerformanceAdvisorApi_ListDropIndexes_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(string), args[2].(string))
+ })
+ return _c
+}
+
+func (_c *PerformanceAdvisorApi_ListDropIndexes_Call) Return(_a0 admin.ListDropIndexesApiRequest) *PerformanceAdvisorApi_ListDropIndexes_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *PerformanceAdvisorApi_ListDropIndexes_Call) RunAndReturn(run func(context.Context, string, string) admin.ListDropIndexesApiRequest) *PerformanceAdvisorApi_ListDropIndexes_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// ListDropIndexesExecute provides a mock function with given fields: r
+func (_m *PerformanceAdvisorApi) ListDropIndexesExecute(r admin.ListDropIndexesApiRequest) (*admin.DropIndexSuggestionsResponse, *http.Response, error) {
+ ret := _m.Called(r)
+
+ if len(ret) == 0 {
+ panic("no return value specified for ListDropIndexesExecute")
+ }
+
+ var r0 *admin.DropIndexSuggestionsResponse
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.ListDropIndexesApiRequest) (*admin.DropIndexSuggestionsResponse, *http.Response, error)); ok {
+ return rf(r)
+ }
+ if rf, ok := ret.Get(0).(func(admin.ListDropIndexesApiRequest) *admin.DropIndexSuggestionsResponse); ok {
+ r0 = rf(r)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*admin.DropIndexSuggestionsResponse)
+ }
+ }
+
+ if rf, ok := ret.Get(1).(func(admin.ListDropIndexesApiRequest) *http.Response); ok {
+ r1 = rf(r)
+ } else {
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(2).(func(admin.ListDropIndexesApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
+}
+
+// PerformanceAdvisorApi_ListDropIndexesExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'ListDropIndexesExecute'
+type PerformanceAdvisorApi_ListDropIndexesExecute_Call struct {
+ *mock.Call
+}
+
+// ListDropIndexesExecute is a helper method to define mock.On call
+// - r admin.ListDropIndexesApiRequest
+func (_e *PerformanceAdvisorApi_Expecter) ListDropIndexesExecute(r any) *PerformanceAdvisorApi_ListDropIndexesExecute_Call {
+ return &PerformanceAdvisorApi_ListDropIndexesExecute_Call{Call: _e.mock.On("ListDropIndexesExecute", r)}
+}
+
+func (_c *PerformanceAdvisorApi_ListDropIndexesExecute_Call) Run(run func(r admin.ListDropIndexesApiRequest)) *PerformanceAdvisorApi_ListDropIndexesExecute_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(admin.ListDropIndexesApiRequest))
+ })
+ return _c
+}
+
+func (_c *PerformanceAdvisorApi_ListDropIndexesExecute_Call) Return(_a0 *admin.DropIndexSuggestionsResponse, _a1 *http.Response, _a2 error) *PerformanceAdvisorApi_ListDropIndexesExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
+ return _c
+}
+
+func (_c *PerformanceAdvisorApi_ListDropIndexesExecute_Call) RunAndReturn(run func(admin.ListDropIndexesApiRequest) (*admin.DropIndexSuggestionsResponse, *http.Response, error)) *PerformanceAdvisorApi_ListDropIndexesExecute_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// ListDropIndexesWithParams provides a mock function with given fields: ctx, args
+func (_m *PerformanceAdvisorApi) ListDropIndexesWithParams(ctx context.Context, args *admin.ListDropIndexesApiParams) admin.ListDropIndexesApiRequest {
+ ret := _m.Called(ctx, args)
+
+ if len(ret) == 0 {
+ panic("no return value specified for ListDropIndexesWithParams")
+ }
+
+ var r0 admin.ListDropIndexesApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.ListDropIndexesApiParams) admin.ListDropIndexesApiRequest); ok {
+ r0 = rf(ctx, args)
+ } else {
+ r0 = ret.Get(0).(admin.ListDropIndexesApiRequest)
+ }
+
+ return r0
+}
+
+// PerformanceAdvisorApi_ListDropIndexesWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'ListDropIndexesWithParams'
+type PerformanceAdvisorApi_ListDropIndexesWithParams_Call struct {
+ *mock.Call
+}
+
+// ListDropIndexesWithParams is a helper method to define mock.On call
+// - ctx context.Context
+// - args *admin.ListDropIndexesApiParams
+func (_e *PerformanceAdvisorApi_Expecter) ListDropIndexesWithParams(ctx any, args any) *PerformanceAdvisorApi_ListDropIndexesWithParams_Call {
+ return &PerformanceAdvisorApi_ListDropIndexesWithParams_Call{Call: _e.mock.On("ListDropIndexesWithParams", ctx, args)}
+}
+
+func (_c *PerformanceAdvisorApi_ListDropIndexesWithParams_Call) Run(run func(ctx context.Context, args *admin.ListDropIndexesApiParams)) *PerformanceAdvisorApi_ListDropIndexesWithParams_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(*admin.ListDropIndexesApiParams))
+ })
+ return _c
+}
+
+func (_c *PerformanceAdvisorApi_ListDropIndexesWithParams_Call) Return(_a0 admin.ListDropIndexesApiRequest) *PerformanceAdvisorApi_ListDropIndexesWithParams_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *PerformanceAdvisorApi_ListDropIndexesWithParams_Call) RunAndReturn(run func(context.Context, *admin.ListDropIndexesApiParams) admin.ListDropIndexesApiRequest) *PerformanceAdvisorApi_ListDropIndexesWithParams_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// ListSchemaAdvice provides a mock function with given fields: ctx, groupId, clusterName
+func (_m *PerformanceAdvisorApi) ListSchemaAdvice(ctx context.Context, groupId string, clusterName string) admin.ListSchemaAdviceApiRequest {
+ ret := _m.Called(ctx, groupId, clusterName)
+
+ if len(ret) == 0 {
+ panic("no return value specified for ListSchemaAdvice")
+ }
+
+ var r0 admin.ListSchemaAdviceApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string, string) admin.ListSchemaAdviceApiRequest); ok {
+ r0 = rf(ctx, groupId, clusterName)
+ } else {
+ r0 = ret.Get(0).(admin.ListSchemaAdviceApiRequest)
+ }
+
+ return r0
+}
+
+// PerformanceAdvisorApi_ListSchemaAdvice_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'ListSchemaAdvice'
+type PerformanceAdvisorApi_ListSchemaAdvice_Call struct {
+ *mock.Call
+}
+
+// ListSchemaAdvice is a helper method to define mock.On call
+// - ctx context.Context
+// - groupId string
+// - clusterName string
+func (_e *PerformanceAdvisorApi_Expecter) ListSchemaAdvice(ctx any, groupId any, clusterName any) *PerformanceAdvisorApi_ListSchemaAdvice_Call {
+ return &PerformanceAdvisorApi_ListSchemaAdvice_Call{Call: _e.mock.On("ListSchemaAdvice", ctx, groupId, clusterName)}
+}
+
+func (_c *PerformanceAdvisorApi_ListSchemaAdvice_Call) Run(run func(ctx context.Context, groupId string, clusterName string)) *PerformanceAdvisorApi_ListSchemaAdvice_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(string), args[2].(string))
+ })
+ return _c
+}
+
+func (_c *PerformanceAdvisorApi_ListSchemaAdvice_Call) Return(_a0 admin.ListSchemaAdviceApiRequest) *PerformanceAdvisorApi_ListSchemaAdvice_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *PerformanceAdvisorApi_ListSchemaAdvice_Call) RunAndReturn(run func(context.Context, string, string) admin.ListSchemaAdviceApiRequest) *PerformanceAdvisorApi_ListSchemaAdvice_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// ListSchemaAdviceExecute provides a mock function with given fields: r
+func (_m *PerformanceAdvisorApi) ListSchemaAdviceExecute(r admin.ListSchemaAdviceApiRequest) (*admin.SchemaAdvisorResponse, *http.Response, error) {
+ ret := _m.Called(r)
+
+ if len(ret) == 0 {
+ panic("no return value specified for ListSchemaAdviceExecute")
+ }
+
+ var r0 *admin.SchemaAdvisorResponse
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.ListSchemaAdviceApiRequest) (*admin.SchemaAdvisorResponse, *http.Response, error)); ok {
+ return rf(r)
+ }
+ if rf, ok := ret.Get(0).(func(admin.ListSchemaAdviceApiRequest) *admin.SchemaAdvisorResponse); ok {
+ r0 = rf(r)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*admin.SchemaAdvisorResponse)
+ }
+ }
+
+ if rf, ok := ret.Get(1).(func(admin.ListSchemaAdviceApiRequest) *http.Response); ok {
+ r1 = rf(r)
+ } else {
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(2).(func(admin.ListSchemaAdviceApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
+}
+
+// PerformanceAdvisorApi_ListSchemaAdviceExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'ListSchemaAdviceExecute'
+type PerformanceAdvisorApi_ListSchemaAdviceExecute_Call struct {
+ *mock.Call
+}
+
+// ListSchemaAdviceExecute is a helper method to define mock.On call
+// - r admin.ListSchemaAdviceApiRequest
+func (_e *PerformanceAdvisorApi_Expecter) ListSchemaAdviceExecute(r any) *PerformanceAdvisorApi_ListSchemaAdviceExecute_Call {
+ return &PerformanceAdvisorApi_ListSchemaAdviceExecute_Call{Call: _e.mock.On("ListSchemaAdviceExecute", r)}
+}
+
+func (_c *PerformanceAdvisorApi_ListSchemaAdviceExecute_Call) Run(run func(r admin.ListSchemaAdviceApiRequest)) *PerformanceAdvisorApi_ListSchemaAdviceExecute_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(admin.ListSchemaAdviceApiRequest))
+ })
+ return _c
+}
+
+func (_c *PerformanceAdvisorApi_ListSchemaAdviceExecute_Call) Return(_a0 *admin.SchemaAdvisorResponse, _a1 *http.Response, _a2 error) *PerformanceAdvisorApi_ListSchemaAdviceExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
+ return _c
+}
+
+func (_c *PerformanceAdvisorApi_ListSchemaAdviceExecute_Call) RunAndReturn(run func(admin.ListSchemaAdviceApiRequest) (*admin.SchemaAdvisorResponse, *http.Response, error)) *PerformanceAdvisorApi_ListSchemaAdviceExecute_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// ListSchemaAdviceWithParams provides a mock function with given fields: ctx, args
+func (_m *PerformanceAdvisorApi) ListSchemaAdviceWithParams(ctx context.Context, args *admin.ListSchemaAdviceApiParams) admin.ListSchemaAdviceApiRequest {
+ ret := _m.Called(ctx, args)
+
+ if len(ret) == 0 {
+ panic("no return value specified for ListSchemaAdviceWithParams")
+ }
+
+ var r0 admin.ListSchemaAdviceApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.ListSchemaAdviceApiParams) admin.ListSchemaAdviceApiRequest); ok {
+ r0 = rf(ctx, args)
+ } else {
+ r0 = ret.Get(0).(admin.ListSchemaAdviceApiRequest)
+ }
+
+ return r0
+}
+
+// PerformanceAdvisorApi_ListSchemaAdviceWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'ListSchemaAdviceWithParams'
+type PerformanceAdvisorApi_ListSchemaAdviceWithParams_Call struct {
+ *mock.Call
+}
+
+// ListSchemaAdviceWithParams is a helper method to define mock.On call
+// - ctx context.Context
+// - args *admin.ListSchemaAdviceApiParams
+func (_e *PerformanceAdvisorApi_Expecter) ListSchemaAdviceWithParams(ctx any, args any) *PerformanceAdvisorApi_ListSchemaAdviceWithParams_Call {
+ return &PerformanceAdvisorApi_ListSchemaAdviceWithParams_Call{Call: _e.mock.On("ListSchemaAdviceWithParams", ctx, args)}
+}
+
+func (_c *PerformanceAdvisorApi_ListSchemaAdviceWithParams_Call) Run(run func(ctx context.Context, args *admin.ListSchemaAdviceApiParams)) *PerformanceAdvisorApi_ListSchemaAdviceWithParams_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(*admin.ListSchemaAdviceApiParams))
+ })
+ return _c
+}
+
+func (_c *PerformanceAdvisorApi_ListSchemaAdviceWithParams_Call) Return(_a0 admin.ListSchemaAdviceApiRequest) *PerformanceAdvisorApi_ListSchemaAdviceWithParams_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *PerformanceAdvisorApi_ListSchemaAdviceWithParams_Call) RunAndReturn(run func(context.Context, *admin.ListSchemaAdviceApiParams) admin.ListSchemaAdviceApiRequest) *PerformanceAdvisorApi_ListSchemaAdviceWithParams_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
// ListSlowQueries provides a mock function with given fields: ctx, groupId, processId
func (_m *PerformanceAdvisorApi) ListSlowQueries(ctx context.Context, groupId string, processId string) admin.ListSlowQueriesApiRequest {
ret := _m.Called(ctx, groupId, processId)
diff --git a/mockadmin/private_endpoint_services_api.go b/mockadmin/private_endpoint_services_api.go
index 41ec04133..99c1be4a9 100644
--- a/mockadmin/private_endpoint_services_api.go
+++ b/mockadmin/private_endpoint_services_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/programmatic_api_keys_api.go b/mockadmin/programmatic_api_keys_api.go
index 8b3bb5ef9..e12a3e6ac 100644
--- a/mockadmin/programmatic_api_keys_api.go
+++ b/mockadmin/programmatic_api_keys_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/project_ip_access_list_api.go b/mockadmin/project_ip_access_list_api.go
index cef008f7a..dcb9ffc1b 100644
--- a/mockadmin/project_ip_access_list_api.go
+++ b/mockadmin/project_ip_access_list_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/projects_api.go b/mockadmin/projects_api.go
index 223a15a2e..f44325a8e 100644
--- a/mockadmin/projects_api.go
+++ b/mockadmin/projects_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
@@ -2333,24 +2333,24 @@ func (_c *ProjectsApi_ListProjectUsers_Call) RunAndReturn(run func(context.Conte
}
// ListProjectUsersExecute provides a mock function with given fields: r
-func (_m *ProjectsApi) ListProjectUsersExecute(r admin.ListProjectUsersApiRequest) (*admin.PaginatedAppUser, *http.Response, error) {
+func (_m *ProjectsApi) ListProjectUsersExecute(r admin.ListProjectUsersApiRequest) (*admin.PaginatedGroupUser, *http.Response, error) {
ret := _m.Called(r)
if len(ret) == 0 {
panic("no return value specified for ListProjectUsersExecute")
}
- var r0 *admin.PaginatedAppUser
+ var r0 *admin.PaginatedGroupUser
var r1 *http.Response
var r2 error
- if rf, ok := ret.Get(0).(func(admin.ListProjectUsersApiRequest) (*admin.PaginatedAppUser, *http.Response, error)); ok {
+ if rf, ok := ret.Get(0).(func(admin.ListProjectUsersApiRequest) (*admin.PaginatedGroupUser, *http.Response, error)); ok {
return rf(r)
}
- if rf, ok := ret.Get(0).(func(admin.ListProjectUsersApiRequest) *admin.PaginatedAppUser); ok {
+ if rf, ok := ret.Get(0).(func(admin.ListProjectUsersApiRequest) *admin.PaginatedGroupUser); ok {
r0 = rf(r)
} else {
if ret.Get(0) != nil {
- r0 = ret.Get(0).(*admin.PaginatedAppUser)
+ r0 = ret.Get(0).(*admin.PaginatedGroupUser)
}
}
@@ -2389,12 +2389,12 @@ func (_c *ProjectsApi_ListProjectUsersExecute_Call) Run(run func(r admin.ListPro
return _c
}
-func (_c *ProjectsApi_ListProjectUsersExecute_Call) Return(_a0 *admin.PaginatedAppUser, _a1 *http.Response, _a2 error) *ProjectsApi_ListProjectUsersExecute_Call {
+func (_c *ProjectsApi_ListProjectUsersExecute_Call) Return(_a0 *admin.PaginatedGroupUser, _a1 *http.Response, _a2 error) *ProjectsApi_ListProjectUsersExecute_Call {
_c.Call.Return(_a0, _a1, _a2)
return _c
}
-func (_c *ProjectsApi_ListProjectUsersExecute_Call) RunAndReturn(run func(admin.ListProjectUsersApiRequest) (*admin.PaginatedAppUser, *http.Response, error)) *ProjectsApi_ListProjectUsersExecute_Call {
+func (_c *ProjectsApi_ListProjectUsersExecute_Call) RunAndReturn(run func(admin.ListProjectUsersApiRequest) (*admin.PaginatedGroupUser, *http.Response, error)) *ProjectsApi_ListProjectUsersExecute_Call {
_c.Call.Return(run)
return _c
}
@@ -2817,33 +2817,42 @@ func (_c *ProjectsApi_RemoveProjectUser_Call) RunAndReturn(run func(context.Cont
}
// RemoveProjectUserExecute provides a mock function with given fields: r
-func (_m *ProjectsApi) RemoveProjectUserExecute(r admin.RemoveProjectUserApiRequest) (*http.Response, error) {
+func (_m *ProjectsApi) RemoveProjectUserExecute(r admin.RemoveProjectUserApiRequest) (any, *http.Response, error) {
ret := _m.Called(r)
if len(ret) == 0 {
panic("no return value specified for RemoveProjectUserExecute")
}
- var r0 *http.Response
- var r1 error
- if rf, ok := ret.Get(0).(func(admin.RemoveProjectUserApiRequest) (*http.Response, error)); ok {
+ var r0 any
+ var r1 *http.Response
+ var r2 error
+ if rf, ok := ret.Get(0).(func(admin.RemoveProjectUserApiRequest) (any, *http.Response, error)); ok {
return rf(r)
}
- if rf, ok := ret.Get(0).(func(admin.RemoveProjectUserApiRequest) *http.Response); ok {
+ if rf, ok := ret.Get(0).(func(admin.RemoveProjectUserApiRequest) any); ok {
r0 = rf(r)
} else {
if ret.Get(0) != nil {
- r0 = ret.Get(0).(*http.Response)
+ r0 = ret.Get(0).(any)
}
}
- if rf, ok := ret.Get(1).(func(admin.RemoveProjectUserApiRequest) error); ok {
+ if rf, ok := ret.Get(1).(func(admin.RemoveProjectUserApiRequest) *http.Response); ok {
r1 = rf(r)
} else {
- r1 = ret.Error(1)
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(2).(func(admin.RemoveProjectUserApiRequest) error); ok {
+ r2 = rf(r)
+ } else {
+ r2 = ret.Error(2)
}
- return r0, r1
+ return r0, r1, r2
}
// ProjectsApi_RemoveProjectUserExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'RemoveProjectUserExecute'
@@ -2864,12 +2873,12 @@ func (_c *ProjectsApi_RemoveProjectUserExecute_Call) Run(run func(r admin.Remove
return _c
}
-func (_c *ProjectsApi_RemoveProjectUserExecute_Call) Return(_a0 *http.Response, _a1 error) *ProjectsApi_RemoveProjectUserExecute_Call {
- _c.Call.Return(_a0, _a1)
+func (_c *ProjectsApi_RemoveProjectUserExecute_Call) Return(_a0 any, _a1 *http.Response, _a2 error) *ProjectsApi_RemoveProjectUserExecute_Call {
+ _c.Call.Return(_a0, _a1, _a2)
return _c
}
-func (_c *ProjectsApi_RemoveProjectUserExecute_Call) RunAndReturn(run func(admin.RemoveProjectUserApiRequest) (*http.Response, error)) *ProjectsApi_RemoveProjectUserExecute_Call {
+func (_c *ProjectsApi_RemoveProjectUserExecute_Call) RunAndReturn(run func(admin.RemoveProjectUserApiRequest) (any, *http.Response, error)) *ProjectsApi_RemoveProjectUserExecute_Call {
_c.Call.Return(run)
return _c
}
diff --git a/mockadmin/push_based_log_export_api.go b/mockadmin/push_based_log_export_api.go
index 68b0069b3..d752b72a4 100644
--- a/mockadmin/push_based_log_export_api.go
+++ b/mockadmin/push_based_log_export_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/resource_policies_api.go b/mockadmin/resource_policies_api.go
index 1022cb154..c0f01c298 100644
--- a/mockadmin/resource_policies_api.go
+++ b/mockadmin/resource_policies_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/rolling_index_api.go b/mockadmin/rolling_index_api.go
index e29be9f4e..5076d6676 100644
--- a/mockadmin/rolling_index_api.go
+++ b/mockadmin/rolling_index_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/root_api.go b/mockadmin/root_api.go
index 840b0c631..9428ed577 100644
--- a/mockadmin/root_api.go
+++ b/mockadmin/root_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/serverless_instances_api.go b/mockadmin/serverless_instances_api.go
index 3afec0e0c..73358896b 100644
--- a/mockadmin/serverless_instances_api.go
+++ b/mockadmin/serverless_instances_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/serverless_private_endpoints_api.go b/mockadmin/serverless_private_endpoints_api.go
index 471f8fb7e..f96c0b0ef 100644
--- a/mockadmin/serverless_private_endpoints_api.go
+++ b/mockadmin/serverless_private_endpoints_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/service_accounts_api.go b/mockadmin/service_accounts_api.go
index 48805ce18..da5ed6ba8 100644
--- a/mockadmin/service_accounts_api.go
+++ b/mockadmin/service_accounts_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/shared_tier_restore_jobs_api.go b/mockadmin/shared_tier_restore_jobs_api.go
index e9c2e396b..f461bff4f 100644
--- a/mockadmin/shared_tier_restore_jobs_api.go
+++ b/mockadmin/shared_tier_restore_jobs_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/shared_tier_snapshots_api.go b/mockadmin/shared_tier_snapshots_api.go
index 13fb000b6..5575cd234 100644
--- a/mockadmin/shared_tier_snapshots_api.go
+++ b/mockadmin/shared_tier_snapshots_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/streams_api.go b/mockadmin/streams_api.go
index 99580e253..2d24b032d 100644
--- a/mockadmin/streams_api.go
+++ b/mockadmin/streams_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
@@ -2128,6 +2128,158 @@ func (_c *StreamsApi_GetAccountDetailsWithParams_Call) RunAndReturn(run func(con
return _c
}
+// GetActiveVpcPeeringConnections provides a mock function with given fields: ctx, groupId
+func (_m *StreamsApi) GetActiveVpcPeeringConnections(ctx context.Context, groupId string) admin.GetActiveVpcPeeringConnectionsApiRequest {
+ ret := _m.Called(ctx, groupId)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetActiveVpcPeeringConnections")
+ }
+
+ var r0 admin.GetActiveVpcPeeringConnectionsApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, string) admin.GetActiveVpcPeeringConnectionsApiRequest); ok {
+ r0 = rf(ctx, groupId)
+ } else {
+ r0 = ret.Get(0).(admin.GetActiveVpcPeeringConnectionsApiRequest)
+ }
+
+ return r0
+}
+
+// StreamsApi_GetActiveVpcPeeringConnections_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetActiveVpcPeeringConnections'
+type StreamsApi_GetActiveVpcPeeringConnections_Call struct {
+ *mock.Call
+}
+
+// GetActiveVpcPeeringConnections is a helper method to define mock.On call
+// - ctx context.Context
+// - groupId string
+func (_e *StreamsApi_Expecter) GetActiveVpcPeeringConnections(ctx any, groupId any) *StreamsApi_GetActiveVpcPeeringConnections_Call {
+ return &StreamsApi_GetActiveVpcPeeringConnections_Call{Call: _e.mock.On("GetActiveVpcPeeringConnections", ctx, groupId)}
+}
+
+func (_c *StreamsApi_GetActiveVpcPeeringConnections_Call) Run(run func(ctx context.Context, groupId string)) *StreamsApi_GetActiveVpcPeeringConnections_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(string))
+ })
+ return _c
+}
+
+func (_c *StreamsApi_GetActiveVpcPeeringConnections_Call) Return(_a0 admin.GetActiveVpcPeeringConnectionsApiRequest) *StreamsApi_GetActiveVpcPeeringConnections_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *StreamsApi_GetActiveVpcPeeringConnections_Call) RunAndReturn(run func(context.Context, string) admin.GetActiveVpcPeeringConnectionsApiRequest) *StreamsApi_GetActiveVpcPeeringConnections_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetActiveVpcPeeringConnectionsExecute provides a mock function with given fields: r
+func (_m *StreamsApi) GetActiveVpcPeeringConnectionsExecute(r admin.GetActiveVpcPeeringConnectionsApiRequest) (*http.Response, error) {
+ ret := _m.Called(r)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetActiveVpcPeeringConnectionsExecute")
+ }
+
+ var r0 *http.Response
+ var r1 error
+ if rf, ok := ret.Get(0).(func(admin.GetActiveVpcPeeringConnectionsApiRequest) (*http.Response, error)); ok {
+ return rf(r)
+ }
+ if rf, ok := ret.Get(0).(func(admin.GetActiveVpcPeeringConnectionsApiRequest) *http.Response); ok {
+ r0 = rf(r)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*http.Response)
+ }
+ }
+
+ if rf, ok := ret.Get(1).(func(admin.GetActiveVpcPeeringConnectionsApiRequest) error); ok {
+ r1 = rf(r)
+ } else {
+ r1 = ret.Error(1)
+ }
+
+ return r0, r1
+}
+
+// StreamsApi_GetActiveVpcPeeringConnectionsExecute_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetActiveVpcPeeringConnectionsExecute'
+type StreamsApi_GetActiveVpcPeeringConnectionsExecute_Call struct {
+ *mock.Call
+}
+
+// GetActiveVpcPeeringConnectionsExecute is a helper method to define mock.On call
+// - r admin.GetActiveVpcPeeringConnectionsApiRequest
+func (_e *StreamsApi_Expecter) GetActiveVpcPeeringConnectionsExecute(r any) *StreamsApi_GetActiveVpcPeeringConnectionsExecute_Call {
+ return &StreamsApi_GetActiveVpcPeeringConnectionsExecute_Call{Call: _e.mock.On("GetActiveVpcPeeringConnectionsExecute", r)}
+}
+
+func (_c *StreamsApi_GetActiveVpcPeeringConnectionsExecute_Call) Run(run func(r admin.GetActiveVpcPeeringConnectionsApiRequest)) *StreamsApi_GetActiveVpcPeeringConnectionsExecute_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(admin.GetActiveVpcPeeringConnectionsApiRequest))
+ })
+ return _c
+}
+
+func (_c *StreamsApi_GetActiveVpcPeeringConnectionsExecute_Call) Return(_a0 *http.Response, _a1 error) *StreamsApi_GetActiveVpcPeeringConnectionsExecute_Call {
+ _c.Call.Return(_a0, _a1)
+ return _c
+}
+
+func (_c *StreamsApi_GetActiveVpcPeeringConnectionsExecute_Call) RunAndReturn(run func(admin.GetActiveVpcPeeringConnectionsApiRequest) (*http.Response, error)) *StreamsApi_GetActiveVpcPeeringConnectionsExecute_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
+// GetActiveVpcPeeringConnectionsWithParams provides a mock function with given fields: ctx, args
+func (_m *StreamsApi) GetActiveVpcPeeringConnectionsWithParams(ctx context.Context, args *admin.GetActiveVpcPeeringConnectionsApiParams) admin.GetActiveVpcPeeringConnectionsApiRequest {
+ ret := _m.Called(ctx, args)
+
+ if len(ret) == 0 {
+ panic("no return value specified for GetActiveVpcPeeringConnectionsWithParams")
+ }
+
+ var r0 admin.GetActiveVpcPeeringConnectionsApiRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *admin.GetActiveVpcPeeringConnectionsApiParams) admin.GetActiveVpcPeeringConnectionsApiRequest); ok {
+ r0 = rf(ctx, args)
+ } else {
+ r0 = ret.Get(0).(admin.GetActiveVpcPeeringConnectionsApiRequest)
+ }
+
+ return r0
+}
+
+// StreamsApi_GetActiveVpcPeeringConnectionsWithParams_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'GetActiveVpcPeeringConnectionsWithParams'
+type StreamsApi_GetActiveVpcPeeringConnectionsWithParams_Call struct {
+ *mock.Call
+}
+
+// GetActiveVpcPeeringConnectionsWithParams is a helper method to define mock.On call
+// - ctx context.Context
+// - args *admin.GetActiveVpcPeeringConnectionsApiParams
+func (_e *StreamsApi_Expecter) GetActiveVpcPeeringConnectionsWithParams(ctx any, args any) *StreamsApi_GetActiveVpcPeeringConnectionsWithParams_Call {
+ return &StreamsApi_GetActiveVpcPeeringConnectionsWithParams_Call{Call: _e.mock.On("GetActiveVpcPeeringConnectionsWithParams", ctx, args)}
+}
+
+func (_c *StreamsApi_GetActiveVpcPeeringConnectionsWithParams_Call) Run(run func(ctx context.Context, args *admin.GetActiveVpcPeeringConnectionsApiParams)) *StreamsApi_GetActiveVpcPeeringConnectionsWithParams_Call {
+ _c.Call.Run(func(args mock.Arguments) {
+ run(args[0].(context.Context), args[1].(*admin.GetActiveVpcPeeringConnectionsApiParams))
+ })
+ return _c
+}
+
+func (_c *StreamsApi_GetActiveVpcPeeringConnectionsWithParams_Call) Return(_a0 admin.GetActiveVpcPeeringConnectionsApiRequest) *StreamsApi_GetActiveVpcPeeringConnectionsWithParams_Call {
+ _c.Call.Return(_a0)
+ return _c
+}
+
+func (_c *StreamsApi_GetActiveVpcPeeringConnectionsWithParams_Call) RunAndReturn(run func(context.Context, *admin.GetActiveVpcPeeringConnectionsApiParams) admin.GetActiveVpcPeeringConnectionsApiRequest) *StreamsApi_GetActiveVpcPeeringConnectionsWithParams_Call {
+ _c.Call.Return(run)
+ return _c
+}
+
// GetPrivateLinkConnection provides a mock function with given fields: ctx, groupId, connectionId
func (_m *StreamsApi) GetPrivateLinkConnection(ctx context.Context, groupId string, connectionId string) admin.GetPrivateLinkConnectionApiRequest {
ret := _m.Called(ctx, groupId, connectionId)
diff --git a/mockadmin/teams_api.go b/mockadmin/teams_api.go
index 4b5f3097c..bb1052652 100644
--- a/mockadmin/teams_api.go
+++ b/mockadmin/teams_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
@@ -1369,24 +1369,24 @@ func (_c *TeamsApi_ListTeamUsers_Call) RunAndReturn(run func(context.Context, st
}
// ListTeamUsersExecute provides a mock function with given fields: r
-func (_m *TeamsApi) ListTeamUsersExecute(r admin.ListTeamUsersApiRequest) (*admin.PaginatedAppUser, *http.Response, error) {
+func (_m *TeamsApi) ListTeamUsersExecute(r admin.ListTeamUsersApiRequest) (*admin.PaginatedOrgUser, *http.Response, error) {
ret := _m.Called(r)
if len(ret) == 0 {
panic("no return value specified for ListTeamUsersExecute")
}
- var r0 *admin.PaginatedAppUser
+ var r0 *admin.PaginatedOrgUser
var r1 *http.Response
var r2 error
- if rf, ok := ret.Get(0).(func(admin.ListTeamUsersApiRequest) (*admin.PaginatedAppUser, *http.Response, error)); ok {
+ if rf, ok := ret.Get(0).(func(admin.ListTeamUsersApiRequest) (*admin.PaginatedOrgUser, *http.Response, error)); ok {
return rf(r)
}
- if rf, ok := ret.Get(0).(func(admin.ListTeamUsersApiRequest) *admin.PaginatedAppUser); ok {
+ if rf, ok := ret.Get(0).(func(admin.ListTeamUsersApiRequest) *admin.PaginatedOrgUser); ok {
r0 = rf(r)
} else {
if ret.Get(0) != nil {
- r0 = ret.Get(0).(*admin.PaginatedAppUser)
+ r0 = ret.Get(0).(*admin.PaginatedOrgUser)
}
}
@@ -1425,12 +1425,12 @@ func (_c *TeamsApi_ListTeamUsersExecute_Call) Run(run func(r admin.ListTeamUsers
return _c
}
-func (_c *TeamsApi_ListTeamUsersExecute_Call) Return(_a0 *admin.PaginatedAppUser, _a1 *http.Response, _a2 error) *TeamsApi_ListTeamUsersExecute_Call {
+func (_c *TeamsApi_ListTeamUsersExecute_Call) Return(_a0 *admin.PaginatedOrgUser, _a1 *http.Response, _a2 error) *TeamsApi_ListTeamUsersExecute_Call {
_c.Call.Return(_a0, _a1, _a2)
return _c
}
-func (_c *TeamsApi_ListTeamUsersExecute_Call) RunAndReturn(run func(admin.ListTeamUsersApiRequest) (*admin.PaginatedAppUser, *http.Response, error)) *TeamsApi_ListTeamUsersExecute_Call {
+func (_c *TeamsApi_ListTeamUsersExecute_Call) RunAndReturn(run func(admin.ListTeamUsersApiRequest) (*admin.PaginatedOrgUser, *http.Response, error)) *TeamsApi_ListTeamUsersExecute_Call {
_c.Call.Return(run)
return _c
}
diff --git a/mockadmin/third_party_integrations_api.go b/mockadmin/third_party_integrations_api.go
index cc5677245..3ee1dfa76 100644
--- a/mockadmin/third_party_integrations_api.go
+++ b/mockadmin/third_party_integrations_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/mockadmin/x509_authentication_api.go b/mockadmin/x509_authentication_api.go
index bab8bac25..ed79d3147 100644
--- a/mockadmin/x509_authentication_api.go
+++ b/mockadmin/x509_authentication_api.go
@@ -5,7 +5,7 @@ package mockadmin
import (
context "context"
- admin "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ admin "github.com/mongodb/atlas-sdk-go/admin"
http "net/http"
diff --git a/openapi/atlas-api-transformed.yaml b/openapi/atlas-api-transformed.yaml
index 9f7610b1c..7fc42a912 100644
--- a/openapi/atlas-api-transformed.yaml
+++ b/openapi/atlas-api-transformed.yaml
@@ -12,7 +12,7 @@ info:
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
--digest \
- --header "Accept: application/vnd.atlas.2024-11-13+json" \
+ --header "Accept: application/vnd.atlas.2043-01-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true"
```
@@ -27,7 +27,7 @@ info:
termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
title: MongoDB Atlas Administration API
version: "2.0"
- x-xgen-sha: b30dca0a1318cf8279cab906a13fd2bfa4889cea
+ x-xgen-sha: 27fb2a02f640fb84a8d8e31ca77165b52569054a
servers:
- url: https://cloud.mongodb.com
security:
@@ -275,6 +275,7 @@ paths:
summary: Return the status of this MongoDB application
tags:
- Root
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/getSystemStatus
/api/atlas/v2/alertConfigs/matchers/fieldNames:
get:
description: Get all field names that the `matchers.fieldName` parameter accepts
@@ -299,6 +300,9 @@ paths:
summary: Get All Alert Configuration Matchers Field Names
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/clusters:
get:
description: Returns the details for all clusters in all projects to which you
@@ -325,6 +329,7 @@ paths:
summary: Return All Authorized Clusters in All Projects
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClustersForAllProjects
/api/atlas/v2/eventTypes:
get:
description: Returns a list of all event types, along with a description and
@@ -349,6 +354,7 @@ paths:
summary: List All Possible Event Types
tags:
- Events
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listEventTypes
"/api/atlas/v2/federationSettings/{federationSettingsId}":
delete:
description: "Deletes the federation settings instance and all associated data,
@@ -377,6 +383,7 @@ paths:
summary: Delete One Federation Settings Instance
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationApp
"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs":
get:
description: Returns all connected org configs in the specified federation. To
@@ -406,6 +413,7 @@ paths:
summary: Return All Connected Org Configs from One Federation
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listConnectedOrgConfigs
"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}":
delete:
description: "Removes one connected organization configuration from the
@@ -423,8 +431,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -445,6 +451,7 @@ paths:
summary: Remove One Org Config Connected to One Federation
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeConnectedOrgConfig
get:
description: Returns the specified connected org config from the specified
federation. To use this resource, the requesting API Key must have the
@@ -460,8 +467,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -482,6 +487,7 @@ paths:
summary: Return One Org Config Connected to One Federation
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getConnectedOrgConfig
patch:
description: >-
Updates one connected organization configuration from the specified
@@ -510,8 +516,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -539,6 +543,7 @@ paths:
summary: Update One Org Config Connected to One Federation
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig
"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings":
get:
description: Returns all role mappings from the specified organization in the
@@ -567,6 +572,7 @@ paths:
summary: Return All Role Mappings from One Organization
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listRoleMappings
post:
description: Adds one role mapping to the specified organization in the
specified federation. To use this resource, the requesting API Key must
@@ -601,6 +607,7 @@ paths:
summary: Add One Role Mapping to One Organization
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createRoleMapping
"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}":
delete:
description: Removes one role mapping in the specified organization from the
@@ -617,8 +624,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
- $ref: "#/components/parameters/orgId"
responses:
@@ -638,6 +643,7 @@ paths:
summary: Remove One Role Mapping from One Organization
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteRoleMapping
get:
description: Returns one role mapping from the specified organization in the
specified federation. To use this resource, the requesting API Key must
@@ -653,8 +659,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
- $ref: "#/components/parameters/orgId"
responses:
@@ -676,6 +680,7 @@ paths:
summary: Return One Role Mapping from One Organization
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getRoleMapping
put:
description: Updates one role mapping in the specified organization in the
specified federation. To use this resource, the requesting API Key must
@@ -691,8 +696,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
- $ref: "#/components/parameters/orgId"
requestBody:
@@ -721,6 +724,7 @@ paths:
summary: Update One Role Mapping in One Organization
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateRoleMapping
"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders":
get:
description: Returns all identity providers with the provided protocol and type
@@ -769,6 +773,7 @@ paths:
summary: Return All Identity Providers in One Federation
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listIdentityProviders
post:
description: >-
Creates one identity provider within the specified federation. To use
@@ -808,6 +813,7 @@ paths:
summary: Create One Identity Provider
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createIdentityProvider
"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}":
delete:
description: >-
@@ -845,6 +851,7 @@ paths:
summary: Delete One Identity Provider
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteIdentityProvider
get:
description: "Returns one identity provider in the specified federation by the
identity provider's id. To use this resource, the requesting API Key
@@ -886,6 +893,7 @@ paths:
summary: Return One Identity Provider by ID
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProvider
patch:
description: >-
Updates one identity provider in the specified federation. To use this
@@ -935,6 +943,7 @@ paths:
summary: Update One Identity Provider
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateIdentityProvider
"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks":
delete:
description: >-
@@ -972,6 +981,9 @@ paths:
summary: Revoke the JWKS from One OIDC Identity Provider
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeJwksFromIdentityProvider
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml":
get:
description: Returns the metadata of one identity provider in the specified
@@ -1000,6 +1012,7 @@ paths:
summary: Return the Metadata of One Identity Provider
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProviderMetadata
/api/atlas/v2/groups:
get:
description: Returns details about all projects. Projects group clusters into
@@ -1029,6 +1042,7 @@ paths:
summary: Return All Projects
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjects
post:
description: Creates one project. Projects group clusters into logical
collections that support an application environment, workload, or both.
@@ -1045,8 +1059,6 @@ paths:
name: projectOwnerId
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -1078,6 +1090,7 @@ paths:
summary: Create One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProject
"/api/atlas/v2/groups/byName/{groupName}":
get:
description: Returns details about the specified project. Projects group
@@ -1116,6 +1129,9 @@ paths:
summary: Return One Project using Its Name
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectByName
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}":
delete:
description: Removes the specified project. Projects group clusters into logical
@@ -1144,6 +1160,7 @@ paths:
summary: Remove One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProject
get:
description: Returns details about the specified project. Projects group
clusters into logical collections that support an application
@@ -1170,6 +1187,7 @@ paths:
summary: Return One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProject
patch:
description: Updates the human-readable label that identifies the specified
project, or the tags associated with the project. To use this resource,
@@ -1205,8 +1223,10 @@ paths:
summary: Update One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProject
"/api/atlas/v2/groups/{groupId}/access":
post:
+ deprecated: true
description: Adds one MongoDB Cloud user to the specified project. If the
MongoDB Cloud user is not a member of the project's organization, then
the user must accept their invitation to the organization to access
@@ -1245,6 +1265,10 @@ paths:
summary: Add One MongoDB Cloud User to One Project
tags:
- Projects
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addUserToProject
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/accessList":
get:
description: Returns all access list entries from the specified project's IP
@@ -1283,6 +1307,7 @@ paths:
summary: Return Project IP Access List
tags:
- Project IP Access List
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/listProjectIpAccessLists
post:
description: Adds one or more access list entries to the specified project.
MongoDB Cloud only allows client connections to the cluster from entries
@@ -1334,6 +1359,7 @@ paths:
summary: Add Entries to Project IP Access List
tags:
- Project IP Access List
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/createProjectIpAccessList
"/api/atlas/v2/groups/{groupId}/accessList/{entryValue}":
delete:
description: Removes one access list entry from the specified project's IP
@@ -1397,6 +1423,7 @@ paths:
summary: Remove One Entry from One Project IP Access List
tags:
- Project IP Access List
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/deleteProjectIpAccessList
get:
description: Returns one access list entry from the specified project's IP
access list. Each entry in the project's IP access list contains either
@@ -1450,6 +1477,7 @@ paths:
summary: Return One Project IP Access List Entry
tags:
- Project IP Access List
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpList
"/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status":
get:
description: Returns the status of one project IP access list entry. This
@@ -1490,6 +1518,7 @@ paths:
summary: Return Status of One Project IP Access List Entry
tags:
- Project IP Access List
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpAccessListStatus
"/api/atlas/v2/groups/{groupId}/alertConfigs":
get:
description: >-
@@ -1522,6 +1551,7 @@ paths:
summary: Return All Alert Configurations for One Project
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations
post:
description: >-
Creates one alert configuration for the specified project. Alert
@@ -1558,6 +1588,7 @@ paths:
summary: Create One Alert Configuration in One Project
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration
"/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}":
delete:
description: >-
@@ -1581,8 +1612,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -1599,6 +1628,7 @@ paths:
summary: Remove One Alert Configuration from One Project
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteAlertConfiguration
get:
description: >-
Returns the specified alert configuration from the specified project. To
@@ -1621,8 +1651,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -1641,6 +1669,7 @@ paths:
summary: Return One Alert Configuration from One Project
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getAlertConfiguration
patch:
description: >-
Enables or disables the specified alert configuration in the specified
@@ -1669,8 +1698,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -1697,6 +1724,7 @@ paths:
summary: Toggle One State of One Alert Configuration in One Project
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration
put:
description: >-
Updates one alert configuration in the specified project. Alert
@@ -1723,8 +1751,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -1752,6 +1778,7 @@ paths:
summary: Update One Alert Configuration for One Project
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration
"/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts":
get:
description: >-
@@ -1780,8 +1807,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -1800,6 +1825,7 @@ paths:
summary: Return All Open Alerts for Alert Configuration
tags:
- Alerts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlertsByAlertConfigurationId
"/api/atlas/v2/groups/{groupId}/alerts":
get:
description: >-
@@ -1839,6 +1865,7 @@ paths:
summary: Return All Alerts from One Project
tags:
- Alerts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts
"/api/atlas/v2/groups/{groupId}/alerts/{alertId}":
get:
description: >-
@@ -1860,8 +1887,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -1880,6 +1905,7 @@ paths:
summary: Return One Alert from One Project
tags:
- Alerts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getAlert
patch:
description: >-
Confirms receipt of one existing alert. This alert applies to any
@@ -1902,8 +1928,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -1931,6 +1955,7 @@ paths:
summary: Acknowledge One Alert from One Project
tags:
- Alerts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert
"/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs":
get:
description: >-
@@ -1954,8 +1979,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -1974,6 +1997,7 @@ paths:
summary: Return All Alert Configurations Set for One Alert
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationsByAlertId
"/api/atlas/v2/groups/{groupId}/apiKeys":
get:
description: Returns all organization API keys that you assigned to the
@@ -2005,6 +2029,7 @@ paths:
summary: Return All Organization API Keys Assigned to One Project
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listProjectApiKeys
post:
description: Creates and assigns the specified organization API key to the
specified project. Users with the Project Owner role in the project
@@ -2037,6 +2062,9 @@ paths:
summary: Create and Assign One Organization API Key to One Project
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}":
delete:
description: Removes one organization API key from the specified project. To use
@@ -2054,8 +2082,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -2074,6 +2100,7 @@ paths:
summary: Unassign One Organization API Key from One Project
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeProjectApiKey
patch:
description: Updates the roles of the organization API key that you specify for
the project that you specify. You must specify at least one valid role
@@ -2093,8 +2120,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -2121,6 +2146,7 @@ paths:
summary: Update Roles of One Organization API Key to One Project
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKeyRoles
post:
description: Assigns the specified organization API key to the specified
project. Users with the Project Owner role in the project associated
@@ -2137,8 +2163,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -2164,6 +2188,7 @@ paths:
summary: Assign One Organization API Key to One Project
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey
"/api/atlas/v2/groups/{groupId}/auditLog":
get:
description: Returns the auditing configuration for the specified project. The
@@ -2189,6 +2214,7 @@ paths:
summary: Return the Auditing Configuration for One Project
tags:
- Auditing
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getAuditingConfiguration
patch:
description: Updates the auditing configuration for the specified project. The
auditing configuration defines the events that MongoDB Cloud records in
@@ -2222,6 +2248,7 @@ paths:
summary: Update Auditing Configuration for One Project
tags:
- Auditing
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateAuditingConfiguration
"/api/atlas/v2/groups/{groupId}/awsCustomDNS":
get:
description: Returns the custom DNS configuration for AWS clusters in the
@@ -2245,6 +2272,7 @@ paths:
summary: Return One Custom DNS Configuration for Atlas Clusters on AWS
tags:
- AWS Clusters DNS
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getAwsCustomDns
patch:
description: Enables or disables the custom DNS configuration for AWS clusters
in the specified project. Enable custom DNS if you use AWS VPC peering
@@ -2276,6 +2304,7 @@ paths:
summary: Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS
tags:
- AWS Clusters DNS
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns
"/api/atlas/v2/groups/{groupId}/backup/exportBuckets":
get:
description: "Returns all Export Buckets associated with the specified Project.
@@ -2302,6 +2331,7 @@ paths:
summary: Return All Snapshot Export Buckets
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listExportBuckets
post:
description: "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure
Blob Storage Container. Once created, an snapshots can be exported to
@@ -2375,12 +2405,15 @@ paths:
summary: Create One Snapshot Export Bucket
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createExportBucket
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}":
delete:
description: Deletes an Export Bucket. Auto export must be disabled on all
clusters in this Project exporting to this Export Bucket before revoking
access. To use this resource, the requesting API Key must have the
- Project Owner role.
+ Project Backup Manager role.
operationId: deleteExportBucket
parameters:
- $ref: "#/components/parameters/groupId"
@@ -2392,8 +2425,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -2414,6 +2445,7 @@ paths:
summary: Delete One Snapshot Export Bucket
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteExportBucket
get:
description: "Returns one Export Bucket associated with the specified Project.
To use this resource, the requesting API Key must have the Project Read
@@ -2429,8 +2461,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -2472,6 +2502,9 @@ paths:
summary: Return One Snapshot Export Bucket
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getExportBucket
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/backupCompliancePolicy":
delete:
description: Disables the Backup Compliance Policy settings with the specified
@@ -2502,6 +2535,7 @@ paths:
summary: Disable the Backup Compliance Policy settings
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableDataProtectionSettings
get:
description: "Returns the Backup Compliance Policy settings with the specified
project. To use this resource, the requesting API Key must have the
@@ -2526,6 +2560,7 @@ paths:
summary: Return the Backup Compliance Policy settings
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getDataProtectionSettings
put:
description: "Updates the Backup Compliance Policy settings for the specified
project. To use this resource, the requesting API Key must have the
@@ -2567,6 +2602,7 @@ paths:
summary: Update or enable the Backup Compliance Policy settings
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateDataProtectionSettings
"/api/atlas/v2/groups/{groupId}/cloudProviderAccess":
get:
description: Returns all cloud provider access roles with access to the
@@ -2590,6 +2626,7 @@ paths:
summary: Return All Cloud Provider Access Roles
tags:
- Cloud Provider Access
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listCloudProviderAccessRoles
post:
description: Creates one access role for the specified cloud provider. Some
MongoDB Cloud features use these cloud provider access roles for
@@ -2623,6 +2660,7 @@ paths:
summary: Create One Cloud Provider Access Role
tags:
- Cloud Provider Access
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/createCloudProviderAccessRole
"/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}":
delete:
description: Revokes access to the specified project for the specified access
@@ -2644,8 +2682,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -2662,6 +2698,9 @@ paths:
summary: Deauthorize One Cloud Provider Access Role
tags:
- Cloud Provider Access
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}":
get:
description: Returns the access role with the specified id and with access to
@@ -2676,8 +2715,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -2694,6 +2731,7 @@ paths:
summary: Return specified Cloud Provider Access Role
tags:
- Cloud Provider Access
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/getCloudProviderAccessRole
patch:
description: Grants access to the specified project for the specified access
role. To use this resource, the requesting API Key must have the Project
@@ -2712,8 +2750,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -2741,15 +2777,22 @@ paths:
summary: Authorize One Cloud Provider Access Role
tags:
- Cloud Provider Access
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole
"/api/atlas/v2/groups/{groupId}/clusters":
get:
- description: "Returns the details for all clusters in the specific project to
- which you have access. Clusters contain a group of hosts that maintain
- the same data set. The response includes clusters with
- asymmetrically-sized shards. To use this resource, the requesting API
- Key must have the Project Read Only role. This feature is not available
- for serverless clusters. Deprecated versions: v2-{2023-02-01},
- v2-{2023-01-01}"
+ description: >-
+ Returns the details for all clusters in the specific project to which
+ you have access. Clusters contain a group of hosts that maintain the
+ same data set. The response includes clusters with asymmetrically-sized
+ shards. To use this resource, the requesting API Key must have the
+ Project Read Only role. This feature is not available for serverless
+ clusters.
+
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the listFlexClusters endpoint for Flex clusters instead. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}
+ externalDocs:
+ description: listFlexClusters
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters
operationId: listClusters
parameters:
- $ref: "#/components/parameters/groupId"
@@ -2777,14 +2820,21 @@ paths:
summary: Return All Clusters in One Project
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters
post:
- description: "Creates one cluster in the specified project. Clusters contain a
- group of hosts that maintain the same data set. This resource can create
+ description: >-
+ Creates one cluster in the specified project. Clusters contain a group
+ of hosts that maintain the same data set. This resource can create
clusters with asymmetrically-sized shards. Each project supports up to
25 database deployments. To use this resource, the requesting API Key
must have the Project Owner role. This feature is not available for
- serverless clusters. Deprecated versions: v2-{2024-08-05},
- v2-{2023-02-01}, v2-{2023-01-01}"
+ serverless clusters.
+
+
+ Please note that using an instanceSize of M2 or M5 will create a Flex cluster instead. Support for the instanceSize of M2 or M5 will be discontinued in January 2026. We recommend using the createFlexCluster API for such configurations moving forward. Deprecated versions: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}
+ externalDocs:
+ description: createFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster
operationId: createCluster
parameters:
- $ref: "#/components/parameters/groupId"
@@ -2900,6 +2950,7 @@ paths:
summary: Create One Cluster from One Project
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster
"/api/atlas/v2/groups/{groupId}/clusters/provider/regions":
get:
description: Returns the list of regions available for the specified cloud
@@ -2940,12 +2991,22 @@ paths:
summary: Return All Cloud Provider Regions
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listCloudProviderRegions
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade":
post:
- description: Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the
+ description: >-
+ Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the
specified project. To use this resource, the requesting API key must
have the Project Cluster Manager role. Each project supports up to 25
- clusters.
+ clusters.
+
+
+ This endpoint can also be used to upgrade Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) API or former M2/M5 clusters that have been migrated to Flex clusters, using instanceSizeName to “M2” or “M5” until January 2026. This functionality will be available until January 2026, after which it will only be available for M0 clusters. Please use the upgradeFlexCluster endpoint instead.
+ externalDocs:
+ description: upgradeFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster
operationId: upgradeSharedCluster
parameters:
- $ref: "#/components/parameters/groupId"
@@ -2979,11 +3040,22 @@ paths:
summary: Upgrade One Shared-tier Cluster
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedCluster
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless":
post:
- description: Upgrades a shared-tier cluster to a serverless instance in the
- specified project. To use this resource, the requesting API key must
- have the Project Cluster Manager role.
+ deprecated: true
+ description: >-
+ This endpoint has been deprecated as of February 2025 as we no longer
+ support the creation of new serverless instances. Please use the
+ upgradeFlexCluster endpoint to upgrade Flex clusters.
+
+ Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role.
+ externalDocs:
+ description: upgradeFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster
operationId: upgradeSharedClusterToServerless
parameters:
- $ref: "#/components/parameters/groupId"
@@ -3017,13 +3089,24 @@ paths:
summary: Upgrades One Shared-Tier Cluster to the Serverless Instance
tags:
- Clusters
+ x-sunset: 2025-02-05
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedClusterToServerless
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}":
delete:
- description: "Removes one cluster from the specified project. The cluster must
- have termination protection disabled in order to be deleted. To use this
+ description: >-
+ Removes one cluster from the specified project. The cluster must have
+ termination protection disabled in order to be deleted. To use this
resource, the requesting API Key must have the Project Owner role. This
- feature is not available for serverless clusters. Deprecated versions:
- v2-{2023-01-01}"
+ feature is not available for serverless clusters.
+
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the deleteFlexCluster endpoint for Flex clusters instead. Deprecated versions: v2-{2023-01-01}
+ externalDocs:
+ description: deleteFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster
operationId: deleteCluster
parameters:
- $ref: "#/components/parameters/groupId"
@@ -3033,8 +3116,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Flag that indicates whether to retain backup snapshots for the
deleted dedicated cluster.
@@ -3061,13 +3142,20 @@ paths:
summary: Remove One Cluster from One Project
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/deleteCluster
get:
- description: "Returns the details for one cluster in the specified project.
- Clusters contain a group of hosts that maintain the same data set. The
- response includes clusters with asymmetrically-sized shards. To use this
+ description: >-
+ Returns the details for one cluster in the specified project. Clusters
+ contain a group of hosts that maintain the same data set. The response
+ includes clusters with asymmetrically-sized shards. To use this
resource, the requesting API Key must have the Project Read Only role.
- This feature is not available for serverless clusters. Deprecated
- versions: v2-{2023-02-01}, v2-{2023-01-01}"
+ This feature is not available for serverless clusters.
+
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the getFlexCluster endpoint for Flex clusters instead. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}
+ externalDocs:
+ description: getFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster
operationId: getCluster
parameters:
- $ref: "#/components/parameters/groupId"
@@ -3077,8 +3165,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -3099,6 +3185,7 @@ paths:
summary: Return One Cluster from One Project
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster
patch:
description: "Updates the details for one cluster in the specified project.
Clusters contain a group of hosts that maintain the same data set. This
@@ -3120,8 +3207,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -3152,6 +3237,7 @@ paths:
summary: Modify One Cluster from One Project
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateCluster
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports":
get:
description: Returns all Cloud Backup Snapshot Export Jobs associated with the
@@ -3169,8 +3255,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -3187,6 +3271,7 @@ paths:
summary: Return All Snapshot Export Jobs
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupExportJobs
post:
description: Exports one backup Snapshot for dedicated Atlas cluster using Cloud
Backups to an Export Bucket. To use this resource, the requesting API
@@ -3200,8 +3285,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -3231,6 +3314,9 @@ paths:
summary: Create One Snapshot Export Job
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupExportJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}":
get:
description: Returns one Cloud Backup Snapshot Export Job associated with the
@@ -3245,8 +3331,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal character string that identifies the Export
Job.
@@ -3256,8 +3340,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -3274,11 +3356,14 @@ paths:
summary: Return One Snapshot Export Job
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupExportJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs":
get:
description: Returns all cloud backup restore jobs for one cluster from the
specified project. To use this resource, the requesting API Key must
- have the Project Owner role.
+ have the Project Backup Manager role.
operationId: listBackupRestoreJobs
parameters:
- $ref: "#/components/parameters/groupId"
@@ -3292,8 +3377,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -3310,6 +3393,7 @@ paths:
summary: Return All Restore Jobs for One Cluster
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupRestoreJobs
post:
description: >-
Restores one snapshot of one cluster from the specified project. Atlas
@@ -3318,7 +3402,7 @@ paths:
**inProgress** exists, before taking another snapshot, wait until Atlas
completes completes processing the previously taken on-demand snapshot.
- To use this resource, the requesting API Key must have the Project Owner role.
+ To use this resource, the requesting API Key must have the Project Backup Manager role.
operationId: createBackupRestoreJob
parameters:
- $ref: "#/components/parameters/groupId"
@@ -3328,8 +3412,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -3359,11 +3441,14 @@ paths:
summary: Restore One Snapshot of One Cluster
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}":
delete:
description: Cancels one cloud backup restore job of one cluster from the
specified project. To use this resource, the requesting API Key must
- have the Project Owner role.
+ have the Project Backup Manager role.
operationId: cancelBackupRestoreJob
parameters:
- $ref: "#/components/parameters/groupId"
@@ -3373,8 +3458,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the restore job
to remove.
@@ -3383,8 +3466,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -3403,10 +3484,11 @@ paths:
summary: Cancel One Restore Job of One Cluster
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob
get:
description: Returns one cloud backup restore job for one cluster from the
specified project. To use this resource, the requesting API Key must
- have the Project Owner role.
+ have the Project Backup Manager role.
operationId: getBackupRestoreJob
parameters:
- $ref: "#/components/parameters/groupId"
@@ -3417,8 +3499,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the restore job
to return.
@@ -3427,8 +3507,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -3445,6 +3523,9 @@ paths:
summary: Return One Restore Job of One Cluster
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule":
delete:
description: "Removes all cloud backup schedules for the specified cluster. This
@@ -3461,8 +3542,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -3481,6 +3560,7 @@ paths:
summary: Remove All Cloud Backup Schedules
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteAllBackupSchedules
get:
description: "Returns the cloud backup schedule for the specified cluster within
the specified project. This schedule defines when MongoDB Cloud takes
@@ -3496,8 +3576,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -3514,6 +3592,7 @@ paths:
summary: Return One Cloud Backup Schedule
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupSchedule
patch:
description: "Updates the cloud backup schedule for one cluster within the
specified project. This schedule defines when MongoDB Cloud takes
@@ -3529,8 +3608,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -3561,11 +3638,14 @@ paths:
summary: Update Cloud Backup Schedule for One Cluster
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateBackupSchedule
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots":
get:
description: Returns all snapshots of one cluster from the specified project. To
use this resource, the requesting API Key must have the Project Read
- Only role.
+ Only role or Project Backup Manager role.
operationId: listReplicaSetBackups
parameters:
- $ref: "#/components/parameters/groupId"
@@ -3578,8 +3658,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -3598,6 +3676,7 @@ paths:
summary: Return All Replica Set Cloud Backups
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listReplicaSetBackups
post:
description: >-
Takes one on-demand snapshot for the specified cluster. Atlas takes
@@ -3606,7 +3685,7 @@ paths:
**inProgress** exists, before taking another snapshot, wait until Atlas
completes completes processing the previously taken on-demand snapshot.
- To use this resource, the requesting API Key must have the Project Owner role.
+ To use this resource, the requesting API Key must have the Project Backup Manager role.
operationId: takeSnapshot
parameters:
- $ref: "#/components/parameters/groupId"
@@ -3616,8 +3695,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -3643,11 +3720,14 @@ paths:
summary: Take One On-Demand Snapshot
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeSnapshot
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}":
delete:
description: Removes one snapshot of one sharded cluster from the specified
project. To use this resource, the requesting API Key must have the
- Project Owner role.
+ Project Backup Manager role.
operationId: deleteShardedClusterBackup
parameters:
- $ref: "#/components/parameters/groupId"
@@ -3657,8 +3737,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -3667,8 +3745,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -3685,10 +3761,11 @@ paths:
summary: Remove One Sharded Cluster Cloud Backup
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteShardedClusterBackup
get:
description: Returns one snapshot of one sharded cluster from the specified
project. To use this resource, the requesting API Key must have the
- Project Read Only role.
+ Project Read Only role or Project Backup Manager role.
operationId: getShardedClusterBackup
parameters:
- $ref: "#/components/parameters/groupId"
@@ -3698,8 +3775,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -3708,8 +3783,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -3728,11 +3801,14 @@ paths:
summary: Return One Sharded Cluster Cloud Backup
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getShardedClusterBackup
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters":
get:
description: Returns all snapshots of one sharded cluster from the specified
project. To use this resource, the requesting API Key must have the
- Project Read Only role.
+ Project Read Only role or Project Backup Manager role.
operationId: listShardedClusterBackups
parameters:
- $ref: "#/components/parameters/groupId"
@@ -3742,8 +3818,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -3762,10 +3836,13 @@ paths:
summary: Return All Sharded Cluster Cloud Backups
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listShardedClusterBackups
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}":
delete:
description: Removes the specified snapshot. To use this resource, the
- requesting API Key must have the Project Owner role.
+ requesting API Key must have the Project Backup Manager role.
operationId: deleteReplicaSetBackup
parameters:
- $ref: "#/components/parameters/groupId"
@@ -3775,8 +3852,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -3785,8 +3860,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -3805,9 +3878,11 @@ paths:
summary: Remove One Replica Set Cloud Backup
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteReplicaSetBackup
get:
description: Returns one snapshot from the specified cluster. To use this
- resource, the requesting API Key must have the Project Read Only role.
+ resource, the requesting API Key must have the Project Read Only role or
+ Project Backup Manager role.
operationId: getReplicaSetBackup
parameters:
- $ref: "#/components/parameters/groupId"
@@ -3817,8 +3892,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -3827,8 +3900,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -3847,9 +3918,11 @@ paths:
summary: Return One Replica Set Cloud Backup
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getReplicaSetBackup
patch:
description: Changes the expiration date for one cloud backup snapshot for one
- cluster in the specified project.
+ cluster in the specified project, the requesting API Key must have the
+ Project Backup Manager role.
operationId: updateSnapshotRetention
parameters:
- $ref: "#/components/parameters/groupId"
@@ -3859,8 +3932,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -3869,8 +3940,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -3897,13 +3966,23 @@ paths:
summary: Change Expiration Date for One Cloud Backup
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateSnapshotRetention
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download":
post:
- description: Requests one snapshot for the specified shared cluster. This
- resource returns a `snapshotURL` that you can use to download the
- snapshot. This `snapshotURL` remains active for four hours after you
- make the request. To use this resource, the requesting API Key must have
- the Project Owner role.
+ description: >-
+ Requests one snapshot for the specified shared cluster. This resource
+ returns a `snapshotURL` that you can use to download the snapshot. This
+ `snapshotURL` remains active for four hours after you make the request.
+ To use this resource, the requesting API Key must have the Project Owner
+ role.
+
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the downloadFlexBackup endpoint instead.
+ externalDocs:
+ description: downloadFlexBackup
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup
operationId: downloadSharedClusterBackup
parameters:
- description: Human-readable label that identifies the cluster.
@@ -3912,8 +3991,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- $ref: "#/components/parameters/groupId"
requestBody:
@@ -3946,15 +4023,26 @@ paths:
summary: Download One M2 or M5 Cluster Snapshot
tags:
- Shared-Tier Snapshots
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadSharedClusterBackup
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore":
post:
- description: Restores the specified cluster. MongoDB Cloud limits which clusters
- can be the target clusters of a restore. The target cluster can't use
- encryption at rest, run a major release MongoDB version different than
- the snapshot, or receive client requests during restores. MongoDB Cloud
- deletes all existing data on the target cluster prior to the restore
- operation. To use this resource, the requesting API Key must have the
- Project Owner role.
+ description: >-
+ Restores the specified M2 or M5 cluster. MongoDB Cloud limits which
+ clusters can be the target clusters of a restore. The target cluster
+ can't use encryption at rest, run a major release MongoDB version
+ different than the snapshot, or receive client requests during restores.
+ MongoDB Cloud deletes all existing data on the target cluster prior to
+ the restore operation. To use this resource, the requesting API Key must
+ have the Project Owner role.
+
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the createFlexBackupRestoreJob endpoint instead.
+ externalDocs:
+ description: createFlexBackupRestoreJob
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob
operationId: createSharedClusterBackupRestoreJob
parameters:
- description: Human-readable label that identifies the cluster.
@@ -3963,8 +4051,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- $ref: "#/components/parameters/groupId"
requestBody:
@@ -3995,11 +4081,22 @@ paths:
summary: Create One Restore Job from One M2 or M5 Cluster
tags:
- Shared-Tier Restore Jobs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/createSharedClusterBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores":
get:
- description: Returns all restore jobs for the specified M2 or M5 cluster.
- Restore jobs restore a cluster using a snapshot. To use this resource,
- the requesting API Key must have the Project Read Only role.
+ description: >-
+ Returns all restore jobs for the specified M2 or M5 cluster. Restore
+ jobs restore a cluster using a snapshot. To use this resource, the
+ requesting API Key must have the Project Read Only role.
+
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the listFlexBackupRestoreJobs endpoint instead.
+ externalDocs:
+ description: listFlexBackupRestoreJobs
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs
operationId: listSharedClusterBackupRestoreJobs
parameters:
- description: Human-readable label that identifies the cluster.
@@ -4008,8 +4105,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- $ref: "#/components/parameters/groupId"
responses:
@@ -4029,10 +4124,21 @@ paths:
summary: Return All Restore Jobs for One M2 or M5 Cluster
tags:
- Shared-Tier Restore Jobs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/listSharedClusterBackupRestoreJobs
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}":
get:
- description: Returns the specified restore job. To use this resource, the
- requesting API Key must have the Project Read Only role.
+ description: >-
+ Returns the specified restore job for the specified M2 or M5 cluster. To
+ use this resource, the requesting API Key must have the Project Read
+ Only role.
+
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackupRestoreJob endpoint instead.
+ externalDocs:
+ description: getFlexBackupRestoreJob
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob
operationId: getSharedClusterBackupRestoreJob
parameters:
- description: Human-readable label that identifies the cluster.
@@ -4041,8 +4147,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- $ref: "#/components/parameters/groupId"
- description: Unique 24-hexadecimal digit string that identifies the restore job
@@ -4052,8 +4156,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -4072,11 +4174,21 @@ paths:
summary: Return One Restore Job for One M2 or M5 Cluster
tags:
- Shared-Tier Restore Jobs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/getSharedClusterBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots":
get:
- description: Returns details for all snapshots for the specified shared cluster.
- To use this resource, the requesting API Key must have the Project Read
+ description: >-
+ Returns details for all snapshots for the specified shared cluster. To
+ use this resource, the requesting API Key must have the Project Read
Only role.
+
+
+ This API also works for Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters, until January 2026, after which this endpoint will be sunset. Please use the listFlexBackups endpoint instead.
+ externalDocs:
+ description: listFlexBackups
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups
operationId: listSharedClusterBackups
parameters:
- $ref: "#/components/parameters/groupId"
@@ -4086,8 +4198,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -4106,11 +4216,21 @@ paths:
summary: Return All Snapshots for One M2 or M5 Cluster
tags:
- Shared-Tier Snapshots
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/listSharedClusterBackups
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}":
get:
- description: Returns details for one snapshot for the specified shared cluster.
- To use this resource, the requesting API Key must have the Project Read
+ description: >-
+ Returns details for one snapshot for the specified shared cluster. To
+ use this resource, the requesting API Key must have the Project Read
Only role.
+
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackup endpoint instead.
+ externalDocs:
+ description: getFlexBackup
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup
operationId: getSharedClusterBackup
parameters:
- $ref: "#/components/parameters/groupId"
@@ -4120,8 +4240,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -4130,8 +4248,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -4150,6 +4266,9 @@ paths:
summary: Return One Snapshot for One M2 or M5 Cluster
tags:
- Shared-Tier Snapshots
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/getSharedClusterBackup
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints":
get:
deprecated: true
@@ -4169,8 +4288,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -4187,6 +4304,7 @@ paths:
summary: Return All Legacy Backup Checkpoints
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupCheckpoints
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}":
get:
deprecated: true
@@ -4202,8 +4320,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
- description: Human-readable label that identifies the cluster that contains the
checkpoints that you want to return.
@@ -4212,8 +4328,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -4234,6 +4348,7 @@ paths:
summary: Return One Legacy Backup Checkpoint
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupCheckpoint
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned":
get:
description: Returns a list of given cluster's pinned namespaces, a set of
@@ -4249,8 +4364,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -4271,6 +4384,7 @@ paths:
summary: Return Pinned Namespaces
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getPinnedNamespaces
patch:
description: Add provided list of namespaces to existing pinned namespaces list
for collection-level latency metrics collection for the given Group and
@@ -4285,8 +4399,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -4322,6 +4434,7 @@ paths:
summary: Add Pinned Namespaces
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPatch
put:
description: Pin provided list of namespaces for collection-level latency
metrics collection for the given Group and Cluster. This initializes a
@@ -4337,8 +4450,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -4374,6 +4485,9 @@ paths:
summary: Pin Namespaces
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPut
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin":
patch:
description: Unpin provided list of namespaces for collection-level latency
@@ -4388,8 +4502,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -4418,6 +4530,10 @@ paths:
summary: Unpin namespaces
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinNamespaces
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes":
post:
deprecated: true
@@ -4439,8 +4555,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -4469,6 +4583,9 @@ paths:
tags:
- Atlas Search
x-sunset: 2025-06-01
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndexDeprecated
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}":
get:
deprecated: true
@@ -4489,8 +4606,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Name of the collection that contains one or more Atlas Search
indexes.
@@ -4524,6 +4639,9 @@ paths:
tags:
- Atlas Search
x-sunset: 2025-06-01
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesDeprecated
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}":
delete:
deprecated: true
@@ -4543,8 +4661,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the Atlas Search
index. Use the [Get All Atlas Search Indexes for a Collection
@@ -4555,8 +4671,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -4576,6 +4690,7 @@ paths:
tags:
- Atlas Search
x-sunset: 2025-06-01
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexDeprecated
get:
deprecated: true
description: Returns one Atlas Search index in the specified project. You
@@ -4596,8 +4711,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the Application
Search
@@ -4610,8 +4723,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -4629,6 +4740,7 @@ paths:
tags:
- Atlas Search
x-sunset: 2025-06-01
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexDeprecated
patch:
deprecated: true
description: Updates one Atlas Search index that you identified with its unique
@@ -4648,8 +4760,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the Atlas Search
[index](https://dochub.mongodb.org/core/index-definitions-fts). Use
@@ -4661,8 +4771,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -4691,6 +4799,9 @@ paths:
tags:
- Atlas Search
x-sunset: 2025-06-01
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexDeprecated
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites":
get:
description: "Returns one managed namespace within the specified global cluster.
@@ -4710,8 +4821,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -4728,6 +4837,7 @@ paths:
summary: Return One Managed Namespace in One Global Cluster
tags:
- Global Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/getManagedNamespace
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping":
delete:
description: "Removes all custom zone mappings for the specified global cluster.
@@ -4749,8 +4859,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -4767,6 +4875,7 @@ paths:
summary: Remove All Custom Zone Mappings from One Global Cluster
tags:
- Global Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteAllCustomZoneMappings
post:
description: "Creates one custom zone mapping for the specified global cluster.
A custom zone mapping matches one ISO 3166-2 location code to a zone in
@@ -4786,8 +4895,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -4814,6 +4921,10 @@ paths:
summary: Add One Entry to One Custom Zone Mapping
tags:
- Global Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createCustomZoneMapping
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces":
delete:
description: "Removes one managed namespace within the specified global cluster.
@@ -4833,8 +4944,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- $ref: "#/components/parameters/groupId"
- description: Human-readable label that identifies the database that contains the
@@ -4866,6 +4975,7 @@ paths:
summary: Remove One Managed Namespace from One Global Cluster
tags:
- Global Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteManagedNamespace
post:
description: "Creates one managed namespace within the specified global cluster.
A managed namespace identifies a collection using the database name, the
@@ -4884,8 +4994,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -4914,6 +5022,10 @@ paths:
summary: Create One Managed Namespace in One Global Cluster
tags:
- Global Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createManagedNamespace
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index":
post:
description: Creates an index on the cluster identified by its name in a rolling
@@ -4935,8 +5047,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -5025,6 +5135,9 @@ paths:
summary: Create One Rolling Index
tags:
- Rolling Index
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createRollingIndex
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives":
get:
description: Returns details of all online archives. This archive stores data
@@ -5046,8 +5159,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -5064,6 +5175,7 @@ paths:
summary: Return All Online Archives for One Cluster
tags:
- Online Archive
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listOnlineArchives
post:
description: Creates one online archive. This archive stores data from one
cluster within one project. To use this resource, the requesting API Key
@@ -5081,8 +5193,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -5115,6 +5225,7 @@ paths:
x-xgen-changelog:
2023-08-02: If 'criteria':'DATE' is specified, then you must specify 'DATE'
values in partition fields
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createOnlineArchive
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz":
get:
description: 'Downloads query logs for the specified online archive. To use this
@@ -5158,8 +5269,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Flag that indicates whether to download logs for queries against
your online archive only or both your online archive and cluster.
@@ -5194,6 +5303,9 @@ paths:
summary: Download Online Archive Query Logs
tags:
- Online Archive
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}":
delete:
description: Removes one online archive. This archive stores data from one
@@ -5212,8 +5324,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
- description: Human-readable label that identifies the cluster that contains the
collection from which you want to remove an online archive.
@@ -5222,8 +5332,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"204":
@@ -5242,6 +5350,7 @@ paths:
summary: Remove One Online Archive
tags:
- Online Archive
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteOnlineArchive
get:
description: Returns one online archive for one cluster. This archive stores
data from one cluster within one project. To use this resource, the
@@ -5259,8 +5368,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
- description: Human-readable label that identifies the cluster that contains the
specified collection from which Application created the online
@@ -5270,8 +5377,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -5292,6 +5397,7 @@ paths:
summary: Return One Online Archive
tags:
- Online Archive
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/getOnlineArchive
patch:
description: Updates, pauses, or resumes one online archive. This archive stores
data from one cluster within one project. To use this resource, the
@@ -5309,8 +5415,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
- description: Human-readable label that identifies the cluster that contains the
specified collection from which Application created the online
@@ -5320,8 +5424,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -5351,6 +5453,7 @@ paths:
summary: Update One Online Archive
tags:
- Online Archive
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/updateOnlineArchive
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation":
delete:
description: Ends a cluster outage simulation.
@@ -5367,8 +5470,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -5389,6 +5490,7 @@ paths:
summary: End an Outage Simulation
tags:
- Cluster Outage Simulation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endOutageSimulation
get:
description: Returns one outage simulation for one cluster.
externalDocs:
@@ -5404,8 +5506,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -5426,6 +5526,7 @@ paths:
summary: Return One Outage Simulation
tags:
- Cluster Outage Simulation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getOutageSimulation
post:
description: Starts a cluster outage simulation.
externalDocs:
@@ -5441,8 +5542,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -5468,6 +5567,84 @@ paths:
summary: Start an Outage Simulation
tags:
- Cluster Outage Simulation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startOutageSimulation
+ x-xgen-IPA-exception:
+ xgen-IPA-113-singleton-must-not-have-id: API predates IPA validation
+ "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions":
+ get:
+ description: Returns the indexes that the Performance Advisor suggests to drop.
+ The Performance Advisor suggests dropping unused, redundant, and hidden
+ indexes to improve write performance and increase storage space. To use
+ this resource, the requesting API Key must have the Project Read Only
+ role.
+ operationId: listDropIndexes
+ parameters:
+ - $ref: "#/components/parameters/groupId"
+ - description: Human-readable label that identifies the cluster.
+ in: path
+ name: clusterName
+ required: true
+ schema:
+ type: string
+ pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2024-08-05+json:
+ schema:
+ $ref: "#/components/schemas/DropIndexSuggestionsResponse"
+ x-xgen-version: 2024-08-05
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Returns Suggested Indexes to Drop
+ tags:
+ - Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listDropIndexes
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice":
+ get:
+ description: Returns the schema suggestions that the Performance Advisor
+ detects. The Performance Advisor provides holistic schema
+ recommendations for your cluster by sampling documents in your most
+ active collections and collections with slow-running queries. To use
+ this resource, the requesting API Key must have the Project Read Only
+ role.
+ operationId: listSchemaAdvice
+ parameters:
+ - $ref: "#/components/parameters/groupId"
+ - description: Human-readable label that identifies the cluster.
+ in: path
+ name: clusterName
+ required: true
+ schema:
+ type: string
+ pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2024-08-05+json:
+ schema:
+ $ref: "#/components/schemas/SchemaAdvisorResponse"
+ x-xgen-version: 2024-08-05
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Return Schema Advice
+ tags:
+ - Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSchemaAdvice
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes":
get:
description: Returns the indexes that the Performance Advisor suggests. The
@@ -5483,8 +5660,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: ProcessIds from which to retrieve suggested indexes. A processId is
a combination of host and port that serves the MongoDB process. The
@@ -5564,6 +5739,9 @@ paths:
summary: Return Suggested Indexes
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listClusterSuggestedIndexes
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs":
get:
description: "Returns the advanced configuration details for one cluster in the
@@ -5586,8 +5764,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -5606,6 +5782,7 @@ paths:
summary: Return One Advanced Configuration Options for One Cluster
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterAdvancedConfiguration
patch:
description: "Updates the advanced configuration details for one cluster in the
specified project. Clusters contain a group of hosts that maintain the
@@ -5627,8 +5804,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -5658,6 +5833,7 @@ paths:
summary: Update Advanced Configuration Options for One Cluster
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateClusterAdvancedConfiguration
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries":
post:
description: "Starts a failover test for the specified cluster in the specified
@@ -5676,8 +5852,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -5692,6 +5866,9 @@ paths:
summary: Test Failover for One Cluster
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/testFailover
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs":
get:
deprecated: true
@@ -5717,8 +5894,6 @@ paths:
name: batchId
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
- description: Human-readable label that identifies the cluster with the snapshot
you want to return.
@@ -5727,8 +5902,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -5747,6 +5920,7 @@ paths:
summary: Return All Legacy Backup Restore Jobs
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupRestoreJobs
post:
deprecated: true
description: Restores one legacy backup for one cluster in the specified
@@ -5776,8 +5950,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -5803,6 +5975,7 @@ paths:
summary: Create One Legacy Backup Restore Job
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/createLegacyBackupRestoreJob
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}":
get:
deprecated: true
@@ -5822,8 +5995,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the restore job.
in: path
@@ -5831,8 +6002,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -5851,6 +6020,7 @@ paths:
summary: Return One Legacy Backup Restore Job
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupRestoreJob
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment":
delete:
description: Deletes the Search Nodes for the specified cluster.
@@ -5863,8 +6033,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"204":
@@ -5885,6 +6053,7 @@ paths:
summary: Delete Search Nodes
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchDeployment
get:
description: "Return the Search Nodes for the specified cluster. Deprecated
versions: v2-{2023-01-01}"
@@ -5897,8 +6066,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -5917,6 +6084,7 @@ paths:
summary: Return Search Nodes
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchDeployment
patch:
description: "Updates the Search Nodes for the specified cluster. Deprecated
versions: v2-{2023-01-01}"
@@ -5929,8 +6097,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -5958,6 +6124,7 @@ paths:
summary: Update Search Nodes
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchDeployment
post:
description: Creates Search Nodes for the specified cluster.
operationId: createAtlasSearchDeployment
@@ -5969,8 +6136,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -5998,6 +6163,10 @@ paths:
summary: Create Search Nodes
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchDeployment
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-113-singleton-must-not-have-id: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes":
get:
description: Returns all Atlas Search indexes on the specified cluster. Atlas
@@ -6017,8 +6186,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -6045,6 +6212,7 @@ paths:
summary: Return All Atlas Search Indexes for One Cluster
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesCluster
post:
description: Creates one Atlas Search index on the specified collection. Atlas
Search indexes define the fields on which to create the index and the
@@ -6064,8 +6232,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -6093,6 +6259,9 @@ paths:
summary: Create One Atlas Search Index
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndex
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}":
get:
description: Returns all Atlas Search indexes on the specified collection. Atlas
@@ -6112,8 +6281,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Name of the collection that contains one or more Atlas Search
indexes.
@@ -6154,6 +6321,9 @@ paths:
summary: Return All Atlas Search Indexes for One Collection
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexes
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}":
delete:
description: Removes one Atlas Search index that you identified with its
@@ -6173,8 +6343,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Name of the collection that contains one or more Atlas Search
indexes.
@@ -6213,6 +6381,7 @@ paths:
summary: Remove One Atlas Search Index by Name
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexByName
get:
description: Returns one Atlas Search index in the specified project. You
identify this index using its database, collection and name. Atlas
@@ -6232,8 +6401,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Name of the collection that contains one or more Atlas Search
indexes.
@@ -6272,6 +6439,7 @@ paths:
summary: Return One Atlas Search Index by Name
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexByName
patch:
description: Updates one Atlas Search index that you identified with its
database, collection name, and index name. Atlas Search indexes define
@@ -6291,8 +6459,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Name of the collection that contains one or more Atlas Search
indexes.
@@ -6340,6 +6506,9 @@ paths:
summary: Update One Atlas Search Index By Name
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}":
delete:
description: Removes one Atlas Search index that you identified with its unique
@@ -6358,8 +6527,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the Atlas Search
index. Use the [Get All Atlas Search Indexes for a Collection
@@ -6370,8 +6537,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -6390,6 +6555,7 @@ paths:
summary: Remove One Atlas Search Index by Id
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndex
get:
description: Returns one Atlas Search index in the specified project. You
identify this index using its unique ID. Atlas Search index contains the
@@ -6409,8 +6575,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the Application
Search
@@ -6423,8 +6587,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -6449,6 +6611,7 @@ paths:
summary: Return One Atlas Search Index by ID
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndex
patch:
description: Updates one Atlas Search index that you identified with its unique
ID. Atlas Search indexes define the fields on which to create the index
@@ -6467,8 +6630,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the Atlas Search
[index](https://dochub.mongodb.org/core/index-definitions-fts). Use
@@ -6480,8 +6641,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -6509,6 +6668,9 @@ paths:
summary: Update One Atlas Search Index By ID
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndex
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule":
get:
deprecated: true
@@ -6528,8 +6690,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -6546,6 +6706,7 @@ paths:
summary: Return One Snapshot Schedule
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshotSchedule
patch:
deprecated: true
description: >-
@@ -6564,8 +6725,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -6589,6 +6748,7 @@ paths:
summary: Update Snapshot Schedule for One Cluster
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotSchedule
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots":
get:
deprecated: true
@@ -6615,8 +6775,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Human-readable label that specifies whether to return only
completed, incomplete, or all snapshots. By default, MongoDB Cloud
@@ -6626,6 +6784,8 @@ paths:
schema:
type: string
default: "true"
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
responses:
"200":
content:
@@ -6641,6 +6801,7 @@ paths:
summary: Return All Legacy Backup Snapshots
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacySnapshots
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}":
delete:
deprecated: true
@@ -6664,8 +6825,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -6674,8 +6833,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -6694,6 +6851,7 @@ paths:
summary: Remove One Legacy Backup Snapshot
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/deleteLegacySnapshot
get:
deprecated: true
description: Returns one legacy backup snapshot for one cluster in the specified
@@ -6716,8 +6874,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -6726,8 +6882,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -6744,6 +6898,7 @@ paths:
summary: Return One Legacy Backup Snapshot
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshot
patch:
deprecated: true
description: Changes the expiration date for one legacy backup snapshot for one
@@ -6766,8 +6921,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -6776,8 +6929,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -6801,6 +6952,7 @@ paths:
summary: Change One Legacy Backup Snapshot Expiration
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotRetention
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status":
get:
description: Returns the status of all changes that you made to the specified
@@ -6817,8 +6969,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -6835,6 +6985,7 @@ paths:
summary: Return Status of All Cluster Operations
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterStatus
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces":
get:
description: Return the subset of namespaces from the given cluster sorted by
@@ -6849,8 +7000,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Human-readable label that identifies the cluster topology to
retrieve metrics for.
@@ -6877,6 +7026,9 @@ paths:
summary: Return Ranked Namespaces from a Cluster
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForCluster
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements":
get:
description: Get a list of the Coll Stats Latency cluster-level measurements for
@@ -6891,8 +7043,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Human-readable label that identifies the cluster topology to
retrieve metrics for.
@@ -6938,6 +7088,9 @@ paths:
summary: Return Cluster-Level Query Latency
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceClusterMeasurements
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess":
post:
description: Grants MongoDB employee cluster access for the given duration and
@@ -6951,8 +7104,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -6983,6 +7134,9 @@ paths:
summary: Grant MongoDB employee cluster access for one cluster.
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/grantMongoDbEmployeeAccess
+ x-xgen-IPA-exception:
+ xgen-IPA-109-custom-method-must-use-camel-case: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion":
post:
description: Pins the Feature Compatibility Version (FCV) to the current MongoDB
@@ -6998,8 +7152,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -7029,6 +7181,7 @@ paths:
summary: Pin FCV for One Cluster from One Project
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinFeatureCompatibilityVersion
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess":
post:
description: Revokes a previously granted MongoDB employee cluster access.
@@ -7041,8 +7194,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"204":
@@ -7065,6 +7216,9 @@ paths:
summary: Revoke granted MongoDB employee cluster access for one cluster.
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/revokeMongoDbEmployeeAccess
+ x-xgen-IPA-exception:
+ xgen-IPA-109-custom-method-must-use-camel-case: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion":
post:
description: Unpins the current fixed Feature Compatibility Version (FCV). This
@@ -7078,8 +7232,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"204":
@@ -7104,6 +7256,7 @@ paths:
summary: Unpins FCV for One Cluster from One Project
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/unpinFeatureCompatibilityVersion
"/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz":
get:
description: "Returns a compressed (.gz) log file that contains a range of log
@@ -7142,6 +7295,8 @@ paths:
externalDocs:
description: Set up Database Auditing
url: https://docs.atlas.mongodb.com/database-auditing/
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
- description: Specifies the date and time for the ending point of the range of
log messages to retrieve, in the number of seconds that have elapsed
since the UNIX epoch. This value will default to 24 hours after the
@@ -7190,6 +7345,9 @@ paths:
summary: Download Logs for One Cluster Host in One Project
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostLogs
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/collStats/metrics":
get:
description: Returns all available Coll Stats Latency metric names and their
@@ -7216,6 +7374,9 @@ paths:
summary: Return all metric names
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceMetrics
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/containers":
get:
description: Returns details about all network peering containers in the
@@ -7256,6 +7417,7 @@ paths:
Provider
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainerByCloudProvider
post:
description: Creates one new network peering container in the specified project.
MongoDB Cloud can deploy Network Peering connections in a network
@@ -7295,6 +7457,7 @@ paths:
summary: Create One New Network Peering Container
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringContainer
"/api/atlas/v2/groups/{groupId}/containers/all":
get:
description: Returns details about all network peering containers in the
@@ -7322,6 +7485,9 @@ paths:
summary: Return All Network Peering Containers in One Project
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainers
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/containers/{containerId}":
delete:
description: Removes one network peering container in the specified project. To
@@ -7338,8 +7504,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -7362,6 +7526,7 @@ paths:
summary: Remove One Network Peering Container
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringContainer
get:
description: Returns details about one network peering container in one
specified project. Network peering containers contain network peering
@@ -7378,8 +7543,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -7396,6 +7559,7 @@ paths:
summary: Return One Network Peering Container
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringContainer
patch:
description: Updates the network details and labels of one specified network
peering container in the specified project. To use this resource, the
@@ -7411,8 +7575,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -7445,6 +7607,7 @@ paths:
summary: Update One Network Peering Container
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringContainer
"/api/atlas/v2/groups/{groupId}/customDBRoles/roles":
get:
description: Returns all custom roles for the specified project. To use this
@@ -7469,9 +7632,12 @@ paths:
summary: Return All Custom Roles in One Project
tags:
- Custom Database Roles
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/listCustomDatabaseRoles
post:
description: Creates one custom role in the specified project. To use this
- resource, the requesting API Key must have the Project Owner role.
+ resource, the requesting API Key must have the Project Owner role,
+ Project Stream Processing Owner role, or the Project Database Access
+ Admin role.
operationId: createCustomDatabaseRole
parameters:
- $ref: "#/components/parameters/groupId"
@@ -7505,13 +7671,17 @@ paths:
summary: Create One Custom Role
tags:
- Custom Database Roles
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/createCustomDatabaseRole
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}":
delete:
description: Removes one custom role from the specified project. You can't
remove a custom role that would leave one or more child roles with no
parent roles or actions. You also can't remove a custom role that would
leave one or more database users without roles. To use this resource,
- the requesting API Key must have the Project Atlas Admin role.
+ the requesting API Key must have the Project Owner role, Project Stream
+ Processing Owner role, or the Project Database Access Admin role.
operationId: deleteCustomDatabaseRole
parameters:
- $ref: "#/components/parameters/groupId"
@@ -7541,6 +7711,7 @@ paths:
summary: Remove One Custom Role from One Project
tags:
- Custom Database Roles
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/deleteCustomDatabaseRole
get:
description: Returns one custom role for the specified project. To use this
resource, the requesting API Key must have the Project Read Only role.
@@ -7571,9 +7742,12 @@ paths:
summary: Return One Custom Role in One Project
tags:
- Custom Database Roles
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/getCustomDatabaseRole
patch:
description: Updates one custom role in the specified project. To use this
- resource, the requesting API Key must have the Project Owner role.
+ resource, the requesting API Key must have the Project Owner role, the
+ Project Stream Processing Owner role, or the Project Database Access
+ Admin role.
operationId: updateCustomDatabaseRole
parameters:
- $ref: "#/components/parameters/groupId"
@@ -7614,6 +7788,9 @@ paths:
summary: Update One Custom Role in One Project
tags:
- Custom Database Roles
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/updateCustomDatabaseRole
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/dataFederation":
get:
description: Returns the details of all federated database instances in the
@@ -7645,6 +7822,7 @@ paths:
summary: Return All Federated Database Instances in One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listFederatedDatabases
post:
description: Creates one federated database instance in the specified project.
To use this resource, the requesting API Key must have the Project Owner
@@ -7685,6 +7863,7 @@ paths:
summary: Create One Federated Database Instance in One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createFederatedDatabase
"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}":
delete:
description: Removes one federated database instance from the specified project.
@@ -7715,6 +7894,7 @@ paths:
summary: Remove One Federated Database Instance from One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteFederatedDatabase
get:
description: Returns the details of one federated database instance within the
specified project. To use this resource, the requesting API Key must
@@ -7748,6 +7928,7 @@ paths:
summary: Return One Federated Database Instance in One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getFederatedDatabase
patch:
description: Updates the details of one federated database instance in the
specified project. To use this resource, the requesting API Key must
@@ -7796,6 +7977,7 @@ paths:
summary: Update One Federated Database Instance in One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/updateFederatedDatabase
"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits":
get:
description: Returns query limits for a federated databases instance in the
@@ -7830,6 +8012,7 @@ paths:
summary: Return All Query Limits for One Federated Database Instance
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimits
"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}":
delete:
description: Deletes one query limit for one federated database instance. To use
@@ -7865,6 +8048,8 @@ paths:
required: true
schema:
type: string
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
responses:
"204":
content:
@@ -7880,6 +8065,7 @@ paths:
summary: Delete One Query Limit For One Federated Database Instance
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteOneDataFederationInstanceQueryLimit
get:
description: Returns the details of one query limit for the specified federated
database instance in the specified project. To use this resource, the
@@ -7915,6 +8101,8 @@ paths:
required: true
schema:
type: string
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
responses:
"200":
content:
@@ -7930,6 +8118,7 @@ paths:
summary: Return One Federated Database Instance Query Limit for One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimit
patch:
description: Creates or updates one query limit for one federated database
instance. To use this resource, the requesting API Key must have the
@@ -7965,6 +8154,8 @@ paths:
required: true
schema:
type: string
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
requestBody:
content:
application/vnd.atlas.2023-01-01+json:
@@ -7991,6 +8182,7 @@ paths:
summary: Configure One Query Limit for One Federated Database Instance
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createOneDataFederationQueryLimit
"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz":
get:
description: 'Downloads the query logs for the specified federated database
@@ -8054,6 +8246,7 @@ paths:
summary: Download Query Logs for One Federated Database Instance
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs
"/api/atlas/v2/groups/{groupId}/databaseUsers":
get:
description: Returns all database users that belong to the specified project. To
@@ -8080,13 +8273,15 @@ paths:
summary: Return All Database Users from One Project
tags:
- Database Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/listDatabaseUsers
post:
description: Creates one database user in the specified project. This MongoDB
Cloud supports a maximum of 100 database users per project. If you
require more than 100 database users on a project, contact
[Support](https://cloud.mongodb.com/support). To use this resource, the
- requesting API Key must have the Project Owner or Project Charts Admin
- roles.
+ requesting API Key must have the Project Owner role, the Project Charts
+ Admin role, Project Stream Processing Owner role, or the Project
+ Database Access Admin role.
operationId: createDatabaseUser
parameters:
- $ref: "#/components/parameters/groupId"
@@ -8211,10 +8406,13 @@ paths:
summary: Create One Database User in One Project
tags:
- Database Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createDatabaseUser
"/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}":
delete:
description: Removes one database user from the specified project. To use this
- resource, the requesting API Key must have the Project Owner role.
+ resource, the requesting API Key must have the Project Owner role, the
+ Project Stream Processing Owner role, or the Project Database Access
+ Admin role.
operationId: deleteDatabaseUser
parameters:
- $ref: "#/components/parameters/groupId"
@@ -8285,6 +8483,7 @@ paths:
summary: Remove One Database User from One Project
tags:
- Database Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/deleteDatabaseUser
get:
description: Returns one database user that belong to the specified project. To
use this resource, the requesting API Key must have the Project Read
@@ -8357,10 +8556,12 @@ paths:
summary: Return One Database User from One Project
tags:
- Database Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getDatabaseUser
patch:
description: Updates one database user that belongs to the specified project. To
- use this resource, the requesting API Key must have the Project Owner or
- Project Charts Admin roles.
+ use this resource, the requesting API Key must have the Project Owner
+ role, Project Charts Admin role, Project Stream Processing Owner role,
+ or the Project Database Access Admin role.
operationId: updateDatabaseUser
parameters:
- $ref: "#/components/parameters/groupId"
@@ -8442,6 +8643,9 @@ paths:
summary: Update One Database User in One Project
tags:
- Database Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/updateDatabaseUser
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs":
get:
description: Returns all unexpired X.509 certificates for the specified MongoDB
@@ -8478,6 +8682,7 @@ paths:
summary: Return All X.509 Certificates Assigned to One MongoDB User
tags:
- X.509 Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/listDatabaseUserCertificates
post:
description: >-
Generates one X.509 certificate for the specified MongoDB user. Atlas
@@ -8536,13 +8741,14 @@ paths:
summary: Create One X.509 Certificate for One MongoDB User
tags:
- X.509 Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/createDatabaseUserCertificate
"/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}":
get:
description: Returns the access logs of one cluster identified by the cluster's
name. Access logs contain a list of authentication requests made against
your cluster. You can't use this feature on tenant-tier clusters (M0,
M2, M5). To use this resource, the requesting API Key must have the
- Project Monitoring Admin role.
+ Project Monitoring Admin role or the Project Database Access Admin role.
externalDocs:
description: Database Access History
url: https://docs.atlas.mongodb.com/access-tracking/
@@ -8561,8 +8767,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Date and time when to stop retrieving database history. If you
specify **end**, you must also specify **start**. This parameter
@@ -8613,13 +8817,17 @@ paths:
summary: Return Database Access History for One Cluster using Its Cluster Name
tags:
- Access Tracking
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}":
get:
description: Returns the access logs of one cluster identified by the cluster's
hostname. Access logs contain a list of authentication requests made
against your clusters. You can't use this feature on tenant-tier
clusters (M0, M2, M5). To use this resource, the requesting API Key must
- have the Project Monitoring Admin role.
+ have the Project Monitoring Admin role or the Project Database Access
+ Admin role.
externalDocs:
description: Database Access History
url: https://docs.atlas.mongodb.com/access-tracking/
@@ -8688,6 +8896,9 @@ paths:
summary: Return Database Access History for One Cluster using Its Hostname
tags:
- Access Tracking
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/encryptionAtRest":
get:
description: >-
@@ -8717,6 +8928,7 @@ paths:
Keys for One Project
tags:
- Encryption at Rest using Customer Key Management
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRest
patch:
description: >-
Updates the configuration for encryption at rest using the keys you
@@ -8774,6 +8986,7 @@ paths:
for One Project
tags:
- Encryption at Rest using Customer Key Management
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/updateEncryptionAtRest
"/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints":
get:
description: Returns the private endpoints of the specified cloud provider for
@@ -8807,6 +9020,7 @@ paths:
Using Customer Key Management for One Project
tags:
- Encryption at Rest using Customer Key Management
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpointsForCloudProvider
post:
description: Creates a private endpoint in the specified region for encryption
at rest using customer key management.
@@ -8843,6 +9057,7 @@ paths:
Rest Using Customer Key Management
tags:
- Encryption at Rest using Customer Key Management
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/createEncryptionAtRestPrivateEndpoint
"/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}":
delete:
description: Deletes one private endpoint, identified by its ID, for encryption
@@ -8864,8 +9079,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -8883,6 +9096,7 @@ paths:
Management
tags:
- Encryption at Rest using Customer Key Management
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestEncryptionAtRestPrivateEndpointDeletion
get:
description: Returns one private endpoint, identified by its ID, for encryption
at rest using Customer Key Management.
@@ -8903,8 +9117,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -8924,6 +9136,7 @@ paths:
Management
tags:
- Encryption at Rest using Customer Key Management
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpoint
"/api/atlas/v2/groups/{groupId}/events":
get:
description: >-
@@ -8947,8 +9160,6 @@ paths:
type: array
items:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
style: form
- description: >-
@@ -8983,23 +9194,25 @@ paths:
type: boolean
default: false
- description: Date and time from when MongoDB Cloud stops returning events. This
- parameter uses the ISO 8601 timestamp
- format in UTC.
+ parameter uses the ISO 8601 timestamp format in UTC.
in: query
name: maxDate
schema:
type: string
format: date-time
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
- description: Date and time from when MongoDB Cloud starts returning events. This
- parameter uses the ISO 8601 timestamp
- format in UTC.
+ parameter uses the ISO 8601 timestamp format in UTC.
in: query
name: minDate
schema:
type: string
format: date-time
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
responses:
"200":
content:
@@ -9017,6 +9230,7 @@ paths:
summary: Return All Events from One Project
tags:
- Events
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents
"/api/atlas/v2/groups/{groupId}/events/{eventId}":
get:
description: >-
@@ -9038,8 +9252,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
- description: Flag that indicates whether to include the raw document in the
output. The raw document contains additional meta information about
@@ -9066,6 +9278,7 @@ paths:
summary: Return One Event from One Project
tags:
- Events
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getProjectEvent
"/api/atlas/v2/groups/{groupId}/flexClusters":
get:
description: Returns details for all flex clusters in the specified project. To
@@ -9092,6 +9305,7 @@ paths:
summary: Return All Flex Clusters from One Project
tags:
- Flex Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters
post:
description: Creates one flex cluster in the specified project. To use this
resource, the requesting API Key must have the Project Owner role.
@@ -9124,6 +9338,7 @@ paths:
summary: Create One Flex Cluster in One Project
tags:
- Flex Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster
"/api/atlas/v2/groups/{groupId}/flexClusters/{name}":
delete:
description: Removes one flex cluster from the specified project. The flex
@@ -9139,8 +9354,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"204":
@@ -9161,6 +9374,7 @@ paths:
summary: Remove One Flex Cluster from One Project
tags:
- Flex Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster
get:
description: Returns details for one flex cluster in the specified project. To
use this resource, the requesting API Key must have the Project Read
@@ -9174,8 +9388,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -9196,6 +9408,7 @@ paths:
summary: Return One Flex Cluster from One Project
tags:
- Flex Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster
patch:
description: Updates one flex cluster in the specified project. To use this
resource, the requesting API Key must have the Project Owner role.
@@ -9208,8 +9421,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -9235,6 +9446,7 @@ paths:
summary: Update One Flex Cluster in One Project
tags:
- Flex Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster
"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download":
post:
description: Requests one snapshot for the specified flex cluster. This resource
@@ -9250,8 +9462,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- $ref: "#/components/parameters/groupId"
requestBody:
@@ -9284,6 +9494,10 @@ paths:
summary: Download One Flex Cluster Snapshot
tags:
- Flex Snapshots
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs":
get:
description: Returns all restore jobs for one flex cluster from the specified
@@ -9301,8 +9515,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -9321,6 +9533,7 @@ paths:
summary: Return All Restore Jobs for One Flex Cluster
tags:
- Flex Restore Jobs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs
post:
description: Restores one snapshot of one flex cluster from the specified
project. To use this resource, the requesting API Key must have the
@@ -9335,8 +9548,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -9366,6 +9577,9 @@ paths:
summary: Restore One Snapshot of One Flex Cluster
tags:
- Flex Restore Jobs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}":
get:
description: Returns one restore job for one flex cluster from the specified
@@ -9380,8 +9594,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the restore job
to return.
@@ -9390,8 +9602,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -9410,6 +9620,9 @@ paths:
summary: Return One Restore Job for One Flex Cluster
tags:
- Flex Restore Jobs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots":
get:
description: Returns all snapshots of one flex cluster from the specified
@@ -9427,8 +9640,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -9447,6 +9658,9 @@ paths:
summary: Return All Snapshots of One Flex Cluster
tags:
- Flex Snapshots
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}":
get:
description: Returns one snapshot of one flex cluster from the specified
@@ -9461,8 +9675,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -9472,8 +9684,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -9492,6 +9702,9 @@ paths:
summary: Return One Snapshot of One Flex Cluster
tags:
- Flex Snapshots
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade":
post:
description: Upgrades a flex cluster to a dedicated cluster (M10+) in the
@@ -9530,6 +9743,7 @@ paths:
summary: Upgrade One Flex Cluster
tags:
- Flex Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster
"/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics":
get:
description: Returns all Atlas Search metric types available for one process in
@@ -9556,6 +9770,9 @@ paths:
summary: Return All Atlas Search Metric Types for One Process
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listMetricTypes
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements":
get:
description: Returns the Atlas Search index metrics within the specified time
@@ -9601,6 +9818,9 @@ paths:
summary: Return All Atlas Search Index Metrics for One Namespace
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listIndexMetrics
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements":
get:
description: Returns the Atlas Search metrics data series within the provided
@@ -9649,6 +9869,9 @@ paths:
summary: Return Atlas Search Metrics for One Index in One Specified Namespace
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getIndexMetrics
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements":
get:
description: Returns the Atlas Search hardware and status data series within the
@@ -9698,6 +9921,9 @@ paths:
summary: Return Atlas Search Hardware and Status Metrics
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getMeasurements
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/integrations":
get:
description: Returns the settings that permit integrations with all configured
@@ -9729,6 +9955,7 @@ paths:
summary: Return All Active Third-Party Service Integrations
tags:
- Third-Party Integrations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/listThirdPartyIntegrations
"/api/atlas/v2/groups/{groupId}/integrations/{integrationType}":
delete:
description: Removes the settings that permit configuring one third-party
@@ -9768,6 +9995,7 @@ paths:
summary: Remove One Third-Party Service Integration
tags:
- Third-Party Integrations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/deleteThirdPartyIntegration
get:
description: Returns the settings for configuring integration with one
third-party service. These settings apply to all databases managed in
@@ -9803,6 +10031,7 @@ paths:
summary: Return One Third-Party Service Integration
tags:
- Third-Party Integrations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/getThirdPartyIntegration
post:
description: Adds the settings for configuring one third-party service
integration. These settings apply to all databases managed in the
@@ -9852,6 +10081,7 @@ paths:
summary: Configure One Third-Party Service Integration
tags:
- Third-Party Integrations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/createThirdPartyIntegration
put:
description: Updates the settings for configuring integration with one
third-party service. These settings apply to all databases managed in
@@ -9897,6 +10127,7 @@ paths:
summary: Update One Third-Party Service Integration
tags:
- Third-Party Integrations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/updateThirdPartyIntegration
"/api/atlas/v2/groups/{groupId}/invites":
get:
deprecated: true
@@ -9929,6 +10160,7 @@ paths:
tags:
- Projects
x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectInvitations
patch:
deprecated: true
description: Updates the details of one pending invitation to the specified
@@ -9965,6 +10197,7 @@ paths:
tags:
- Projects
x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitation
post:
deprecated: true
description: Invites one MongoDB Cloud user to join the specified project. The
@@ -9997,6 +10230,7 @@ paths:
tags:
- Projects
x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation
"/api/atlas/v2/groups/{groupId}/invites/{invitationId}":
delete:
deprecated: true
@@ -10013,8 +10247,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -10032,6 +10264,7 @@ paths:
tags:
- Projects
x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectInvitation
get:
deprecated: true
description: Returns the details of one pending invitation to the specified
@@ -10046,8 +10279,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -10067,6 +10298,7 @@ paths:
tags:
- Projects
x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectInvitation
patch:
deprecated: true
description: Updates the details of one pending invitation to the specified
@@ -10084,8 +10316,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -10114,6 +10344,7 @@ paths:
tags:
- Projects
x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitationById
"/api/atlas/v2/groups/{groupId}/ipAddresses":
get:
description: Returns all IP addresses for this project. To use this resource,
@@ -10138,6 +10369,7 @@ paths:
summary: Return All IP Addresses for One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/returnAllIpAddresses
"/api/atlas/v2/groups/{groupId}/limits":
get:
description: Returns all the limits for the specified project. To use this
@@ -10168,6 +10400,7 @@ paths:
summary: Return All Limits for One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectLimits
"/api/atlas/v2/groups/{groupId}/limits/{limitName}":
delete:
description: Removes the specified project limit. Depending on the limit, Atlas
@@ -10214,6 +10447,8 @@ paths:
required: true
schema:
type: string
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
- $ref: "#/components/parameters/groupId"
responses:
"204":
@@ -10234,6 +10469,7 @@ paths:
summary: Remove One Project Limit
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectLimit
get:
description: Returns the specified limit for the specified project. To use this
resource, the requesting API Key must have the Project Read Only role.
@@ -10277,6 +10513,8 @@ paths:
required: true
schema:
type: string
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
- $ref: "#/components/parameters/groupId"
responses:
"200":
@@ -10299,6 +10537,7 @@ paths:
summary: Return One Limit for One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLimit
patch:
description: >-
Sets the specified project limit. To use this resource, the requesting
@@ -10346,6 +10585,8 @@ paths:
required: true
schema:
type: string
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
- $ref: "#/components/parameters/groupId"
requestBody:
content:
@@ -10375,6 +10616,7 @@ paths:
summary: Set One Project Limit
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setProjectLimit
"/api/atlas/v2/groups/{groupId}/liveMigrations":
post:
description: >-
@@ -10417,6 +10659,7 @@ paths:
summary: Migrate One Local Managed Cluster to MongoDB Atlas
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createPushMigration
"/api/atlas/v2/groups/{groupId}/liveMigrations/validate":
post:
description: "Verifies whether the provided credentials, available disk space,
@@ -10456,6 +10699,9 @@ paths:
summary: Validate One Migration Request
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}":
get:
description: Return the status of one migration validation job. Your API Key
@@ -10472,8 +10718,6 @@ paths:
schema:
type: string
example: 507f1f77bcf86cd799439011
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -10496,6 +10740,9 @@ paths:
summary: Return One Migration Validation Job
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getValidationStatus
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}":
get:
description: Return details of one cluster migration job. Each push live
@@ -10524,6 +10771,7 @@ paths:
summary: Return One Migration Job
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getPushMigration
"/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover":
put:
description: Cut over the migrated cluster to MongoDB Atlas. Confirm when the
@@ -10554,6 +10802,9 @@ paths:
summary: Cut Over the Migrated Cluster
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverMigration
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/maintenanceWindow":
delete:
description: Resets the maintenance window for the specified project. To use
@@ -10586,6 +10837,7 @@ paths:
summary: Reset One Maintenance Window for One Project
tags:
- Maintenance Windows
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetMaintenanceWindow
get:
description: Returns the maintenance window for the specified project. MongoDB
Cloud starts those maintenance activities when needed. You can't change
@@ -10614,6 +10866,7 @@ paths:
summary: Return One Maintenance Window for One Project
tags:
- Maintenance Windows
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/getMaintenanceWindow
patch:
description: Updates the maintenance window for the specified project. Urgent
maintenance activities such as security patches can't wait for your
@@ -10653,6 +10906,7 @@ paths:
summary: Update Maintenance Window for One Project
tags:
- Maintenance Windows
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/updateMaintenanceWindow
"/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer":
post:
description: Toggles automatic deferral of the maintenance window for the
@@ -10676,6 +10930,10 @@ paths:
summary: Toggle Automatic Deferral of Maintenance for One Project
tags:
- Maintenance Windows
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleMaintenanceAutoDefer
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer":
post:
description: Defers the maintenance window for the specified project. Urgent
@@ -10707,6 +10965,10 @@ paths:
summary: Defer One Maintenance Window for One Project
tags:
- Maintenance Windows
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferMaintenanceWindow
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/managedSlowMs":
get:
description: Get whether the Managed Slow MS feature is enabled.
@@ -10717,6 +10979,8 @@ paths:
"200":
content:
application/vnd.atlas.2023-01-01+json:
+ schema:
+ type: boolean
x-xgen-version: 2023-01-01
description: OK
"401":
@@ -10728,6 +10992,7 @@ paths:
summary: Return Managed Slow MS enabled
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getManagedSlowMs
"/api/atlas/v2/groups/{groupId}/managedSlowMs/disable":
delete:
description: Disables the slow operation threshold that MongoDB Cloud calculated
@@ -10758,6 +11023,10 @@ paths:
summary: Disable Managed Slow Operation Threshold
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableSlowOperationThresholding
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/managedSlowMs/enable":
post:
description: Enables MongoDB Cloud to use its slow operation threshold for the
@@ -10788,6 +11057,10 @@ paths:
summary: Enable Managed Slow Operation Threshold
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableSlowOperationThresholding
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/mongoDBVersions":
get:
description: Returns the MongoDB Long Term Support Major Versions available to
@@ -10845,6 +11118,7 @@ paths:
summary: Return Available MongoDB LTS Versions for clusters in One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLtsVersions
"/api/atlas/v2/groups/{groupId}/peers":
get:
description: Returns details about all network peering connections in the
@@ -10880,6 +11154,7 @@ paths:
summary: Return All Network Peering Connections in One Project
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringConnections
post:
description: Creates one new network peering connection in the specified
project. Network peering allows multiple cloud-hosted applications to
@@ -10920,6 +11195,7 @@ paths:
summary: Create One New Network Peering Connection
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringConnection
"/api/atlas/v2/groups/{groupId}/peers/{peerId}":
delete:
description: Removes one network peering connection in the specified project. If
@@ -10937,8 +11213,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"202":
@@ -10957,6 +11231,7 @@ paths:
summary: Remove One Existing Network Peering Connection
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringConnection
get:
description: Returns details about one specified network peering connection in
the specified project. To use this resource, the requesting API Key must
@@ -10971,8 +11246,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -10991,6 +11264,7 @@ paths:
summary: Return One Network Peering Connection in One Project
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringConnection
patch:
description: Updates one specified network peering connection in the specified
project. To use this resource, the requesting API Key must have the
@@ -11005,8 +11279,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -11036,6 +11308,7 @@ paths:
summary: Update One New Network Peering Connection
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringConnection
"/api/atlas/v2/groups/{groupId}/pipelines":
get:
deprecated: true
@@ -11064,6 +11337,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelines
post:
deprecated: true
description: Creates one Data Lake Pipeline.
@@ -11101,6 +11375,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/createPipeline
"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}":
delete:
deprecated: true
@@ -11114,8 +11389,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[^/\\ "$]{1,64}$
responses:
"204":
@@ -11135,6 +11408,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipeline
get:
deprecated: true
description: Returns the details of one Data Lake Pipeline within the specified
@@ -11149,8 +11423,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[^/\\ "$]{1,64}$
responses:
"200":
@@ -11170,6 +11442,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipeline
patch:
deprecated: true
description: Updates one Data Lake Pipeline.
@@ -11182,8 +11455,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[^/\\ "$]{1,64}$
requestBody:
content:
@@ -11214,6 +11485,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/updatePipeline
"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules":
get:
deprecated: true
@@ -11229,8 +11501,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[^/\\ "$]{1,64}$
responses:
"200":
@@ -11252,6 +11522,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSchedules
"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots":
get:
deprecated: true
@@ -11280,8 +11551,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[^/\\ "$]{1,64}$
responses:
"200":
@@ -11301,6 +11570,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSnapshots
"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause":
post:
deprecated: true
@@ -11316,8 +11586,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[^/\\ "$]{1,64}$
responses:
"200":
@@ -11337,6 +11605,9 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pausePipeline
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume":
post:
deprecated: true
@@ -11352,8 +11623,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[^/\\ "$]{1,64}$
responses:
"200":
@@ -11373,6 +11642,9 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumePipeline
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs":
get:
deprecated: true
@@ -11398,8 +11670,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[^/\\ "$]{1,64}$
responses:
"200":
@@ -11419,6 +11689,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineRuns
"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}":
delete:
deprecated: true
@@ -11432,8 +11703,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[^/\\ "$]{1,64}$
- description: Unique 24-hexadecimal character string that identifies a Data Lake
Pipeline run.
@@ -11443,8 +11712,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"202":
@@ -11464,6 +11731,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipelineRunDataset
get:
deprecated: true
description: Returns the details of one Data Lake Pipeline run within the
@@ -11478,8 +11746,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[^/\\ "$]{1,64}$
- description: Unique 24-hexadecimal character string that identifies a Data Lake
Pipeline run.
@@ -11489,8 +11755,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -11510,6 +11774,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipelineRun
"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger":
post:
deprecated: true
@@ -11523,8 +11788,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[^/\\ "$]{1,64}$
requestBody:
content:
@@ -11551,6 +11814,9 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerSnapshotIngestion
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService":
post:
description: Creates one private endpoint service for the specified cloud
@@ -11589,6 +11855,10 @@ paths:
summary: Create One Private Endpoint Service for One Provider
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpointService
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode":
get:
description: Checks whether each region in the specified cloud service provider
@@ -11615,6 +11885,7 @@ paths:
summary: Return Regionalized Private Endpoint Status
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting
patch:
description: Enables or disables the ability to create multiple private
endpoints per region in all cloud service providers in one project. The
@@ -11653,11 +11924,18 @@ paths:
summary: Toggle Regionalized Private Endpoint Status
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint":
get:
- description: Returns all private endpoints for one serverless instance. You must
- have at least the Project Read Only role for the project to successfully
- call this resource.
+ description: >-
+ Returns all private endpoints for one serverless instance. You must have
+ at least the Project Read Only role for the project to successfully call
+ this resource.
+
+
+ This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
operationId: listServerlessPrivateEndpoints
parameters:
- $ref: "#/components/parameters/groupId"
@@ -11668,7 +11946,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -11689,12 +11966,15 @@ paths:
summary: Return All Private Endpoints for One Serverless Instance
tags:
- Serverless Private Endpoints
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/listServerlessPrivateEndpoints
post:
description: >-
Creates one private endpoint for one serverless instance. To use this
resource, the requesting API Key must have the Project Owner role.
A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.
+
+ This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
externalDocs:
description: Set Up a Private Endpoint for a Serverless Instance Tutorial
url: https://dochub.mongodb.org/core/serverless-private-endpoint
@@ -11708,7 +11988,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -11735,10 +12014,17 @@ paths:
summary: Create One Private Endpoint for One Serverless Instance
tags:
- Serverless Private Endpoints
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/createServerlessPrivateEndpoint
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}":
delete:
- description: Remove one private endpoint from one serverless instance. To use
- this resource, the requesting API Key must have the Project Owner role.
+ description: >-
+ Remove one private endpoint from one serverless instance. To use this
+ resource, the requesting API Key must have the Project Owner role.
+
+
+ This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
operationId: deleteServerlessPrivateEndpoint
parameters:
- $ref: "#/components/parameters/groupId"
@@ -11749,7 +12035,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the tenant
endpoint which will be removed.
@@ -11758,8 +12043,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -11778,10 +12061,15 @@ paths:
summary: Remove One Private Endpoint for One Serverless Instance
tags:
- Serverless Private Endpoints
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/deleteServerlessPrivateEndpoint
get:
- description: Return one private endpoint for one serverless instance. Identify
- this endpoint using its unique ID. You must have at least the Project
- Read Only role for the project to successfully call this resource.
+ description: >-
+ Return one private endpoint for one serverless instance. Identify this
+ endpoint using its unique ID. You must have at least the Project Read
+ Only role for the project to successfully call this resource.
+
+
+ This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
operationId: getServerlessPrivateEndpoint
parameters:
- $ref: "#/components/parameters/groupId"
@@ -11792,7 +12080,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the tenant
endpoint.
@@ -11801,8 +12088,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -11821,9 +12106,14 @@ paths:
summary: Return One Private Endpoint for One Serverless Instance
tags:
- Serverless Private Endpoints
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getServerlessPrivateEndpoint
patch:
- description: Updates one private endpoint for one serverless instance. To use
- this resource, the requesting API Key must have the Project Owner role.
+ description: >-
+ Updates one private endpoint for one serverless instance. To use this
+ resource, the requesting API Key must have the Project Owner role.
+
+
+ This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
operationId: updateServerlessPrivateEndpoint
parameters:
- $ref: "#/components/parameters/groupId"
@@ -11834,7 +12124,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the tenant
endpoint which will be updated.
@@ -11843,8 +12132,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -11870,6 +12157,9 @@ paths:
summary: Update One Private Endpoint for One Serverless Instance
tags:
- Serverless Private Endpoints
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/updateServerlessPrivateEndpoint
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService":
get:
description: Returns the name, interfaces, and state of all private endpoint
@@ -11904,6 +12194,7 @@ paths:
summary: Return All Private Endpoint Services for One Provider
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/listPrivateEndpointServices
"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}":
delete:
description: Removes one private endpoint service from the specified project.
@@ -11927,8 +12218,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -11945,6 +12234,7 @@ paths:
summary: Remove One Private Endpoint Service for One Provider
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpointService
get:
description: Returns the name, interfaces, and state of the specified private
endpoint service from one project. The cloud service provider hosted
@@ -11967,8 +12257,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -11987,6 +12275,7 @@ paths:
summary: Return One Private Endpoint Service for One Provider
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpointService
"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint":
post:
description: Creates one private endpoint for the specified cloud service
@@ -12013,8 +12302,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -12044,6 +12331,7 @@ paths:
summary: Create One Private Endpoint for One Provider
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpoint
"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}":
delete:
description: Removes one private endpoint from the specified project and private
@@ -12078,8 +12366,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -12096,6 +12382,7 @@ paths:
summary: Remove One Private Endpoint for One Provider
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpoint
get:
description: Returns the connection state of the specified private endpoint. The
private endpoint service manages this private endpoint which belongs to
@@ -12128,8 +12415,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -12148,6 +12433,7 @@ paths:
summary: Return One Private Endpoint for One Provider
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpoint
"/api/atlas/v2/groups/{groupId}/privateIpMode":
get:
deprecated: true
@@ -12175,6 +12461,7 @@ paths:
summary: Verify Connect via Peering Only Mode for One Project
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject
patch:
deprecated: true
description: Disables Connect via Peering Only mode for the specified project.
@@ -12210,6 +12497,7 @@ paths:
summary: Disable Connect via Peering Only Mode for One Project
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disablePeering
"/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds":
get:
description: Returns all private endpoints for Federated Database Instances and
@@ -12242,6 +12530,7 @@ paths:
Endpoints in One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listDataFederationPrivateEndpoints
post:
description: >-
Adds one private endpoint for Federated Database Instances and Online
@@ -12300,6 +12589,9 @@ paths:
Endpoint for One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createDataFederationPrivateEndpoint
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}":
delete:
description: Removes one private endpoint for Federated Database Instances and
@@ -12316,8 +12608,6 @@ paths:
required: true
schema:
type: string
- maxLength: 22
- minLength: 22
pattern: ^vpce-[0-9a-f]{17}$
responses:
"204":
@@ -12337,6 +12627,7 @@ paths:
Endpoint from One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteDataFederationPrivateEndpoint
get:
description: Returns the specified private endpoint for Federated Database
Instances or Online Archives in the specified project. To use this
@@ -12353,8 +12644,6 @@ paths:
required: true
schema:
type: string
- maxLength: 22
- minLength: 22
pattern: ^vpce-[0-9a-f]{17}$
responses:
"200":
@@ -12376,6 +12665,9 @@ paths:
Endpoint in One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getDataFederationPrivateEndpoint
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/processes":
get:
description: Returns details of all processes for the specified project. A
@@ -12402,6 +12694,7 @@ paths:
summary: Return All MongoDB Processes in One Project
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listAtlasProcesses
"/api/atlas/v2/groups/{groupId}/processes/{processId}":
get:
description: Returns the processes for the specified host for the specified
@@ -12438,6 +12731,7 @@ paths:
summary: Return One MongoDB Process by ID
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getAtlasProcess
"/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces":
get:
description: Return the subset of namespaces from the given process ranked by
@@ -12464,13 +12758,16 @@ paths:
summary: Return Ranked Namespaces from a Host
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForHost
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/processes/{processId}/databases":
get:
description: Returns the list of databases running on the specified host for the
- specified project. `M0` free clusters, `M2`, `M5`, and serverless
+ specified project. `M0` free clusters, `M2`, `M5`, serverless, and Flex
clusters have some [operational
- limits](https://www.mongodb.com/docs/atlas/reference/free-shared-limitations/#operational-limitations).
- The MongoDB Cloud process must be a `mongod`. To use this resource, the
+ limits](https://www.mongodb.com/docs/atlas/reference/limitations/). The
+ MongoDB Cloud process must be a `mongod`. To use this resource, the
requesting API Key must have the Project Read Only role.
operationId: listDatabases
parameters:
@@ -12506,6 +12803,7 @@ paths:
summary: Return Available Databases for One MongoDB Process
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDatabases
"/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}":
get:
description: Returns one database running on the specified host for the
@@ -12549,6 +12847,7 @@ paths:
summary: Return One Database for a MongoDB Process
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabase
"/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements":
get:
description: Returns the measurements of one database for the specified host for
@@ -12619,6 +12918,7 @@ paths:
summary: Return Measurements of One Database for One MongoDB Process
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabaseMeasurements
"/api/atlas/v2/groups/{groupId}/processes/{processId}/disks":
get:
description: Returns the list of disks or partitions for the specified host for
@@ -12658,6 +12958,7 @@ paths:
summary: Return Available Disks for One MongoDB Process
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskPartitions
"/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}":
get:
description: Returns measurement details for one disk or partition for the
@@ -12701,6 +13002,7 @@ paths:
summary: Return Measurements of One Disk
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskMeasurements
"/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements":
get:
description: >-
@@ -12776,6 +13078,7 @@ paths:
summary: Return Measurements of One Disk for One MongoDB Process
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDiskMeasurements
"/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements":
get:
description: >-
@@ -12847,6 +13150,7 @@ paths:
summary: Return Measurements for One MongoDB Process
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostMeasurements
"/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces":
get:
description: Returns up to 20 namespaces for collections experiencing slow
@@ -12913,6 +13217,9 @@ paths:
summary: Return All Namespaces for One Host
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueryNamespaces
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs":
get:
description: Returns log lines for slow queries that the Performance Advisor and
@@ -12921,7 +13228,8 @@ paths:
performance. MongoDB Cloud bases the threshold for slow queries on the
average time of operations on your cluster. This enables
workload-relevant recommendations. To use this resource, the requesting
- API Key must have the Project Data Access Read Write role.
+ API Key must have any Project Data Access role or the Project
+ Observability Viewer role.
operationId: listSlowQueries
parameters:
- $ref: "#/components/parameters/groupId"
@@ -13003,6 +13311,9 @@ paths:
summary: Return Slow Queries
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueries
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes":
get:
description: Returns the indexes that the Performance Advisor suggests. The
@@ -13098,6 +13409,9 @@ paths:
summary: Return Suggested Indexes
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSuggestedIndexes
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements":
get:
description: Get a list of the Coll Stats Latency process-level measurements for
@@ -13141,6 +13455,9 @@ paths:
summary: Return Host-Level Query Latency
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceHostMeasurements
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/pushBasedLogExport":
delete:
description: Disables the push-based log export feature by resetting the project
@@ -13167,6 +13484,7 @@ paths:
summary: Disable the push-based log export feature for a project
tags:
- Push-Based Log Export
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deletePushBasedLogConfiguration
get:
description: Fetches the current project level settings for the push-based log
export feature.
@@ -13192,6 +13510,7 @@ paths:
summary: Get the push-based log export configuration for a project
tags:
- Push-Based Log Export
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getPushBasedLogConfiguration
patch:
description: Updates the project level settings for the push-based log export feature.
operationId: updatePushBasedLogConfiguration
@@ -13226,6 +13545,7 @@ paths:
summary: Update the push-based log export feature for a project
tags:
- Push-Based Log Export
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updatePushBasedLogConfiguration
post:
description: Configures the project level settings for the push-based log export
feature.
@@ -13260,6 +13580,7 @@ paths:
summary: Enable the push-based log export feature for a project
tags:
- Push-Based Log Export
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createPushBasedLogConfiguration
"/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}":
post:
description: Requests loading the MongoDB sample dataset into the specified
@@ -13275,8 +13596,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"201":
@@ -13297,6 +13616,7 @@ paths:
summary: Load Sample Dataset Request into Cluster
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/loadSampleDataset
"/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}":
get:
description: Checks the progress of loading the sample dataset into one cluster.
@@ -13312,8 +13632,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -13330,11 +13648,19 @@ paths:
summary: Check Status of Cluster Sample Dataset Request
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getSampleDatasetLoadStatus
"/api/atlas/v2/groups/{groupId}/serverless":
get:
- description: Returns details for all serverless instances in the specified
- project. To use this resource, the requesting API Key must have the
- Project Read Only role.
+ description: >-
+ Returns details for all serverless instances in the specified project.
+ To use this resource, the requesting API Key must have the Project Read
+ Only role.
+
+
+ This endpoint also lists Flex clusters that were created using the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or former Serverless instances that have been migrated to Flex clusters, until January 2026 after which this endpoint will be sunset. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the listFlexClusters endpoint instead.
+ externalDocs:
+ description: listFlexClusters
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters
operationId: listServerlessInstances
parameters:
- $ref: "#/components/parameters/groupId"
@@ -13356,9 +13682,20 @@ paths:
summary: Return All Serverless Instances from One Project
tags:
- Serverless Instances
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/listServerlessInstances
post:
- description: Creates one serverless instance in the specified project. To use
- this resource, the requesting API Key must have the Project Owner role.
+ description: >-
+ Update as of Feb 2025: This endpoint now creates a Flex cluster instead.
+ This endpoint will no longer be supported starting January 2026.
+ Continuous backups are not supported and
+ serverlessContinuousBackupEnabled will not take effect. Please use the
+ createFlexCluster endpoint instead.
+
+
+ Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+ externalDocs:
+ description: createFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster
operationId: createServerlessInstance
parameters:
- $ref: "#/components/parameters/groupId"
@@ -13388,11 +13725,19 @@ paths:
summary: Create One Serverless Instance in One Project
tags:
- Serverless Instances
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance
"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs":
get:
- description: Returns all restore jobs for one serverless instance from the
- specified project. To use this resource, the requesting API Key must
- have the Project Owner role.
+ description: >-
+ Returns all restore jobs for one serverless instance from the specified
+ project. To use this resource, the requesting API Key must have the
+ Project Owner role.
+
+
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackupRestoreJobs endpoint instead.
+ externalDocs:
+ description: listFlexBackupRestoreJobs
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs
operationId: listServerlessBackupRestoreJobs
parameters:
- $ref: "#/components/parameters/groupId"
@@ -13405,8 +13750,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -13425,10 +13768,18 @@ paths:
summary: Return All Restore Jobs for One Serverless Instance
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackupRestoreJobs
post:
- description: Restores one snapshot of one serverless instance from the specified
+ description: >-
+ Restores one snapshot of one serverless instance from the specified
project. To use this resource, the requesting API Key must have the
Project Owner role.
+
+
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the createFlexBackupRestoreJob endpoint instead.
+ externalDocs:
+ description: createFlexBackupRestoreJob
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob
operationId: createServerlessBackupRestoreJob
parameters:
- $ref: "#/components/parameters/groupId"
@@ -13439,8 +13790,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -13471,11 +13820,21 @@ paths:
summary: Restore One Snapshot of One Serverless Instance
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createServerlessBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}":
get:
- description: Returns one restore job for one serverless instance from the
- specified project. To use this resource, the requesting API Key must
- have the Project Owner role.
+ description: >-
+ Returns one restore job for one serverless instance from the specified
+ project. To use this resource, the requesting API Key must have the
+ Project Owner role.
+
+
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackupRestoreJob endpoint instead.
+ externalDocs:
+ description: getFlexBackupRestoreJob
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob
operationId: getServerlessBackupRestoreJob
parameters:
- $ref: "#/components/parameters/groupId"
@@ -13485,8 +13844,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the restore job
to return.
@@ -13495,8 +13852,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -13515,11 +13870,21 @@ paths:
summary: Return One Restore Job for One Serverless Instance
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots":
get:
- description: Returns all snapshots of one serverless instance from the specified
+ description: >-
+ Returns all snapshots of one serverless instance from the specified
project. To use this resource, the requesting API Key must have the
Project Read Only role.
+
+
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackups endpoint instead.
+ externalDocs:
+ description: listFlexBackups
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups
operationId: listServerlessBackups
parameters:
- $ref: "#/components/parameters/groupId"
@@ -13532,8 +13897,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -13552,11 +13915,21 @@ paths:
summary: Return All Snapshots of One Serverless Instance
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackups
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}":
get:
- description: Returns one snapshot of one serverless instance from the specified
+ description: >-
+ Returns one snapshot of one serverless instance from the specified
project. To use this resource, the requesting API Key must have the
Project Read Only role.
+
+
+ This endpoint can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) API or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackup endpoint instead.
+ externalDocs:
+ description: getFlexBackup
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup
operationId: getServerlessBackup
parameters:
- $ref: "#/components/parameters/groupId"
@@ -13566,8 +13939,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -13577,8 +13948,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -13597,9 +13966,21 @@ paths:
summary: Return One Snapshot of One Serverless Instance
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackup
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing":
get:
- description: Get whether the Serverless Auto Indexing feature is enabled.
+ description: Get whether the Serverless Auto Indexing feature is enabled. This
+ endpoint returns a value for Flex clusters that were created with the
+ [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance)
+ endpoint or Flex clusters that were migrated from Serverless instances.
+ However, the value returned is not indicative of the Auto Indexing state
+ as Auto Indexing is unavailable for Flex clusters. This endpoint will be
+ sunset in January 2026.
+ externalDocs:
+ description: createServerlessInstance
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance
operationId: getServerlessAutoIndexing
parameters:
- $ref: "#/components/parameters/groupId"
@@ -13609,8 +13990,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -13627,8 +14006,18 @@ paths:
summary: Return Serverless Auto Indexing Enabled
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getServerlessAutoIndexing
post:
- description: Set whether the Serverless Auto Indexing feature is enabled.
+ description: Set whether the Serverless Auto Indexing feature is enabled. This
+ endpoint sets a value for Flex clusters that were created with the
+ [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance)
+ endpoint or Flex clusters that were migrated from Serverless instances.
+ However, the value returned is not indicative of the Auto Indexing state
+ as Auto Indexing is unavailable for Flex clusters. This endpoint will be
+ sunset in January 2026.
+ externalDocs:
+ description: createServerlessInstance
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance
operationId: setServerlessAutoIndexing
parameters:
- $ref: "#/components/parameters/groupId"
@@ -13638,8 +14027,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
- description: Value that we want to set for the Serverless Auto Indexing toggle.
in: query
@@ -13662,12 +14049,22 @@ paths:
summary: Set Serverless Auto Indexing
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setServerlessAutoIndexing
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/serverless/{name}":
delete:
- description: Removes one serverless instance from the specified project. The
+ description: >-
+ Removes one serverless instance from the specified project. The
serverless instance must have termination protection disabled in order
to be deleted. To use this resource, the requesting API Key must have
the Project Owner role.
+
+
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the deleteFlexCluster endpoint instead.
+ externalDocs:
+ description: deleteFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster
operationId: deleteServerlessInstance
parameters:
- $ref: "#/components/parameters/groupId"
@@ -13677,8 +14074,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"202":
@@ -13699,10 +14094,18 @@ paths:
summary: Remove One Serverless Instance from One Project
tags:
- Serverless Instances
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/deleteServerlessInstance
get:
- description: Returns details for one serverless instance in the specified
- project. To use this resource, the requesting API Key must have the
- Project Read Only role.
+ description: >-
+ Returns details for one serverless instance in the specified project. To
+ use this resource, the requesting API Key must have the Project Read
+ Only role.
+
+
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. This endpoint will be sunset in January 2026. Please use the getFlexCluster endpoint instead.
+ externalDocs:
+ description: getFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster
operationId: getServerlessInstance
parameters:
- $ref: "#/components/parameters/groupId"
@@ -13712,8 +14115,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
"200":
@@ -13734,9 +14135,17 @@ paths:
summary: Return One Serverless Instance from One Project
tags:
- Serverless Instances
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/getServerlessInstance
patch:
- description: Updates one serverless instance in the specified project. To use
- this resource, the requesting API Key must have the Project Owner role.
+ description: >-
+ Updates one serverless instance in the specified project. To use this
+ resource, the requesting API Key must have the Project Owner role.
+
+
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the updateFlexCluster endpoint instead.
+ externalDocs:
+ description: updateFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster
operationId: updateServerlessInstance
parameters:
- $ref: "#/components/parameters/groupId"
@@ -13746,8 +14155,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
requestBody:
content:
@@ -13773,6 +14180,7 @@ paths:
summary: Update One Serverless Instance in One Project
tags:
- Serverless Instances
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/updateServerlessInstance
"/api/atlas/v2/groups/{groupId}/serviceAccounts":
get:
description: Returns all Service Accounts for the specified Project. Available
@@ -13799,6 +14207,7 @@ paths:
summary: List All Project Service Accounts
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccounts
post:
description: Creates one Service Account for the specified Project. The Service
Account will automatically be added as an Organization Member to the
@@ -13832,6 +14241,7 @@ paths:
summary: Create and Assign one Service Account to one Project
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccount
"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}":
delete:
description: Removes the specified Service Account from the specified project.
@@ -13867,6 +14277,7 @@ paths:
summary: Unassign One Service Account from One Project
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccount
get:
description: Returns one Service Account in the specified Project. Available as
a preview feature.
@@ -13898,6 +14309,7 @@ paths:
summary: Get one Project Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getProjectServiceAccount
patch:
description: Updates one Service Account in the specified Project. Available as
a preview feature.
@@ -13938,6 +14350,7 @@ paths:
summary: Update one Project Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateProjectServiceAccount
"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList":
get:
description: Returns all access list entries that you configured for the
@@ -13972,6 +14385,7 @@ paths:
summary: Return All Access List entries for one Project Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccountAccessList
post:
description: Add Access List Entries for the specified Service Account for the
project. Resources require all API requests to originate from IP
@@ -14020,6 +14434,9 @@ paths:
summary: Add Access List entries for one Project Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountAccessList
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}":
delete:
description: Removes the specified access list entry from the specified Service
@@ -14063,6 +14480,7 @@ paths:
summary: Remove One Access List entry from one Project Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountAccessListEntry
"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets":
post:
description: Create a secret for the specified Service Account in the specified
@@ -14102,6 +14520,9 @@ paths:
summary: Create one Project Service Account Secret
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountSecret
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}":
delete:
description: Deletes the specified Service Account secret. Available as a
@@ -14138,6 +14559,7 @@ paths:
summary: Delete one Project Service Account Secret
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountSecret
"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite":
post:
description: Assigns the specified Service Account to the specified Project.
@@ -14181,6 +14603,7 @@ paths:
summary: Assign One Service Account to One Project
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/addProjectServiceAccount
"/api/atlas/v2/groups/{groupId}/settings":
get:
description: Returns details about the specified project's settings. To use this
@@ -14207,6 +14630,7 @@ paths:
summary: Return One Project Settings
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectSettings
patch:
description: Updates the settings of the specified project. You can update any
of the options available. MongoDB cloud only updates the options
@@ -14241,6 +14665,7 @@ paths:
summary: Update One Project Settings
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectSettings
"/api/atlas/v2/groups/{groupId}/streams":
get:
description: Returns all stream instances for the specified project.
@@ -14267,6 +14692,7 @@ paths:
x-xgen-changelog:
2023-09-11: The MongoDB Atlas Streams Processing API is now exposed as part of
private preview, but is subject to change until GA.
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamInstances
post:
description: Creates one stream instance in the specified project. To use this
resource, the requesting API Key must have the Project Data Access Admin
@@ -14301,6 +14727,7 @@ paths:
x-xgen-changelog:
2023-09-11: The MongoDB Atlas Streams Processing API is now exposed as part of
private preview, but is subject to change until GA.
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstance
"/api/atlas/v2/groups/{groupId}/streams/accountDetails":
get:
description: Returns the Account ID, and the VPC ID for the group and region
@@ -14337,6 +14764,33 @@ paths:
specified.
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ "/api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections":
+ get:
+ description: Returns a list of active incoming VPC Peering Connections.
+ operationId: getActiveVpcPeeringConnections
+ parameters:
+ - $ref: "#/components/parameters/groupId"
+ - $ref: "#/components/parameters/itemsPerPage"
+ - $ref: "#/components/parameters/pageNum"
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2024-11-13+json:
+ x-xgen-version: 2024-11-13
+ description: OK
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Returns all the active incoming VPC Peering Connections.
+ tags:
+ - Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getActiveVpcPeeringConnections
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections":
get:
description: Returns all Private Link connections for the specified project.To
@@ -14368,6 +14822,7 @@ paths:
x-xgen-changelog:
2024-10-02: The MongoDB Atlas Streams Processing Private Link API is now exposed
as part of private preview, but is subject to change until GA.
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listPrivateLinkConnections
post:
description: Creates one Private Link in the specified project. To use this
resource, the requesting API Key must have the Project Owner or Project
@@ -14404,6 +14859,9 @@ paths:
x-xgen-changelog:
2024-10-02: The MongoDB Atlas Streams Processing Private Link API is now exposed
as part of private preview, but is subject to change until GA.
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createPrivateLinkConnection
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}":
delete:
description: Deletes one Private Link in the specified project. To use this
@@ -14440,6 +14898,7 @@ paths:
x-xgen-changelog:
2024-10-02: The MongoDB Atlas Streams Processing Private Link API is now exposed
as part of private preview, but is subject to change until GA.
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deletePrivateLinkConnection
get:
description: Returns the details of one Private Link connection within the
project. To use this resource, the requesting API Key must have the
@@ -14473,6 +14932,9 @@ paths:
x-xgen-changelog:
2024-10-02: The MongoDB Atlas Streams Processing Private Link API is now exposed
as part of private preview, but is subject to change until GA.
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getPrivateLinkConnection
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections":
get:
description: Returns a list of incoming VPC Peering Connections.
@@ -14500,6 +14962,10 @@ paths:
summary: Return All VPC Peering Connections.
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getVpcPeeringConnections
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}":
delete:
description: Deletes an incoming VPC Peering connection.
@@ -14531,6 +14997,9 @@ paths:
summary: Deletes an incoming VPC Peering connection.
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteVpcPeeringConnection
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept":
post:
description: Requests the acceptance of an incoming VPC Peering connection.
@@ -14570,6 +15039,9 @@ paths:
summary: Requests the acceptance of an incoming VPC Peering connection.
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/acceptVpcPeeringConnection
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject":
post:
description: Requests the rejection of an incoming VPC Peering connection.
@@ -14601,6 +15073,9 @@ paths:
summary: Requests the rejection of an incoming VPC Peering connection.
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/rejectVpcPeeringConnection
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/streams/{tenantName}":
delete:
description: Delete one stream instance in the specified project. To use this
@@ -14637,6 +15112,7 @@ paths:
x-xgen-changelog:
2023-09-11: The MongoDB Atlas Streams Processing API is now exposed as part of
private preview, but is subject to change until GA.
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamInstance
get:
description: Returns the details of one stream instance within the specified
project. To use this resource, the requesting API Key must have the
@@ -14679,6 +15155,7 @@ paths:
x-xgen-changelog:
2023-09-11: The MongoDB Atlas Streams Processing API is now exposed as part of
private preview, but is subject to change until GA.
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamInstance
patch:
description: Update one stream instance in the specified project. To use this
resource, the requesting API Key must have the Project Data Access Admin
@@ -14724,6 +15201,7 @@ paths:
x-xgen-changelog:
2023-09-11: The MongoDB Atlas Streams Processing API is now exposed as part of
private preview, but is subject to change until GA.
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamInstance
"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs":
get:
description: 'Downloads the audit logs for the specified Atlas Streams
@@ -14787,6 +15265,7 @@ paths:
summary: Download Audit Logs for One Atlas Stream Processing Instance
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadStreamTenantAuditLogs
"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections":
get:
description: Returns all connections of the stream instance for the specified
@@ -14824,6 +15303,7 @@ paths:
x-xgen-changelog:
2023-09-11: The MongoDB Atlas Streams Processing API is now exposed as part of
private preview, but is subject to change until GA.
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamConnections
post:
description: Creates one connection for a stream instance in the specified
project. To use this resource, the requesting API Key must have the
@@ -14867,6 +15347,7 @@ paths:
x-xgen-changelog:
2023-09-11: The MongoDB Atlas Streams Processing API is now exposed as part of
private preview, but is subject to change until GA.
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamConnection
"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}":
delete:
description: Delete one connection of the specified stream instance. To use this
@@ -14911,6 +15392,7 @@ paths:
x-xgen-changelog:
2023-09-11: The MongoDB Atlas Streams Processing API is now exposed as part of
private preview, but is subject to change until GA.
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamConnection
get:
description: Returns the details of one stream connection within the specified
stream instance. To use this resource, the requesting API Key must have
@@ -14950,6 +15432,7 @@ paths:
x-xgen-changelog:
2023-09-11: The MongoDB Atlas Streams Processing API is now exposed as part of
private preview, but is subject to change until GA.
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamConnection
patch:
description: Update one connection for the specified stream instance in the
specified project. To use this resource, the requesting API Key must
@@ -15003,6 +15486,7 @@ paths:
x-xgen-changelog:
2023-09-11: The MongoDB Atlas Streams Processing API is now exposed as part of
private preview, but is subject to change until GA.
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamConnection
"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor":
post:
description: Create one Stream Processor within the specified stream instance.
@@ -15043,6 +15527,7 @@ paths:
summary: Create One Stream Processor
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamProcessor
"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}":
delete:
description: Delete a Stream Processor within the specified stream instance. To
@@ -15080,6 +15565,7 @@ paths:
summary: Delete One Stream Processor
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamProcessor
get:
description: Get one Stream Processor within the specified stream instance. To
use this resource, the requesting API Key must have the Project Owner
@@ -15118,6 +15604,7 @@ paths:
summary: Get One Stream Processor
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamProcessor
patch:
description: Modify one existing Stream Processor within the specified stream
instance. To use this resource, the requesting API Key must have the
@@ -15165,6 +15652,7 @@ paths:
summary: Modify One Stream Processor
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/modifyStreamProcessor
"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start":
post:
description: Start a Stream Processor within the specified stream instance. To
@@ -15204,6 +15692,7 @@ paths:
summary: Start One Stream Processor
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessor
"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop":
post:
description: Stop a Stream Processor within the specified stream instance. To
@@ -15243,6 +15732,7 @@ paths:
summary: Stop One Stream Processor
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/stopStreamProcessor
"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors":
get:
description: Returns all Stream Processors within the specified stream instance.
@@ -15279,6 +15769,7 @@ paths:
summary: Return All Stream Processors In The Stream Instance.
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamProcessors
"/api/atlas/v2/groups/{groupId}/streams:withSampleConnections":
post:
description: Creates one stream instance in the specified project with sample
@@ -15312,6 +15803,7 @@ paths:
summary: Create One Stream Instance With Sample Connections
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstanceWithSampleConnections
"/api/atlas/v2/groups/{groupId}/teams":
get:
description: Returns all teams to which the authenticated user has access in the
@@ -15345,6 +15837,7 @@ paths:
summary: Return All Teams in One Project
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listProjectTeams
post:
description: Adds one team to the specified project. All members of the team
share the same project access. MongoDB Cloud limits the number of users
@@ -15387,6 +15880,9 @@ paths:
summary: Add One or More Teams to One Project
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addAllTeamsToProject
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/teams/{teamId}":
delete:
description: Removes one team specified using its unique 24-hexadecimal digit
@@ -15406,8 +15902,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -15428,6 +15922,7 @@ paths:
summary: Remove One Team from One Project
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam
patch:
description: Updates the project roles assigned to the specified team. You can
grant team roles for specific projects and grant project access roles to
@@ -15447,8 +15942,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -15478,6 +15971,7 @@ paths:
summary: Update Team Roles in One Project
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/updateTeamRoles
"/api/atlas/v2/groups/{groupId}/userSecurity":
get:
description: Returns the current LDAP configuration for the specified project.
@@ -15501,6 +15995,7 @@ paths:
summary: Return the Current LDAP or X.509 Configuration
tags:
- LDAP Configuration
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfiguration
patch:
description: >-
Edits the LDAP configuration for the specified project. To use this
@@ -15535,6 +16030,7 @@ paths:
summary: Edit the LDAP or X.509 Configuration
tags:
- LDAP Configuration
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/saveLdapConfiguration
"/api/atlas/v2/groups/{groupId}/userSecurity/customerX509":
delete:
description: >-
@@ -15560,6 +16056,10 @@ paths:
summary: Disable Customer-Managed X.509
tags:
- X.509 Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableCustomerManagedX509
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping":
delete:
description: Removes the current LDAP Distinguished Name mapping captured in the
@@ -15584,6 +16084,10 @@ paths:
summary: Remove the Current LDAP User to DN Mapping
tags:
- LDAP Configuration
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/deleteLdapConfiguration
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify":
post:
description: Verifies the LDAP configuration for the specified project. To use
@@ -15616,6 +16120,9 @@ paths:
summary: Verify the LDAP Configuration in One Project
tags:
- LDAP Configuration
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyLdapConfiguration
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}":
get:
description: Returns the status of one request to verify one LDAP configuration
@@ -15632,8 +16139,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -15650,12 +16155,15 @@ paths:
summary: Return the Status of One Verify LDAP Configuration Request
tags:
- LDAP Configuration
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfigurationStatus
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/groups/{groupId}/users":
get:
- deprecated: true
- description: Returns details about all users in the specified project. Users
+ description: "Returns details about all users in the specified project. Users
belong to an organization. To use this resource, the requesting API Key
- must have the Project Read Only role.
+ must have the Project Read Only role. Deprecated versions:
+ v2-{2023-01-01}"
operationId: listProjectUsers
parameters:
- $ref: "#/components/parameters/groupId"
@@ -15687,21 +16195,13 @@ paths:
schema:
type: boolean
default: false
- - description: Flag that indicates whether to filter the returned list by users
- organization membership status. If you exclude this parameter, this
- resource returns both pending and active users.
- in: query
- name: orgMembershipStatus
- schema:
- type: string
- example: ACTIVE
responses:
"200":
content:
- application/vnd.atlas.2023-01-01+json:
+ application/vnd.atlas.2043-01-01+json:
schema:
- $ref: "#/components/schemas/PaginatedAppUser"
- x-xgen-version: 2023-01-01
+ $ref: "#/components/schemas/PaginatedGroupUser"
+ x-xgen-version: 2043-01-01
description: OK
"401":
$ref: "#/components/responses/unauthorized"
@@ -15710,11 +16210,57 @@ paths:
summary: Return All Users in One Project
tags:
- Projects
- x-sunset: 2044-01-01
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectUsers
+ post:
+ description: >
+ Adds one MongoDB Cloud user to one project. To use this resource, the
+ requesting API Key must have the Project Owner role.
+
+ - If the user has a pending invitation to join the project's organization, MongoDB Cloud modifies it and grants project access.
+
+ - If the user doesn't have an invitation to join the organization, MongoDB Cloud sends a new invitation that grants the user organization and project access.
+
+ - If the user is already active in the project's organization, MongoDB Cloud grants access to the project.
+ operationId: addProjectUser
+ parameters:
+ - $ref: "#/components/parameters/groupId"
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/GroupUserRequest"
+ description: The active or pending MongoDB Cloud user that you want to add to
+ the specified project.
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/GroupUserResponse"
+ x-xgen-version: 2043-01-01
+ description: Created
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "409":
+ $ref: "#/components/responses/conflict"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Add One MongoDB Cloud User to One Project
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectUser
"/api/atlas/v2/groups/{groupId}/users/{userId}":
delete:
- description: Removes the specified user from the specified project. To use this
+ description: "Removes the specified user from the specified project. To use this
resource, the requesting API Key must have the Project Owner role.
+ Deprecated versions: v2-{2023-01-01}"
operationId: removeProjectUser
parameters:
- $ref: "#/components/parameters/groupId"
@@ -15727,14 +16273,14 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
content:
- application/vnd.atlas.2023-01-01+json:
- x-xgen-version: 2023-01-01
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/NoBody"
+ x-xgen-version: 2043-01-01
description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
@@ -15747,8 +16293,56 @@ paths:
summary: Remove One User from One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/removeProjectUser
+ get:
+ description: >-
+ Returns information about the specified MongoDB Cloud user within the
+ context of the specified project. To use this resource, the requesting
+ API Key must have the Project Read Only role.
+
+
+ **Note**: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint.
+
+
+ **Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: getProjectUser
+ parameters:
+ - $ref: "#/components/parameters/groupId"
+ - description: Unique 24-hexadecimal digit string that identifies the pending or
+ active user in the project. If you need to lookup a user's userId or
+ verify a user's status in the organization, use the Return All
+ MongoDB Cloud Users in One Project resource and filter by username.
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ pattern: ^([a-f0-9]{24})$
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/GroupUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Return One MongoDB Cloud User in One Project
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getProjectUser
"/api/atlas/v2/groups/{groupId}/users/{userId}/roles":
put:
+ deprecated: true
description: Updates the roles of the specified user in the specified project.
To specify the user to update, provide the unique 24-hexadecimal digit
string that identifies the user in the specified project. To use this
@@ -15763,8 +16357,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -15792,6 +16384,120 @@ paths:
summary: Update Project Roles for One MongoDB Cloud User
tags:
- Projects
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectRoles
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
+ "/api/atlas/v2/groups/{groupId}/users/{userId}:addRole":
+ post:
+ description: >-
+ Adds one project-level role to the MongoDB Cloud user. You can add a
+ role to an active user or a user that has been invited to join the
+ project. To use this resource, the requesting API Key must have the
+ Project Owner role.
+
+
+ **Note**: This resource cannot be used to add a role to users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: addProjectRole
+ parameters:
+ - $ref: "#/components/parameters/groupId"
+ - description: Unique 24-hexadecimal digit string that identifies the pending or
+ active user in the project. If you need to lookup a user's userId or
+ verify a user's status in the organization, use the Return All
+ MongoDB Cloud Users in One Project resource and filter by username.
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ pattern: ^([a-f0-9]{24})$
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/AddOrRemoveGroupRole"
+ description: Project-level role to assign to the MongoDB Cloud user.
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "409":
+ $ref: "#/components/responses/conflict"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Add One Project Role to One MongoDB Cloud User
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectRole
+ "/api/atlas/v2/groups/{groupId}/users/{userId}:removeRole":
+ post:
+ description: >-
+ Removes one project-level role from the MongoDB Cloud user. You can
+ remove a role from an active user or a user that has been invited to
+ join the project. To replace a user's only role, add the new role before
+ removing the old role. A user must have at least one role at all times.
+ To use this resource, the requesting API Key must have the Project Owner
+ role.
+
+
+ **Note**: This resource cannot be used to remove a role from users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: removeProjectRole
+ parameters:
+ - $ref: "#/components/parameters/groupId"
+ - description: Unique 24-hexadecimal digit string that identifies the pending or
+ active user in the project. If you need to lookup a user's userId or
+ verify a user's status in the organization, use the Return All
+ MongoDB Cloud Users in One Project resource and filter by username.
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ pattern: ^([a-f0-9]{24})$
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/AddOrRemoveGroupRole"
+ description: Project-level role to remove from the MongoDB Cloud user.
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "409":
+ $ref: "#/components/responses/conflict"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Remove One Project Role from One MongoDB Cloud User
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectRole
"/api/atlas/v2/groups/{groupId}:migrate":
post:
description: Migrates a project from its current organization to another
@@ -15829,6 +16535,7 @@ paths:
summary: Migrate One Project to Another Organization
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/migrateProjectToAnotherOrg
/api/atlas/v2/orgs:
get:
description: Returns all organizations to which the requesting API Key has
@@ -15867,6 +16574,7 @@ paths:
summary: Return All Organizations
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizations
post:
description: Creates one organization in MongoDB Cloud and links it to the
requesting API Key's organization. To use this resource, the requesting
@@ -15907,6 +16615,7 @@ paths:
summary: Create One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganization
"/api/atlas/v2/orgs/{orgId}":
delete:
description: >-
@@ -15942,6 +16651,7 @@ paths:
summary: Remove One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganization
get:
description: Returns one organization to which the requesting API key has
access. To use this resource, the requesting API Key must have the
@@ -15970,6 +16680,7 @@ paths:
summary: Return One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganization
patch:
description: Updates one organization. To use this resource, the requesting API
Key must have the Organization Owner role.
@@ -16004,6 +16715,7 @@ paths:
summary: Update One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganization
"/api/atlas/v2/orgs/{orgId}/apiKeys":
get:
description: Returns all organization API keys for the specified organization.
@@ -16035,6 +16747,7 @@ paths:
summary: Return All Organization API Keys
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeys
post:
description: Creates one API key for the specified organization. An organization
API key grants programmatic access to an organization. You can't use the
@@ -16068,6 +16781,7 @@ paths:
summary: Create One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey
"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}":
delete:
description: Removes one organization API key from the specified organization.
@@ -16087,8 +16801,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -16105,6 +16817,7 @@ paths:
summary: Remove One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKey
get:
description: Returns one organization API key. The organization API keys grant
programmatic access to an organization. You can't use the API key to log
@@ -16123,8 +16836,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -16141,6 +16852,7 @@ paths:
summary: Return One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey
patch:
description: Updates one organization API key in the specified organization. The
organization API keys grant programmatic access to an organization. To
@@ -16159,8 +16871,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -16187,6 +16897,7 @@ paths:
summary: Update One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKey
"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList":
get:
description: Returns all access list entries that you configured for the
@@ -16209,8 +16920,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -16227,6 +16936,7 @@ paths:
summary: Return All Access List Entries for One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeyAccessListsEntries
post:
description: Creates the access list entries for the specified organization API
key. Resources require all API requests originate from IP addresses on
@@ -16246,8 +16956,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -16278,6 +16986,7 @@ paths:
summary: Create Access List Entries for One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKeyAccessList
"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}":
delete:
description: Removes the specified access list entry from the specified
@@ -16300,8 +17009,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
- description: One IP address or multiple IP addresses represented as one CIDR
block to limit requests to API resources in the specified
@@ -16333,6 +17040,7 @@ paths:
summary: Remove One Access List Entry for One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry
get:
description: Returns one access list entry for the specified organization API
key. Resources require all API requests originate from IP addresses on
@@ -16364,8 +17072,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -16384,6 +17090,7 @@ paths:
summary: Return One Access List Entry for One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKeyAccessList
"/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage":
post:
description: Creates a query process within the Cost Explorer for the given
@@ -16416,6 +17123,9 @@ paths:
summary: Create Cost Explorer query process
tags:
- Invoices
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/createCostExplorerQueryProcess
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}":
get:
description: Returns the usage details for a Cost Explorer query, if the query
@@ -16460,6 +17170,9 @@ paths:
results are not ready yet.
tags:
- Invoices
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getCostExplorerQueryProcess
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/orgs/{orgId}/events":
get:
description: >-
@@ -16496,24 +17209,25 @@ paths:
type: boolean
default: false
- description: Date and time from when MongoDB Cloud stops returning events. This
- parameter uses the ISO 8601 timestamp
- format in UTC.
+ parameter uses the ISO 8601 timestamp format in UTC.
in: query
name: maxDate
schema:
type: string
format: date-time
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
- description: Date and time from when MongoDB Cloud starts returning events. This
- parameter uses the ISO 8601 timestamp
- format in UTC.
+ parameter uses the ISO 8601 timestamp format in UTC.
in: query
name: minDate
schema:
type: string
format: date-time
- example: 2021-11-17T23:15:00.06Z
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
responses:
"200":
content:
@@ -16529,6 +17243,7 @@ paths:
summary: Return All Events from One Organization
tags:
- Events
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents
"/api/atlas/v2/orgs/{orgId}/events/{eventId}":
get:
description: >-
@@ -16551,8 +17266,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
- description: Flag that indicates whether to include the raw document in the
output. The raw document contains additional meta information about
@@ -16579,6 +17292,7 @@ paths:
summary: Return One Event from One Organization
tags:
- Events
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getOrganizationEvent
"/api/atlas/v2/orgs/{orgId}/federationSettings":
get:
description: Returns information about the federation settings for the specified
@@ -16606,6 +17320,9 @@ paths:
summary: Return Federation Settings for One Organization
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettings
+ x-xgen-IPA-exception:
+ xgen-IPA-113-singleton-must-not-have-id: API predates IPA validation
"/api/atlas/v2/orgs/{orgId}/groups":
get:
description: >-
@@ -16655,8 +17372,10 @@ paths:
summary: Return One or More Projects in One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationProjects
"/api/atlas/v2/orgs/{orgId}/invites":
get:
+ deprecated: true
description: Returns all pending invitations to the specified organization. To
use this resource, the requesting API Key must have the Organization
Owner role.
@@ -16692,7 +17411,10 @@ paths:
summary: Return All Organization Invitations
tags:
- Organizations
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationInvitations
patch:
+ deprecated: true
description: Updates the details of one pending invitation to the specified
organization. To specify which invitation, provide the username of the
invited user. To use this resource, the requesting API Key must have the
@@ -16727,7 +17449,10 @@ paths:
summary: Update One Organization Invitation
tags:
- Organizations
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitation
post:
+ deprecated: true
description: Invites one MongoDB Cloud user to join the specified organization.
The user must accept the invitation to access information within the
specified organization. To use this resource, the requesting API Key
@@ -16761,8 +17486,11 @@ paths:
summary: Invite One MongoDB Cloud User to Join One Atlas Organization
tags:
- Organizations
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganizationInvitation
"/api/atlas/v2/orgs/{orgId}/invites/{invitationId}":
delete:
+ deprecated: true
description: Cancels one pending invitation sent to the specified MongoDB Cloud
user to join an organization. You can't cancel an invitation that the
user accepted. To use this resource, the requesting API Key must have
@@ -16795,7 +17523,10 @@ paths:
summary: Cancel One Organization Invitation
tags:
- Organizations
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganizationInvitation
get:
+ deprecated: true
description: Returns the details of one pending invitation to the specified
organization. To use this resource, the requesting API Key must have the
Organization Owner role.
@@ -16808,8 +17539,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -16830,7 +17559,10 @@ paths:
summary: Return One Organization Invitation
tags:
- Organizations
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationInvitation
patch:
+ deprecated: true
description: Updates the details of one pending invitation to the specified
organization. To specify which invitation, provide the unique
identification string for that invitation. Use the Return All
@@ -16846,8 +17578,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -16876,6 +17606,8 @@ paths:
summary: Update One Organization Invitation by Invitation ID
tags:
- Organizations
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitationById
"/api/atlas/v2/orgs/{orgId}/invoices":
get:
description: >-
@@ -16943,6 +17675,8 @@ paths:
schema:
type: string
default: desc
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
responses:
"200":
content:
@@ -16960,6 +17694,7 @@ paths:
summary: Return All Invoices for One Organization
tags:
- Invoices
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listInvoices
"/api/atlas/v2/orgs/{orgId}/invoices/pending":
get:
description: Returns all invoices accruing charges for the current billing cycle
@@ -16988,6 +17723,9 @@ paths:
summary: Return All Pending Invoices for One Organization
tags:
- Invoices
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listPendingInvoices
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}":
get:
description: >-
@@ -17011,8 +17749,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -17035,6 +17771,7 @@ paths:
summary: Return One Organization Invoice
tags:
- Invoices
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getInvoice
"/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv":
get:
description: >-
@@ -17086,6 +17823,7 @@ paths:
summary: Return One Organization Invoice as CSV
tags:
- Invoices
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/downloadInvoiceCsv
"/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search":
get:
description: Query the lineItems of the specified invoice and return the result
@@ -17103,8 +17841,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -17132,6 +17868,7 @@ paths:
summary: Query lineItems of the specified invoiceId
tags:
- Invoices
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/queryLineItemsFromSingleInvoice
"/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects":
get:
description: Return all projects that you can migrate to the specified organization.
@@ -17157,6 +17894,9 @@ paths:
summary: Return All Projects Available for Migration
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/listSourceProjects
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens":
delete:
description: Remove one organization link and its associated public API key.
@@ -17184,6 +17924,7 @@ paths:
summary: Remove One Link-Token
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/deleteLinkToken
post:
description: Create one link-token that contains all the information required to
complete the link. MongoDB Atlas uses the link-token for push live
@@ -17217,6 +17958,10 @@ paths:
summary: Create One Link-Token
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createLinkToken
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/orgs/{orgId}/nonCompliantResources":
get:
description: Return all non-compliant resources for an org.
@@ -17247,6 +17992,7 @@ paths:
summary: Return all non-compliant resources
tags:
- Resource Policies
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getResourcesNonCompliant
"/api/atlas/v2/orgs/{orgId}/resourcePolicies":
get:
description: Return all Atlas Resource Policies for the org.
@@ -17277,6 +18023,7 @@ paths:
summary: Return all Atlas Resource Policies
tags:
- Resource Policies
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicies
post:
description: Create one Atlas Resource Policy for an org.
externalDocs:
@@ -17317,6 +18064,7 @@ paths:
summary: Create one Atlas Resource Policy
tags:
- Resource Policies
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/createAtlasResourcePolicy
"/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}":
delete:
description: Delete one Atlas Resource Policy for an org.
@@ -17336,8 +18084,6 @@ paths:
description: Unique 24-hexadecimal character string that identifies the atlas
resource policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
responses:
@@ -17359,6 +18105,7 @@ paths:
summary: Delete one Atlas Resource Policy
tags:
- Resource Policies
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteAtlasResourcePolicy
get:
description: Return one Atlas Resource Policy for an org.
externalDocs:
@@ -17377,8 +18124,6 @@ paths:
description: Unique 24-hexadecimal character string that identifies the atlas
resource policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
responses:
@@ -17400,6 +18145,7 @@ paths:
summary: Return one Atlas Resource Policy
tags:
- Resource Policies
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicy
patch:
description: Update one Atlas Resource Policy for an org.
externalDocs:
@@ -17418,8 +18164,6 @@ paths:
description: Unique 24-hexadecimal character string that identifies the atlas
resource policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
requestBody:
@@ -17454,6 +18198,7 @@ paths:
summary: Update one Atlas Resource Policy
tags:
- Resource Policies
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/updateAtlasResourcePolicy
"/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate":
post:
description: Validate one Atlas Resource Policy for an org.
@@ -17495,6 +18240,7 @@ paths:
summary: Validate one Atlas Resource Policy
tags:
- Resource Policies
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/validateAtlasResourcePolicy
"/api/atlas/v2/orgs/{orgId}/serviceAccounts":
get:
description: Returns all Service Accounts for the specified Organization.
@@ -17521,6 +18267,7 @@ paths:
summary: List All Organization Service Accounts
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccounts
post:
description: Creates one Service Account for the specified Organization.
Available as a preview feature.
@@ -17551,6 +18298,7 @@ paths:
summary: Create one Organization Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccount
"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}":
delete:
description: Deletes the specified Service Account. Available as a preview feature.
@@ -17580,6 +18328,7 @@ paths:
summary: Delete one Organization Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccount
get:
description: Returns the specified Service Account. Available as a preview feature.
operationId: getServiceAccount
@@ -17610,6 +18359,7 @@ paths:
summary: Get one Organization Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getServiceAccount
patch:
description: Updates the specified Service Account in the specified
Organization. Available as a preview feature.
@@ -17650,6 +18400,7 @@ paths:
summary: Update one Organization Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateServiceAccount
"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList":
get:
description: Returns all access list entries that you configured for the
@@ -17684,6 +18435,7 @@ paths:
summary: Return All Access List entries for one Organization Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountAccessList
post:
description: Add Access List Entries for the specified Service Account for the
organization. Resources require all API requests to originate from IP
@@ -17732,6 +18484,9 @@ paths:
summary: Add Access List entries for one Organization Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountAccessList
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}":
delete:
description: Removes the specified access list entry from the specified Service
@@ -17775,6 +18530,7 @@ paths:
summary: Remove One Access List entry from one Organization Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountAccessListEntry
"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups":
get:
description: Returns a list of all projects the specified Service Account is a
@@ -17809,6 +18565,7 @@ paths:
summary: Return All Service Account Project assignments
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountProjects
"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets":
post:
description: Create a secret for the specified Service Account. Available as a
@@ -17848,6 +18605,9 @@ paths:
summary: Create one Organization Service Account Secret
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountSecret
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}":
delete:
description: Deletes the specified Service Account secret. Available as a
@@ -17884,6 +18644,7 @@ paths:
summary: Delete a Organization Service Account Secret
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountSecret
"/api/atlas/v2/orgs/{orgId}/settings":
get:
description: Returns details about the specified organization's settings. To use
@@ -17911,6 +18672,7 @@ paths:
summary: Return Settings for One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationSettings
patch:
description: Updates the organization's settings. To use this resource, the
requesting API Key must have the Organization Owner role.
@@ -17945,6 +18707,7 @@ paths:
summary: Update Settings for One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationSettings
"/api/atlas/v2/orgs/{orgId}/teams":
get:
description: Returns all teams that belong to the specified organization. Teams
@@ -17979,6 +18742,7 @@ paths:
summary: Return All Teams in One Organization
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listOrganizationTeams
post:
description: Creates one team in the specified organization. Teams enable you to
grant project access roles to MongoDB Cloud users. MongoDB Cloud limits
@@ -18019,6 +18783,7 @@ paths:
summary: Create One Team in One Organization
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/createTeam
"/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}":
get:
description: Returns one team that you identified using its human-readable name.
@@ -18056,6 +18821,9 @@ paths:
summary: Return One Team using its Name
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamByName
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/orgs/{orgId}/teams/{teamId}":
delete:
description: Removes one team specified using its unique 24-hexadecimal digit
@@ -18075,8 +18843,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -18097,6 +18863,7 @@ paths:
summary: Remove One Team from One Organization
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/deleteTeam
get:
description: Returns one team that you identified using its unique
24-hexadecimal digit ID. This team belongs to one organization. Teams
@@ -18116,8 +18883,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -18138,6 +18903,7 @@ paths:
summary: Return One Team using its ID
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamById
patch:
description: Renames one team in the specified organization. Teams enable you to
grant project access roles to MongoDB Cloud users. To use this resource,
@@ -18155,8 +18921,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -18186,13 +18950,14 @@ paths:
summary: Rename One Team
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameTeam
"/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users":
get:
- description: Returns all MongoDB Cloud users assigned to the team specified
+ description: "Returns all MongoDB Cloud users assigned to the team specified
using its unique 24-hexadecimal digit identifier. This team belongs to
one organization. Teams enable you to grant project access roles to
MongoDB Cloud users. To use this resource, the requesting API Key must
- have the Organization Member role.
+ have the Organization Member role. Deprecated versions: v2-{2023-01-01}"
externalDocs:
description: Manage Organization Teams
url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
@@ -18208,16 +18973,14 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
content:
- application/vnd.atlas.2023-01-01+json:
+ application/vnd.atlas.2043-01-01+json:
schema:
- $ref: "#/components/schemas/PaginatedAppUser"
- x-xgen-version: 2023-01-01
+ $ref: "#/components/schemas/PaginatedOrgUser"
+ x-xgen-version: 2043-01-01
description: OK
"400":
$ref: "#/components/responses/badRequest"
@@ -18232,7 +18995,9 @@ paths:
summary: Return All MongoDB Cloud Users Assigned to One Team
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listTeamUsers
post:
+ deprecated: true
description: Adds one or more MongoDB Cloud users from the specified
organization to the specified team. Teams enable you to grant project
access roles to MongoDB Cloud users. You can assign up to 250 MongoDB
@@ -18251,8 +19016,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -18285,8 +19048,13 @@ paths:
summary: Assign MongoDB Cloud Users from One Organization to One Team
tags:
- Teams
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addTeamUser
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
"/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}":
delete:
+ deprecated: true
description: Removes one MongoDB Cloud user from the specified team. This team
belongs to one organization. Teams enable you to grant project access
roles to MongoDB Cloud users. To use this resource, the requesting API
@@ -18304,8 +19072,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
- description: Unique 24-hexadecimal digit string that identifies MongoDB Cloud
user that you want to remove from the specified team.
@@ -18314,8 +19080,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
@@ -18334,13 +19098,117 @@ paths:
summary: Remove One MongoDB Cloud User from One Team
tags:
- Teams
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeTeamUser
+ "/api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser":
+ post:
+ description: >-
+ Adds one MongoDB Cloud user to one team. You can add an active user or a
+ user that has not yet accepted the invitation to join the organization.
+ To use this resource, the requesting API Key must have the Organization
+ Owner role.
+
+
+ **Note**: This resource cannot be used to add a user invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: addUserToTeam
+ parameters:
+ - $ref: "#/components/parameters/orgId"
+ - description: Unique 24-hexadecimal digit string that identifies the team to add
+ the MongoDB Cloud user to.
+ in: path
+ name: teamId
+ required: true
+ schema:
+ type: string
+ pattern: ^([a-f0-9]{24})$
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/AddOrRemoveUserFromTeam"
+ description: The active or pending MongoDB Cloud user that you want to add to
+ the specified team.
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Add One MongoDB Cloud User to One Team
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addUserToTeam
+ "/api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser":
+ post:
+ description: >-
+ Removes one MongoDB Cloud user from one team. You can remove an active
+ user or a user that has not yet accepted the invitation to join the
+ organization. To use this resource, the requesting API Key must have the
+ Organization Owner role.
+
+
+ **Note**: This resource cannot be used to remove a user invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: removeUserFromTeam
+ parameters:
+ - $ref: "#/components/parameters/orgId"
+ - description: Unique 24-hexadecimal digit string that identifies the team to
+ remove the MongoDB user from.
+ in: path
+ name: teamId
+ required: true
+ schema:
+ type: string
+ pattern: ^([a-f0-9]{24})$
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/AddOrRemoveUserFromTeam"
+ description: The id of the active or pending MongoDB Cloud user that you want to
+ remove from the specified team.
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Remove One MongoDB Cloud User from One Team
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeUserFromTeam
"/api/atlas/v2/orgs/{orgId}/users":
get:
- description: Returns details about the MongoDB Cloud users associated with the
+ description: "Returns details about the MongoDB Cloud users associated with the
specified organization. Each MongoDB Cloud user returned must belong to
the specified organization or to a project within the specified
organization. To use this resource, the requesting API Key must have the
- Organization Member role.
+ Organization Member role. Deprecated versions: v2-{2023-01-01}"
operationId: listOrganizationUsers
parameters:
- $ref: "#/components/parameters/orgId"
@@ -18350,10 +19218,10 @@ paths:
responses:
"200":
content:
- application/vnd.atlas.2023-01-01+json:
+ application/vnd.atlas.2043-01-01+json:
schema:
- $ref: "#/components/schemas/PaginatedAppUser"
- x-xgen-version: 2023-01-01
+ $ref: "#/components/schemas/PaginatedOrgUser"
+ x-xgen-version: 2043-01-01
description: OK
"400":
$ref: "#/components/responses/badRequest"
@@ -18366,11 +19234,56 @@ paths:
summary: Return All MongoDB Cloud Users in One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationUsers
+ post:
+ description: >-
+ Invites one new or existing MongoDB Cloud user to join the organization.
+ The invitation to join the organization will be sent to the username
+ provided and must be accepted within 30 days. To use this resource, the
+ requesting API Key must have the Organization Owner role.
+
+
+ **Note**: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization.
+ operationId: createOrganizationUser
+ parameters:
+ - $ref: "#/components/parameters/orgId"
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserRequest"
+ description: Represents the MongoDB Cloud user to be created within the
+ organization.
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: Created
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "409":
+ $ref: "#/components/responses/conflict"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Add One MongoDB Cloud User to One Organization
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrganizationUser
"/api/atlas/v2/orgs/{orgId}/users/{userId}":
delete:
- description: Removes one MongoDB Cloud user from the specified organization. To
+ description: "Removes one MongoDB Cloud user from the specified organization. To
use this resource, the requesting API Key must have the Organization
- User Admin role.
+ User Admin role. Deprecated versions: v2-{2023-01-01}"
operationId: removeOrganizationUser
parameters:
- $ref: "#/components/parameters/orgId"
@@ -18381,16 +19294,14 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"204":
content:
- application/vnd.atlas.2023-01-01+json:
+ application/vnd.atlas.2043-01-01+json:
schema:
$ref: "#/components/schemas/NoBody"
- x-xgen-version: 2023-01-01
+ x-xgen-version: 2043-01-01
description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
@@ -18405,8 +19316,112 @@ paths:
summary: Remove One MongoDB Cloud User From One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/removeOrganizationUser
+ get:
+ description: >-
+ Returns information about the specified MongoDB Cloud user within the
+ context of the specified organization. To use this resource, the
+ requesting API Key must have the Organization Member role.
+
+
+ **Note**: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint.
+
+
+ **Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: getOrganizationUser
+ parameters:
+ - $ref: "#/components/parameters/orgId"
+ - description: Unique 24-hexadecimal digit string that identifies the pending or
+ active user in the organization. If you need to lookup a user's
+ userId or verify a user's status in the organization, use the Return
+ All MongoDB Cloud Users in One Organization resource and filter by
+ username.
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ pattern: ^([a-f0-9]{24})$
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Return One MongoDB Cloud User in One Organization
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrganizationUser
+ patch:
+ description: >-
+ Updates one MongoDB Cloud user in the specified organization. You can
+ update an active user or a user that has not yet accepted the invitation
+ to join the organization. To use this resource, the requesting API Key
+ must have the Organization Owner role.
+
+
+ **Note**: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user.
+
+
+ **Note**: This resource cannot be used to update pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: updateOrganizationUser
+ parameters:
+ - $ref: "#/components/parameters/orgId"
+ - description: Unique 24-hexadecimal digit string that identifies the pending or
+ active user in the organization. If you need to lookup a user's
+ userId or verify a user's status in the organization, use the Return
+ All MongoDB Cloud Users in One Organization resource and filter by
+ username.
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ pattern: ^([a-f0-9]{24})$
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserUpdateRequest"
+ description: Represents the roles and teams to assign the MongoDB Cloud user.
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Update One MongoDB Cloud User in One Organization
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser
"/api/atlas/v2/orgs/{orgId}/users/{userId}/roles":
put:
+ deprecated: true
description: Updates the roles of the specified user in the specified
organization. To specify the user to update, provide the unique
24-hexadecimal digit string that identifies the user in the specified
@@ -18422,8 +19437,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
requestBody:
content:
@@ -18451,6 +19464,126 @@ paths:
summary: Update Organization Roles for One MongoDB Cloud User
tags:
- Organizations
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationRoles
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
+ "/api/atlas/v2/orgs/{orgId}/users/{userId}:addRole":
+ post:
+ description: >-
+ Adds one organization-level role to the MongoDB Cloud user. You can add
+ a role to an active user or a user that has not yet accepted the
+ invitation to join the organization. To use this resource, the
+ requesting API Key must have the Organization Owner role.
+
+
+ **Note**: This operation is atomic.
+
+
+ **Note**: This resource cannot be used to add a role to users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: addOrganizationRole
+ parameters:
+ - $ref: "#/components/parameters/orgId"
+ - description: Unique 24-hexadecimal digit string that identifies the pending or
+ active user in the organization. If you need to lookup a user's
+ userId or verify a user's status in the organization, use the Return
+ All MongoDB Cloud Users in One Organization resource and filter by
+ username.
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ pattern: ^([a-f0-9]{24})$
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/AddOrRemoveOrgRole"
+ description: Organization-level role to assign to the MongoDB Cloud user.
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "409":
+ $ref: "#/components/responses/conflict"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Add One Organization Role to One MongoDB Cloud User
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrganizationRole
+ "/api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole":
+ post:
+ description: >-
+ Removes one organization-level role from the MongoDB Cloud user. You can
+ remove a role from an active user or a user that has not yet accepted
+ the invitation to join the organization. To replace a user's only role,
+ add the new role before removing the old role. A user must have at least
+ one role at all times. To use this resource, the requesting API Key must
+ have the Organization Owner role.
+
+
+ **Note**: This operation is atomic.
+
+
+ **Note**: This resource cannot be used to remove a role from users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: removeOrganizationRole
+ parameters:
+ - $ref: "#/components/parameters/orgId"
+ - description: Unique 24-hexadecimal digit string that identifies the pending or
+ active user in the organization. If you need to lookup a user's
+ userId or verify a user's status in the organization, use the Return
+ All MongoDB Cloud Users in One Organization resource and filter by
+ username.
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ pattern: ^([a-f0-9]{24})$
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/AddOrRemoveOrgRole"
+ description: Organization-level role to remove from the MongoDB Cloud user.
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Remove One Organization Role from One MongoDB Cloud User
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationRole
/api/atlas/v2/unauth/controlPlaneIPAddresses:
get:
description: Returns all control plane IP addresses.
@@ -18470,8 +19603,47 @@ paths:
summary: Return All Control Plane IP Addresses
tags:
- Root
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/returnAllControlPlaneIpAddresses
+ /api/atlas/v2/unauth/openapi/versions:
+ get:
+ description: API that provides a list of available versionsfor a given environment.
+ operationId: getApiVersions
+ parameters:
+ - $ref: "#/components/parameters/itemsPerPage"
+ - $ref: "#/components/parameters/pageNum"
+ - description: The environment to get the versions from. If not provided, it
+ returnsthe versions for the given MongoDB URL. (E.g. prod for
+ cloud.mongodb.com)
+ in: query
+ name: env
+ schema:
+ type: string
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2024-08-05+json:
+ schema:
+ $ref: "#/components/schemas/PaginatedApiVersions"
+ x-xgen-version: 2024-08-05
+ application/vnd.atlas.2024-08-05+yaml:
+ schema:
+ $ref: "#/components/schemas/PaginatedApiVersions"
+ x-xgen-version: 2024-08-05
+ description: OK
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ security: []
+ summary: Provides a list of versions for a given environment.
+ tags:
+ - OpenAPI
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/OpenAPI/operation/getApiVersions
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/users:
post:
+ deprecated: true
description: >-
Creates one MongoDB Cloud user account. A MongoDB Cloud user account
grants access to only the MongoDB Cloud application. To grant database
@@ -18509,8 +19681,11 @@ paths:
summary: Create One MongoDB Cloud User
tags:
- MongoDB Cloud Users
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createUser
"/api/atlas/v2/users/byName/{userName}":
get:
+ deprecated: true
description: Returns the details for one MongoDB Cloud user account with the
specified username. You can't use this endpoint to return information
about an API Key. To return information about an API Key, use the
@@ -18544,8 +19719,13 @@ paths:
summary: Return One MongoDB Cloud User using Their Username
tags:
- MongoDB Cloud Users
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUserByUsername
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
"/api/atlas/v2/users/{userId}":
get:
+ deprecated: true
description: Returns the details for one MongoDB Cloud user account with the
specified unique identifier for the user. You can't use this endpoint to
return information on an API Key. To return information about an API
@@ -18563,8 +19743,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
responses:
"200":
@@ -18583,6 +19761,8 @@ paths:
summary: Return One MongoDB Cloud User using Its ID
tags:
- MongoDB Cloud Users
+ x-sunset: 2044-01-01
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUser
components:
parameters:
collectionName:
@@ -18632,8 +19812,6 @@ components:
schema:
type: string
example: 55fa922fb343282757d9554e
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
granularity:
description: Duration that specifies the interval at which Atlas reports the
@@ -18659,8 +19837,6 @@ components:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
identityProviderId:
description: Legacy 20-hexadecimal digit string that identifies the identity
@@ -18673,8 +19849,6 @@ components:
schema:
type: string
example: c2777a9eca931f29fc2f
- maxLength: 20
- minLength: 20
pattern: ^([a-f0-9]{20})$
includeCount:
description: Flag that indicates whether the response returns the total number
@@ -18713,8 +19887,6 @@ components:
schema:
type: string
example: 6296fb4c7c7aa997cf94e9a8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
orgId:
description: Unique 24-hexadecimal digit string that identifies the organization
@@ -18727,8 +19899,6 @@ components:
schema:
type: string
example: 4888442a3354817a7320eb61
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
pageNum:
description: Number of the page that displays the current set of the total
@@ -18965,6 +20135,10 @@ components:
region, create the connection first. Deploy the cluster after the
connection starts.
title: AWS Regions
+ requirePrivateNetworking:
+ type: boolean
+ description: Enable connection to your Amazon Web Services (AWS) Key Management
+ Service (KMS) over private networking.
roleId:
type: string
description: Unique 24-hexadecimal digit string that identifies an Amazon Web
@@ -18972,8 +20146,6 @@ components:
role has the permissions required to manage your AWS customer master
key.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
writeOnly: true
secretAccessKey:
@@ -18998,11 +20170,12 @@ components:
type: string
format: date-time
description: Date and time until which this alert has been acknowledged. This
- parameter expresses its value in the ISO 8601 timestamp format in UTC. The
- resource returns this parameter if a MongoDB User previously
- acknowledged this alert.
+ parameter expresses its value in the ISO 8601 timestamp format in
+ UTC. The resource returns this parameter if a MongoDB User
+ previously acknowledged this alert.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
acknowledgementComment:
type: string
description: Comment that a MongoDB Cloud user submitted when acknowledging the
@@ -19026,6 +20199,34 @@ components:
alert. By default this value is set to false. If set to true, it
will override the acknowledgedUntil parameter.
title: Acknowledge Alert
+ AddOrRemoveGroupRole:
+ type: object
+ properties:
+ groupRole:
+ type: string
+ description: Project-level role.
+ required:
+ - groupRole
+ AddOrRemoveOrgRole:
+ type: object
+ properties:
+ orgRole:
+ type: string
+ description: Organization-level role.
+ required:
+ - orgRole
+ AddOrRemoveUserFromTeam:
+ type: object
+ properties:
+ id:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the MongoDB
+ Cloud user.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: ^([a-f0-9]{24})$
+ writeOnly: true
+ required:
+ - id
AddUserToTeam:
type: object
properties:
@@ -19034,8 +20235,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud user.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
required:
- id
@@ -19084,8 +20283,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this backup
policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
policyItems:
type: array
@@ -19100,17 +20297,18 @@ components:
format: date-time
description: >-
Date and time until which this alert has been acknowledged. This
- parameter expresses its value in the ISO 8601 timestamp format in UTC. The
- resource returns this parameter if a MongoDB User previously
- acknowledged this alert.
+ parameter expresses its value in the ISO 8601 timestamp format in
+ UTC. The resource returns this parameter if a MongoDB User
+ previously acknowledged this alert.
- To acknowledge this alert forever, set the parameter value to 100 years in the future.
- To unacknowledge a previously acknowledged alert, do not set this parameter value.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
acknowledgementComment:
type: string
description: Comment that a MongoDB Cloud user submitted when acknowledging the
@@ -19129,17 +20327,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration that sets this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
created:
type: string
format: date-time
description: Date and time when MongoDB Cloud created this alert. This parameter
- expresses its value in the ISO 8601 timestamp format in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
type: string
@@ -19150,27 +20347,24 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project that
owns this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
lastNotified:
type: string
format: date-time
description: Date and time that any notifications were last sent for this alert.
- This parameter expresses its value in the ISO 8601 timestamp format in UTC. The
- resource returns this parameter if MongoDB Cloud has sent
- notifications for this alert.
+ This parameter expresses its value in the ISO 8601 timestamp format
+ in UTC. The resource returns this parameter if MongoDB Cloud has
+ sent notifications for this alert.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
links:
type: array
@@ -19188,18 +20382,18 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization that owns the project to which this alert applies.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
resolved:
type: string
format: date-time
description: 'Date and time that this alert changed to `"status" : "CLOSED"`.
- This parameter expresses its value in the ISO 8601 timestamp format in UTC. The
- resource returns this parameter once `"status" : "CLOSED"`.'
+ This parameter expresses its value in the ISO 8601 timestamp format
+ in UTC. The resource returns this parameter once `"status" :
+ "CLOSED"`.'
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
status:
type: string
@@ -19210,9 +20404,10 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert. This parameter
- expresses its value in the ISO 8601 timestamp format in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
clusterName:
type: string
@@ -19220,8 +20415,6 @@ components:
alert applies. This resource returns this parameter for alerts of
events impacting backups, replica sets, or sharded clusters.
example: cluster1
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
readOnly: true
hostnameAndPort:
@@ -19260,8 +20453,6 @@ components:
items:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 32
- minLength: 8
pattern: ^([a-f0-9]{8,32})$
readOnly: true
readOnly: true
@@ -19272,8 +20463,6 @@ components:
sharded nodes. MongoDB Cloud returns this parameter only for alerts
of events impacting sharded clusters.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 64
- minLength: 1
pattern: ^([a-f0-9]{24})$
readOnly: true
instanceName:
@@ -19329,13 +20518,12 @@ components:
datadogRegion:
type: string
default: US
- description: >-
- Datadog region that indicates which API Uniform Resource Locator
+ description: 'Datadog region that indicates which API Uniform Resource Locator
(URL) to use. The resource requires this parameter when
- `"notifications.[n].typeName" : "DATADOG"`.
-
-
- To learn more about Datadog's regions, see Datadog Sites.
+ `"notifications.[n].typeName" : "DATADOG"`.'
+ externalDocs:
+ description: Datadog regions
+ url: https://docs.datadoghq.com/getting_started/site/
delayMin:
type: integer
format: int32
@@ -19547,8 +20735,6 @@ components:
Cloud team. The resource requires this parameter when
`"notifications.[n].typeName" : "TEAM"`.'
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
teamName:
type: string
@@ -19591,6 +20777,7 @@ components:
example: test routing
webhookSecret:
type: string
+ format: password
description: >-
Authentication secret for a webhook-based alert.
@@ -19599,11 +20786,13 @@ components:
* You set `notification.[n].webhookSecret` to a non-empty string
- * You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)
+ * You set a default webhookSecret either on the Integrations page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)
**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
- example: "******"
+ externalDocs:
+ description: Integrations page
+ url: https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations
webhookUrl:
type: string
description: >-
@@ -19677,8 +20866,6 @@ components:
project contains MongoDB processes that you want to return. The
MongoDB process can be either the `mongod` or `mongos`.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
hostname:
@@ -19768,8 +20955,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this
organization API key.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
publicKey:
@@ -19807,8 +20992,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this
organization API key assigned to this project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -19873,8 +21056,6 @@ components:
project contains MongoDB processes that you want to return. The
MongoDB process can be either the `mongod` or `mongos`.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
hostId:
@@ -19944,8 +21125,6 @@ components:
description: Unique 22-character alphanumeric string that identifies the private
endpoint.
example: vpce-3bf78b0ddee411ba1
- maxLength: 22
- minLength: 22
pattern: ^vpce-[0-9a-f]{17}$
ApiPublicUsageDetailsQueryRequest:
type: object
@@ -19962,6 +21141,12 @@ components:
type: string
description: Specify the sort order (ascending / descending) used to specify how
to sort query results. Defaults to descending.
+ ApiVersion:
+ type: object
+ properties:
+ version:
+ type: string
+ description: Object representing a version of the Atlas Admin API.
AtlasClusterOutageSimulationOutageFilter:
type: object
properties:
@@ -19988,8 +21173,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the organization.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
isDeleted:
@@ -20010,8 +21193,6 @@ components:
name:
type: string
description: Human-readable label that identifies the organization.
- maxLength: 64
- minLength: 1
pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$
skipDefaultAlertsSettings:
type: boolean
@@ -20176,16 +21357,12 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
labels:
@@ -20234,8 +21411,6 @@ components:
name:
type: string
description: Human-readable label that identifies the cluster.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
paused:
type: boolean
@@ -20366,8 +21541,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this role mapping.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
roleAssignments:
@@ -20408,8 +21581,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
dbSizeBytes:
@@ -20554,18 +21725,20 @@ components:
type: string
description: Human-readable label that identifies the frequency type associated
with the backup policy.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
id:
type: string
description: Unique 24-hexadecimal digit string that identifies this backup
policy item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
retentionUnit:
type: string
description: Unit of time in which MongoDB Cloud measures snapshot retention.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
retentionValue:
type: integer
format: int32
@@ -20611,18 +21784,20 @@ components:
type: string
description: Human-readable label that identifies the frequency type associated
with the backup policy.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
id:
type: string
description: Unique 24-hexadecimal digit string that identifies this backup
policy item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
retentionUnit:
type: string
description: Unit of time in which MongoDB Cloud measures Snapshot retention.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
retentionValue:
type: integer
format: int32
@@ -20661,16 +21836,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the online
archive.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
clusterName:
type: string
description: Human-readable label that identifies the cluster that contains the
collection for which you want to create an online archive.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
readOnly: true
collName:
@@ -20710,8 +21881,6 @@ components:
contains the specified cluster. The specified cluster contains the
collection for which to create the online archive.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
partitionFields:
@@ -20776,16 +21945,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the online
archive.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
clusterName:
type: string
description: Human-readable label that identifies the cluster that contains the
collection for which you want to create an online archive.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
readOnly: true
collName:
@@ -20825,8 +21990,6 @@ components:
contains the specified cluster. The specified cluster contains the
collection for which to create the online archive.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
partitionFields:
@@ -20896,8 +22059,6 @@ components:
which this restore job belongs. This parameter exists only for a
sharded cluster restore.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
checkpointId:
@@ -20914,8 +22075,6 @@ components:
- If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
writeOnly: true
clusterId:
@@ -20924,16 +22083,12 @@ components:
the snapshot you want to return. This parameter returns for restore
clusters.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
clusterName:
type: string
description: Human-readable label that identifies the cluster containing the
snapshots you want to retrieve.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
readOnly: true
created:
@@ -20955,8 +22110,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project that
owns the snapshots.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
hashes:
@@ -20973,8 +22126,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the restore job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -21053,8 +22204,6 @@ components:
restore. If you set **snapshotId**, you can't set **oplogInc**,
**oplogTs**, **pointInTimeUTCMillis**, or **checkpointId**.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
statusName:
type: string
@@ -21136,8 +22285,6 @@ components:
To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
targetClusterName:
type: string
@@ -21157,8 +22304,6 @@ components:
To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
targetGroupId:
type: string
@@ -21167,8 +22312,6 @@ components:
resource returns this parameter when `"delivery.methodName" :
"AUTOMATED_RESTORE"`.'
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
url:
type: string
@@ -21196,8 +22339,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the cluster with
the snapshots you want to return.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
clusterName:
@@ -21227,16 +22368,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project that
owns the snapshots.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
incremental:
@@ -21277,8 +22414,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the cluster with
the snapshots you want to return.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
completedTime:
@@ -21403,8 +22538,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the restore job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -21457,6 +22590,7 @@ components:
BaseCloudProviderInstanceSize:
type: string
description: Instance size boundary to which your cluster can automatically scale.
+ readOnly: true
BaseNetworkPeeringConnectionSettings:
type: object
properties:
@@ -21466,16 +22600,12 @@ components:
Cloud network container that contains the specified network peering
connection.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the network
peering connection.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
providerName:
@@ -21493,8 +22623,6 @@ components:
description: Unique twelve-digit string that identifies the Amazon Web Services
(AWS) account that owns the VPC that you peered with the MongoDB
Cloud VPC.
- maxLength: 12
- minLength: 12
pattern: ^[0-9]{12}$
connectionId:
type: string
@@ -21521,7 +22649,6 @@ components:
type: string
description: Unique string that identifies the VPC on Amazon Web Services (AWS)
that you want to peer with the MongoDB Cloud VPC.
- minLength: 5
pattern: ^vpc-[0-9a-f]{17}$
azureDirectoryId:
type: string
@@ -21553,7 +22680,7 @@ components:
type: string
description: Human-readable label that identifies the VNet that you want to peer
with the MongoDB Cloud VNet.
- pattern: ^([-\w._()])+$
+ pattern: ^([-\w._()])$
errorMessage:
type: string
description: Details of the error returned when requesting a GCP network peering
@@ -21563,15 +22690,11 @@ components:
type: string
description: Human-readable label that identifies the GCP project that contains
the network that you want to peer with the MongoDB Cloud VPC.
- maxLength: 30
- minLength: 6
pattern: ^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}
networkName:
type: string
description: Human-readable label that identifies the network to peer with the
MongoDB Cloud VPC.
- maxLength: 63
- minLength: 1
pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?"
required:
- containerId
@@ -21647,8 +22770,6 @@ components:
submitted to the specified organization. Charges typically post the
next day.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
lineItems:
@@ -21680,8 +22801,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
charged for services consumed from MongoDB Cloud.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
payments:
@@ -21801,8 +22920,6 @@ components:
submitted to the specified organization. Charges typically post the
next day.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
linkedInvoices:
@@ -21828,8 +22945,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
charged for services consumed from MongoDB Cloud.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
salesTaxCents:
@@ -21928,8 +23043,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this payment
toward the associated invoice.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
salesTaxCents:
@@ -22011,8 +23124,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the payment that
the organization had made.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
reason:
@@ -22117,8 +23228,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud user.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
lastAuth:
@@ -22210,6 +23319,8 @@ components:
nodes in the cluster can be accessed, `unavailable` when the cluster
can't be accessed, or `dead` when the cluster has been deactivated.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
backupEnabled:
type: boolean
description: Flag that indicates whether the cluster can perform backups. If set
@@ -22223,8 +23334,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the cluster.
Each ``clusterId`` is used only once across all MongoDB Cloud
deployments.
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
dataSizeBytes:
@@ -22236,8 +23345,6 @@ components:
name:
type: string
description: Human-readable label that identifies the cluster.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
readOnly: true
nodeCount:
@@ -22283,6 +23390,8 @@ components:
IAM, x.509, LDAP, or OIDC Workload this value should be `$external`.
If the user authenticates with SCRAM-SHA or OIDC Workforce, this
value should be `admin`.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
deleteAfterDate:
type: string
format: date-time
@@ -22298,10 +23407,6 @@ components:
groupId:
type: string
description: Unique 24-hexadecimal digit string that identifies the project.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: ^([a-f0-9]{24})$
writeOnly: true
labels:
type: array
@@ -22463,8 +23568,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
description: Details that describe the features linked to the Amazon Web
@@ -22520,8 +23623,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
CloudProviderAccessAzureServicePrincipal:
@@ -22534,8 +23635,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
atlasAzureAppId:
@@ -22579,8 +23678,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
atlasAzureAppId:
@@ -22644,8 +23741,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies your project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
CloudProviderAccessRole:
@@ -22703,16 +23798,12 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
_id:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
atlasAzureAppId:
@@ -22737,8 +23828,6 @@ components:
gcpServiceAccountForAtlas:
type: string
description: Email address for the Google Service Account created by Atlas.
- maxLength: 82
- minLength: 57
pattern: ^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$
required:
- providerName
@@ -22795,8 +23884,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
atlasAzureAppId:
@@ -22879,16 +23966,12 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
_id:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
atlasAzureAppId:
@@ -22937,8 +24020,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the network
peering container.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
providerName:
@@ -22992,9 +24073,7 @@ components:
clusters in this network peering container exist. The response
returns **null** if no clusters exist in this network peering
container.
- maxLength: 38
- minLength: 38
- pattern: ^([-\w._()])+$
+ pattern: ^([-\w._()])$
readOnly: true
gcpProjectId:
type: string
@@ -23002,8 +24081,6 @@ components:
Cloud clusters in this network peering container exist. The response
returns **null** if no clusters exist in this network peering
container.
- maxLength: 26
- minLength: 26
pattern: ^p-[0-9a-z]{24}$
readOnly: true
networkName:
@@ -23012,8 +24089,6 @@ components:
Cloud clusters in this network peering container exist. MongoDB
Cloud returns **null** if no clusters exist in this network peering
container.
- maxLength: 36
- minLength: 36
pattern: ^nt-[0-9a-f]{24}-[0-9a-z]{8}$
readOnly: true
regions:
@@ -23038,7 +24113,6 @@ components:
type: string
description: Unique string that identifies the MongoDB Cloud VPC on AWS.
example: vpc-b555d3b0d9cb783b0
- minLength: 5
pattern: ^vpc-[0-9a-f]{17}$
readOnly: true
CloudProviderEndpointServiceRequest:
@@ -23125,10 +24199,17 @@ components:
$ref: "#/components/schemas/DedicatedHardwareSpec20240805"
backingProviderName:
type: string
- description: Cloud service provider on which MongoDB Cloud provisioned the
+ description: >-
+ Cloud service provider on which MongoDB Cloud provisioned the
multi-tenant cluster. The resource returns this parameter when
**providerName** is `TENANT` and **electableSpecs.instanceSize** is
- `M0`, `M2` or `M5`.
+ `M0`, `M2` or `M5`.
+
+
+ Please note that using an instanceSize of M2 or M5 will create a Flex cluster instead. Support for the instanceSize of M2 or M5 will be discontinued in January 2026. We recommend using the createFlexCluster API for such configurations moving forward.
+ externalDocs:
+ description: createFlexCluster API
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster
title: Cloud Service Provider Settings
CloudSearchMetrics:
type: object
@@ -23137,8 +24218,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
hardwareMetrics:
@@ -23480,16 +24559,12 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
labels:
@@ -23538,8 +24613,6 @@ components:
name:
type: string
description: Human-readable label that identifies the cluster.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
paused:
type: boolean
@@ -23906,8 +24979,6 @@ components:
type: string
description: Human-readable label that identifies the cluster that undergoes
outage simulation.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
readOnly: true
groupId:
@@ -23915,8 +24986,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the project
that contains the cluster to undergo outage simulation.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
id:
@@ -23924,8 +24993,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the outage
simulation.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
outageFilters:
@@ -24050,8 +25117,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this Atlas
Search index.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
name:
@@ -24081,6 +25146,8 @@ components:
type:
type: string
description: Type of the index. Default type is search.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
analyzer:
type: string
default: lucene.standard
@@ -24109,6 +25176,8 @@ components:
externalDocs:
description: Atlas Search Analyzers
url: https://dochub.mongodb.org/core/analyzers--fts
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
analyzers:
type: array
description: List of user-defined methods to convert database field text into
@@ -24124,6 +25193,8 @@ components:
type: string
default: lucene.standard
description: Method applied to identify words when searching this index.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
storedSource:
type: object
description: Flag that indicates whether to store all fields (true) on Atlas
@@ -24221,6 +25292,8 @@ components:
| `"non-ignorable"` | Yes |
| `"shifted"` | No. MongoDB Cloud distinguishes these characters when `"strength" > 3`. |
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
backwards:
type: boolean
default: false
@@ -24247,6 +25320,8 @@ components:
| `"upper"` | Uppercase sorts before lowercase. |
| `"lower"` | Lowercase sorts before uppercase. |
| `"off"` | Similar to "lower" with slight differences. |
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
caseLevel:
type: boolean
default: false
@@ -24265,6 +25340,8 @@ components:
description: 'International Components for Unicode (ICU) code that represents a
localized language. To specify simple binary comparison, set
`"locale" : "simple"`.'
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
maxVariable:
type: string
description: >
@@ -24278,6 +25355,8 @@ components:
| `"punct"` | Both whitespace and punctuation |
| `"space"` | Whitespace |
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
normalization:
type: boolean
default: false
@@ -24359,10 +25438,6 @@ components:
description: Unique 24-hexadecimal digit string that represents the id of the
identity providers that can be used for data access in this
organization.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: ^([a-f0-9]{24})$
uniqueItems: true
domainAllowList:
type: array
@@ -24382,16 +25457,12 @@ components:
This id can be found within the Federation Management Console >
Identity Providers tab by clicking the info icon in the IdP ID row
of a configured identity provider.
- maxLength: 20
- minLength: 20
pattern: ^([a-f0-9]{20})$
orgId:
type: string
description: Unique 24-hexadecimal digit string that identifies the connected
organization configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
postAuthRoleGrants:
@@ -24452,6 +25523,8 @@ components:
type: string
description: The dimension to group the returned usage results by. At least one
filter value needs to be provided for a dimension to be used.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
includePartialMatches:
type: boolean
description: Flag to control whether usage that matches the filter criteria, but
@@ -24486,6 +25559,8 @@ components:
- Atlas Data Federation
items:
type: string
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
startDate:
type: string
format: date
@@ -24606,14 +25681,10 @@ components:
Organization Owner role in an organization associated with the
federation.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
name:
type: string
description: Human-readable label that identifies the organization.
- maxLength: 64
- minLength: 1
pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$
orgOwnerId:
type: string
@@ -24625,8 +25696,6 @@ components:
federation. This parameter is required only when you authenticate
with Programmatic API Keys.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
skipDefaultAlertsSettings:
type: boolean
@@ -24645,8 +25714,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the federation
that you linked the newly created organization to.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
orgOwnerId:
@@ -24655,8 +25722,6 @@ components:
Cloud user that you assigned the Organization Owner role in the new
organization.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
organization:
@@ -25158,8 +26223,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the Data Lake
Pipeline.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
createdDate:
@@ -25173,8 +26236,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the group.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
lastUpdatedDate:
@@ -25348,8 +26409,6 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
hostnames:
@@ -25376,6 +26435,12 @@ components:
readOnly: true
storage:
$ref: "#/components/schemas/DataLakeStorage"
+ DataMetricUnits:
+ type: string
+ description: Element used to express the quantity. This can be an element of
+ time, storage capacity, and the like.
+ example: BYTES
+ title: Data Metric Units
DataProtectionSettings20231001:
type: object
properties:
@@ -25433,8 +26498,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project for
the Backup Compliance Policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
restoreWindowDays:
type: integer
@@ -25608,6 +26671,8 @@ components:
description: Human-readable label that identifies a group of privileges assigned
to a database user. This value can either be a built-in role or a
custom role.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
required:
- databaseName
- roleName
@@ -25749,9 +26814,7 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the destination
project.
- example: 9b43a5b329223c3a1591a678
- maxLength: 24
- minLength: 24
+ example: 32b6e34b3d91647abb20e7b8
pattern: ^([a-f0-9]{24})$
hostnameSchemaType:
type: string
@@ -25794,18 +26857,20 @@ components:
type: string
description: Human-readable label that identifies the frequency type associated
with the backup policy.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
id:
type: string
description: Unique 24-hexadecimal digit string that identifies this backup
policy item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
retentionUnit:
type: string
description: Unit of time in which MongoDB Cloud measures Snapshot retention.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
retentionValue:
type: integer
format: int32
@@ -25885,8 +26950,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the Export
Bucket.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
exportStatus:
@@ -25902,8 +26965,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the restore
job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -25927,13 +26988,13 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
state:
type: string
description: State of the Export Job.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
stateReason:
$ref: "#/components/schemas/StateReason"
required:
@@ -25953,8 +27014,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the Export
Bucket.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
writeOnly: true
links:
@@ -25973,8 +27032,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the Cloud
Backup Snapshot to export.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
writeOnly: true
required:
@@ -25989,8 +27046,6 @@ components:
Cloud Backup snapshot export job for each shard in a sharded
cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
replicaSetName:
@@ -26064,12 +27119,12 @@ components:
description: Human-readable label that identifies how often this snapshot
triggers.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -26103,8 +27158,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies one policy item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
replicaSetName:
@@ -26117,11 +27170,15 @@ components:
type: string
description: Human-readable label that identifies when this snapshot triggers.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
status:
type: string
description: Human-readable label that indicates the stage of the backup process
for this snapshot.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
storageSizeBytes:
type: integer
format: int64
@@ -26132,6 +27189,8 @@ components:
description: Human-readable label that categorizes the cluster as a replica set
or sharded cluster.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
title: Replica Set Snapshot
DiskBackupRestoreMember:
type: object
@@ -26190,12 +27249,12 @@ components:
description: Human-readable label that identifies how often this snapshot
triggers.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -26237,8 +27296,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies one policy item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
snapshotIds:
@@ -26254,8 +27311,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the snapshot for
part of the sharded cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
readOnly: true
@@ -26263,11 +27318,15 @@ components:
type: string
description: Human-readable label that identifies when this snapshot triggers.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
status:
type: string
description: Human-readable label that indicates the stage of the backup process
for this snapshot.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
storageSizeBytes:
type: integer
format: int64
@@ -26278,6 +27337,8 @@ components:
description: Human-readable label that categorizes the cluster as a replica set
or sharded cluster.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
title: Sharded Cluster Snapshot
DiskBackupShardedClusterSnapshotMember:
type: object
@@ -26292,8 +27353,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
replicaSetName:
@@ -26332,12 +27391,12 @@ components:
description: Human-readable label that identifies how often this snapshot
triggers.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -26371,19 +27430,21 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies one policy item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
snapshotType:
type: string
description: Human-readable label that identifies when this snapshot triggers.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
status:
type: string
description: Human-readable label that indicates the stage of the backup process
for this snapshot.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
storageSizeBytes:
type: integer
format: int64
@@ -26394,6 +27455,8 @@ components:
description: Human-readable label that categorizes the cluster as a replica set
or sharded cluster.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
cloudProvider:
type: string
description: 'Human-readable label that identifies the cloud provider that
@@ -26439,8 +27502,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the snapshot for
part of the sharded cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
readOnly: true
@@ -26472,13 +27533,10 @@ components:
readOnly: true
iamRoleId:
type: string
- description: Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud
- uses to access the AWS S3 bucket.
+ description: Unique 24-hexadecimal character string that identifies the Unified
+ AWS Access role ID that MongoDB Cloud uses to access the AWS S3
+ bucket.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
roleId:
type: string
@@ -26486,8 +27544,6 @@ components:
Provider Access Role that MongoDB Cloud uses to access the Azure
Blob Storage Container.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
serviceUrl:
type: string
@@ -26516,8 +27572,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the Export
Bucket.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
bucketName:
type: string
@@ -26543,13 +27597,10 @@ components:
readOnly: true
iamRoleId:
type: string
- description: Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud
- uses to access the AWS S3 bucket.
+ description: Unique 24-hexadecimal character string that identifies the Unified
+ AWS Access role ID that MongoDB Cloud uses to access the AWS S3
+ bucket.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
roleId:
type: string
@@ -26557,8 +27608,6 @@ components:
Provider Access Role that MongoDB Cloud uses to access the Azure
Blob Storage Container.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
serviceUrl:
type: string
@@ -26593,6 +27642,8 @@ components:
deliveryType:
type: string
description: Human-readable label that categorizes the restore job to create.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
deliveryUrl:
type: array
description: 'One or more Uniform Resource Locators (URLs) that point to the
@@ -26630,8 +27681,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the restore
job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -26686,8 +27735,6 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
targetClusterName:
type: string
@@ -26695,8 +27742,6 @@ components:
the restore job restores the snapshot. The resource returns this
parameter when `"deliveryType":` `"automated"`. Required for
`automated` and `pointInTime` restore types.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
targetGroupId:
type: string
@@ -26704,8 +27749,6 @@ components:
project for the specified **targetClusterName**. Required for
`automated` and `pointInTime` restore types.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
timestamp:
type: string
@@ -26728,16 +27771,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the cluster with
the Snapshot you want to return.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
clusterName:
type: string
description: Human-readable label that identifies the cluster with the Snapshot
you want to return.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
readOnly: true
copySettings:
@@ -26824,6 +27863,70 @@ components:
oplog size can limit storage auto-scaling.
Document:
type: object
+ DropIndexSuggestionsIndex:
+ type: object
+ properties:
+ accessCount:
+ type: integer
+ format: int64
+ description: Usage count (since last restart) of index.
+ index:
+ type: array
+ description: List that contains documents that specify a key in the index and
+ its sort order.
+ items:
+ type: object
+ description: One index key paired with its sort order. A value of `1` indicates
+ an ascending sort order. A value of `-1` indicates a descending
+ sort order. Keys in indexes with multiple keys appear in the same
+ order that they appear in the index.
+ name:
+ type: string
+ description: Name of index.
+ namespace:
+ type: string
+ description: Human-readable label that identifies the namespace on the specified
+ host. The resource expresses this parameter value as
+ `.`.
+ shards:
+ type: array
+ description: List that contains strings that specifies the shards where the
+ index is found.
+ items:
+ type: string
+ description: Shard name.
+ since:
+ type: string
+ format: date-time
+ description: Date of most recent usage of index.
+ sizeBytes:
+ type: integer
+ format: int64
+ description: Size of index.
+ DropIndexSuggestionsResponse:
+ type: object
+ properties:
+ hiddenIndexes:
+ type: array
+ description: List that contains the documents with information about the hidden
+ indexes that the Performance Advisor suggests to remove.
+ items:
+ $ref: "#/components/schemas/DropIndexSuggestionsIndex"
+ readOnly: true
+ redundantIndexes:
+ type: array
+ description: List that contains the documents with information about the
+ redundant indexes that the Performance Advisor suggests to remove.
+ items:
+ $ref: "#/components/schemas/DropIndexSuggestionsIndex"
+ readOnly: true
+ unusedIndexes:
+ type: array
+ description: List that contains the documents with information about the unused
+ indexes that the Performance Advisor suggests to remove.
+ items:
+ $ref: "#/components/schemas/DropIndexSuggestionsIndex"
+ readOnly: true
EARPrivateEndpoint:
type: object
description: Encryption At Rest Private Endpoint.
@@ -26843,8 +27946,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the Private
Endpoint Service.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
regionName:
@@ -26886,8 +27987,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the Private
Endpoint Service.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
regionName:
@@ -26915,8 +28014,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the interface
endpoint.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
readOnly: true
@@ -26935,8 +28032,6 @@ components:
type: string
description: Unique string that identifies the Azure Private Link Service that
MongoDB Cloud manages.
- maxLength: 24
- minLength: 24
pattern: ^pls_[0-9a-f]{24}$
readOnly: true
privateLinkServiceResourceId:
@@ -27000,22 +28095,20 @@ components:
properties:
apiKeyId:
type: string
- description: Unique 24-hexadecimal digit string that identifies the [API
- Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that
+ description: Unique 24-hexadecimal digit string that identifies the API Key that
triggered the event. If this resource returns this parameter, it
doesn't return the **userId** parameter.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp
- format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup"
@@ -27026,16 +28119,12 @@ components:
which the event occurred. The **eventId** identifies the specific
event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
isGlobalAdmin:
@@ -27060,18 +28149,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
publicKey:
type: string
format: email
- description: Public part of the [API
- Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that
- triggered the event. If this resource returns this parameter, it
- doesn't return the **username** parameter.
- example: test.user@mongodb.com
+ description: Public part of the API key that triggered the event. If this
+ resource returns this parameter, it doesn't return the **username**
+ parameter.
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -27087,8 +28174,6 @@ components:
who triggered the event. If this resource returns this parameter, it
doesn't return the **apiKeyId** parameter.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
username:
@@ -27104,8 +28189,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
associated with the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
alertConfigId:
@@ -27113,8 +28196,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration associated with the **alertId**.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
invoiceId:
@@ -27122,8 +28203,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies of the invoice
associated with the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
paymentId:
@@ -27131,8 +28210,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the invoice
payment associated with this event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
shardName:
@@ -27161,6 +28238,13 @@ components:
: "DATA_EXPLORER"`.'
example: insertDocument
readOnly: true
+ sessionId:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the Data
+ Explorer session associated with the event.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: ^([a-f0-9]{24})$
+ readOnly: true
deskLocation:
type: string
description: Desk location of MongoDB employee associated with the event.
@@ -27204,8 +28288,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the endpoint
associated with this event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
providerEndpointId:
@@ -27219,8 +28301,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
team associated with this event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
targetUsername:
@@ -27235,8 +28315,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the resource
associated with the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
resourceType:
@@ -27269,22 +28347,20 @@ components:
properties:
apiKeyId:
type: string
- description: Unique 24-hexadecimal digit string that identifies the [API
- Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that
+ description: Unique 24-hexadecimal digit string that identifies the API Key that
triggered the event. If this resource returns this parameter, it
doesn't return the **userId** parameter.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp
- format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
type: string
@@ -27297,16 +28373,12 @@ components:
which the event occurred. The **eventId** identifies the specific
event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
isGlobalAdmin:
@@ -27331,17 +28403,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
publicKey:
type: string
format: email
- description: Public part of the [API
- Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that
- triggered the event. If this resource returns this parameter, it
- doesn't return the **username** parameter.
+ description: Public part of the API Key that triggered the event. If this
+ resource returns this parameter, it doesn't return the **username**
+ parameter.
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -27357,8 +28428,6 @@ components:
who triggered the event. If this resource returns this parameter, it
doesn't return the **apiKeyId** parameter.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
username:
@@ -27367,15 +28436,12 @@ components:
description: Email address for the user who triggered this event. If this
resource returns this parameter, it doesn't return the
**publicApiKey** parameter.
- example: test.user@mongodb.com
readOnly: true
alertId:
type: string
description: Unique 24-hexadecimal digit string that identifies the alert
associated with the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
alertConfigId:
@@ -27383,8 +28449,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration associated with the **alertId**.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
invoiceId:
@@ -27392,8 +28456,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies of the invoice
associated with the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
paymentId:
@@ -27401,8 +28463,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the invoice
payment associated with this event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
dbUserUsername:
@@ -27422,8 +28482,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
team associated with this event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
targetUsername:
@@ -27438,8 +28496,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the resource
associated with the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
resourceType:
@@ -27451,8 +28507,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the resource
policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
ExportStatus:
@@ -27514,8 +28568,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the federation
to which this MongoDB Cloud user belongs.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
firstName:
type: string
@@ -27528,8 +28580,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this user.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
required:
@@ -27564,8 +28614,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the identity
provider.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
idpType:
@@ -27580,8 +28628,6 @@ components:
type: string
description: Legacy 20-hexadecimal digit string that identifies the identity
provider.
- maxLength: 20
- minLength: 20
pattern: ^([a-f0-9]{20})$
protocol:
type: string
@@ -27612,10 +28658,14 @@ components:
description: SAML Authentication Request Protocol HTTP method binding (POST or
REDIRECT) that Federated Authentication uses to send the
authentication request.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
responseSignatureAlgorithm:
type: string
description: Signature algorithm that Federated Authentication uses to encrypt
the identity provider signature.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
slug:
type: string
description: Custom SSO Url for the identity provider.
@@ -27692,10 +28742,14 @@ components:
description: SAML Authentication Request Protocol HTTP method binding (POST or
REDIRECT) that Federated Authentication uses to send the
authentication request.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
responseSignatureAlgorithm:
type: string
description: Signature algorithm that Federated Authentication uses to encrypt
the identity provider signature.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
slug:
type: string
description: Custom SSO Url for the identity provider.
@@ -27769,8 +28823,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the identity
provider.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
idpType:
@@ -27785,8 +28837,6 @@ components:
type: string
description: Legacy 20-hexadecimal digit string that identifies the identity
provider.
- maxLength: 20
- minLength: 20
pattern: ^([a-f0-9]{20})$
protocol:
type: string
@@ -27916,15 +28966,11 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the restore job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
instanceName:
type: string
description: Human-readable label that identifies the source instance.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
readOnly: true
links:
@@ -27943,8 +28989,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project from
which the restore job originated.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
restoreFinishedDate:
@@ -27974,8 +29018,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the snapshot to
restore.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
snapshotUrl:
@@ -27994,8 +29036,6 @@ components:
description: Human-readable label that identifies the instance or cluster on the
target project to which you want to restore the snapshot. You can
restore the snapshot to another flex or dedicated cluster tier.
- maxLength: 64
- minLength: 1
pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$
readOnly: true
targetProjectId:
@@ -28004,8 +29044,6 @@ components:
contains the instance or cluster to which you want to restore the
snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
title: Flex Backup Restore Job
@@ -28029,15 +29067,11 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the restore job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
instanceName:
type: string
description: Human-readable label that identifies the source instance.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
readOnly: true
links:
@@ -28056,8 +29090,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project from
which the restore job originated.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
restoreFinishedDate:
@@ -28087,8 +29119,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the snapshot to
restore.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
writeOnly: true
snapshotUrl:
@@ -28108,8 +29138,6 @@ components:
target project to which you want to restore the snapshot. You can
restore the snapshot to another flex cluster or dedicated cluster
tier.
- maxLength: 64
- minLength: 1
pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$
writeOnly: true
targetProjectId:
@@ -28118,8 +29146,6 @@ components:
contains the instance or cluster to which you want to restore the
snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
writeOnly: true
required:
@@ -28163,8 +29189,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -28222,8 +29246,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the snapshot to
download.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
writeOnly: true
required:
@@ -28237,6 +29259,7 @@ components:
$ref: "#/components/schemas/FlexBackupSettings20241113"
clusterType:
type: string
+ default: REPLICASET
description: Flex cluster topology.
readOnly: true
connectionStrings:
@@ -28251,16 +29274,12 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the instance.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -28282,8 +29301,6 @@ components:
name:
type: string
description: Human-readable label that identifies the instance.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
readOnly: true
providerSettings:
@@ -28334,8 +29351,6 @@ components:
name:
type: string
description: Human-readable label that identifies the instance.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
writeOnly: true
providerSettings:
@@ -28390,6 +29405,33 @@ components:
the cluster. If set to `true`, MongoDB Cloud won't delete the
cluster. If set to `false`, MongoDB Cloud will delete the cluster.
title: Flex Cluster Description Update
+ FlexClusterMetricThreshold:
+ type: object
+ description: Threshold for the metric that, when exceeded, triggers an alert.
+ The metric threshold pertains to event types which reflects changes of
+ measurements and metrics about the serverless database.
+ properties:
+ metricName:
+ type: string
+ description: Human-readable label that identifies the metric against which
+ MongoDB Cloud checks the configured **metricThreshold.threshold**.
+ mode:
+ type: string
+ description: MongoDB Cloud computes the current metric value as an average.
+ operator:
+ type: string
+ description: Comparison operator to apply when checking the current metric value.
+ threshold:
+ type: number
+ format: double
+ description: Value of metric that, when exceeded, triggers an alert.
+ units:
+ $ref: "#/components/schemas/DataMetricUnits"
+ description: Element used to express the quantity. This can be an element of
+ time, storage capacity, and the like.
+ required:
+ - metricName
+ title: Flex Cluster Metric Threshold
FlexConnectionStrings20241113:
type: object
description: Collection of Uniform Resource Locators that point to the MongoDB
@@ -28633,8 +29675,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -28652,16 +29692,12 @@ components:
type: string
description: Human-readable label that identifies the project included in the
MongoDB Cloud organization.
- maxLength: 64
- minLength: 1
pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$
orgId:
type: string
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud organization to which the project belongs.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
regionUsageRestrictions:
type: string
@@ -28712,9 +29748,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format
+ in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -28729,8 +29767,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project that
owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
id:
@@ -28738,8 +29774,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -28769,12 +29803,14 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format
+ in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
metricThreshold:
- $ref: "#/components/schemas/ServerlessMetricThreshold"
+ $ref: "#/components/schemas/FlexClusterMetricThreshold"
threshold:
$ref: "#/components/schemas/GreaterThanRawThreshold"
GroupIPAddresses:
@@ -28786,8 +29822,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
services:
@@ -28812,16 +29846,12 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
groupName:
type: string
description: Human-readable label that identifies the project to which you
invited the MongoDB Cloud user.
- maxLength: 64
- minLength: 1
pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$
readOnly: true
id:
@@ -28829,8 +29859,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
invitation.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
inviterUsername:
@@ -28958,8 +29986,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to move the specified project to.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
destinationOrgPrivateApiKey:
type: string
@@ -28989,8 +30015,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project to
which this role belongs.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
groupRole:
type: string
@@ -29019,6 +30043,22 @@ components:
* GROUP_STREAM_PROCESSING_OWNER
+ GroupRoleAssignment:
+ type: object
+ properties:
+ groupId:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the project to
+ which these roles belong.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: ^([a-f0-9]{24})$
+ groupRoles:
+ type: array
+ description: One or more project-level roles assigned to the MongoDB Cloud user.
+ items:
+ type: string
+ description: Project-level role.
+ uniqueItems: true
GroupService:
type: object
description: List of IP addresses in a project categorized by services.
@@ -29137,20 +30177,31 @@ components:
properties:
isCollectDatabaseSpecificsStatisticsEnabled:
type: boolean
- description: Flag that indicates whether to collect database-specific
- metrics for the specified project.
+ description: Flag that indicates whether to collect database-specific metrics
+ for the specified project.
isDataExplorerEnabled:
type: boolean
description: Flag that indicates whether to enable the Data Explorer for the
specified project.
+ isDataExplorerGenAIFeaturesEnabled:
+ type: boolean
+ description: Flag that indicates whether to enable the use of generative AI
+ features which make requests to 3rd party services in Data Explorer
+ for the specified project.
+ isDataExplorerGenAISampleDocumentPassingEnabled:
+ type: boolean
+ default: false
+ description: Flag that indicates whether to enable the passing of sample field
+ values with the use of generative AI features in the Data Explorer
+ for the specified project.
isExtendedStorageSizesEnabled:
type: boolean
- description: Flag that indicates whether to enable extended storage sizes for
+ description: Flag that indicates whether to enable extended storage sizes for
the specified project.
isPerformanceAdvisorEnabled:
type: boolean
description: Flag that indicates whether to enable the Performance Advisor and
- Profiler for the specified project.
+ Profiler for the specified project.
isRealtimePerformancePanelEnabled:
type: boolean
description: Flag that indicates whether to enable the Real Time Performance
@@ -29176,6 +30227,114 @@ components:
url: https://www.mongodb.com/docs/atlas/tags
items:
$ref: "#/components/schemas/ResourceTag"
+ GroupUserRequest:
+ type: object
+ properties:
+ roles:
+ type: array
+ description: One or more project-level roles to assign the MongoDB Cloud user.
+ items:
+ type: string
+ description: Project-level role.
+ minItems: 1
+ uniqueItems: true
+ writeOnly: true
+ username:
+ type: string
+ format: email
+ description: Email address that represents the username of the MongoDB Cloud user.
+ writeOnly: true
+ required:
+ - roles
+ - username
+ GroupUserResponse:
+ type: object
+ properties:
+ id:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the MongoDB
+ Cloud user.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: ^([a-f0-9]{24})$
+ readOnly: true
+ orgMembershipStatus:
+ type: string
+ description: String enum that indicates whether the MongoDB Cloud user has a
+ pending invitation to join the organization or they are already
+ active in the organization.
+ readOnly: true
+ roles:
+ type: array
+ description: One or more project-level roles assigned to the MongoDB Cloud user.
+ items:
+ type: string
+ description: Project-level role.
+ readOnly: true
+ uniqueItems: true
+ username:
+ type: string
+ format: email
+ description: Email address that represents the username of the MongoDB Cloud user.
+ readOnly: true
+ invitationCreatedAt:
+ type: string
+ format: date-time
+ description: Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud
+ represents this timestamp in ISO 8601 format in UTC.
+ readOnly: true
+ invitationExpiresAt:
+ type: string
+ format: date-time
+ description: Date and time when the invitation from MongoDB Cloud expires.
+ MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
+ readOnly: true
+ inviterUsername:
+ type: string
+ format: email
+ description: Username of the MongoDB Cloud user who sent the invitation to join
+ the organization.
+ readOnly: true
+ country:
+ type: string
+ description: Two-character alphabetical string that identifies the MongoDB Cloud
+ user's geographic location. This parameter uses the ISO 3166-1a2
+ code format.
+ example: US
+ pattern: ^([A-Z]{2})$
+ readOnly: true
+ createdAt:
+ type: string
+ format: date-time
+ description: Date and time when MongoDB Cloud created the current account. This
+ value is in the ISO 8601 timestamp format in UTC.
+ readOnly: true
+ firstName:
+ type: string
+ description: First or given name that belongs to the MongoDB Cloud user.
+ example: John
+ readOnly: true
+ lastAuth:
+ type: string
+ format: date-time
+ description: Date and time when the current account last authenticated. This
+ value is in the ISO 8601 timestamp format in UTC.
+ readOnly: true
+ lastName:
+ type: string
+ description: Last name, family name, or surname that belongs to the MongoDB
+ Cloud user.
+ example: Doe
+ readOnly: true
+ mobileNumber:
+ type: string
+ description: Mobile phone number that belongs to the MongoDB Cloud user.
+ pattern: (?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\s*(?:[.-]\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\s*(?:[.-]\\s*)?([0-9]{4})$
+ readOnly: true
+ required:
+ - id
+ - orgMembershipStatus
+ - roles
+ - username
HardwareSpec20240805:
type: object
description: Hardware specifications for all electable nodes deployed in the
@@ -29490,8 +30649,6 @@ components:
description: Unique 24-hexadecimal character string that identifies a Data Lake
Pipeline run.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
backupFrequencyType:
@@ -29516,8 +30673,6 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
lastUpdatedDate:
@@ -29535,8 +30690,6 @@ components:
description: Unique 24-hexadecimal character string that identifies a Data Lake
Pipeline.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
scheduledDeletionDate:
@@ -29550,8 +30703,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the snapshot
of a cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
state:
@@ -29604,16 +30755,12 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
policyItemId:
type: string
description: Unique 24-hexadecimal character string that identifies a policy item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
title: Ingestion Source
InvoiceLineItem:
@@ -29624,8 +30771,6 @@ components:
type: string
description: Human-readable label that identifies the cluster that incurred the
charge.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
readOnly: true
created:
@@ -29654,8 +30799,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
associated to this line item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
groupName:
@@ -29841,8 +30984,6 @@ components:
associated with this Lightweight Directory Access Protocol (LDAP)
over Transport Layer Security (TLS) configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -29864,8 +31005,6 @@ components:
verify an Lightweight Directory Access Protocol (LDAP)
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
status:
@@ -30097,16 +31236,12 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
labels:
@@ -30181,8 +31316,6 @@ components:
name:
type: string
description: Human-readable label that identifies the cluster.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
numShards:
type: integer
@@ -30423,16 +31556,12 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
labels:
@@ -30507,8 +31636,6 @@ components:
name:
type: string
description: Human-readable label that identifies the cluster.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
numShards:
type: integer
@@ -30641,8 +31768,6 @@ components:
- If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
numShards:
type: integer
@@ -30724,8 +31849,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project to
be migrated.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
required:
@@ -30738,8 +31861,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the validation.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
errorMessage:
@@ -30751,8 +31872,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project to
validate.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
sourceGroupId:
@@ -30760,8 +31879,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the source
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
status:
type: string
@@ -30775,9 +31892,7 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the migration
request.
- example: 507f1f77bcf86cd799439011
- maxLength: 24
- minLength: 24
+ example: 32b6e34b3d91647abb20e7b8
pattern: ^([a-f0-9]{24})$
readOnly: true
destination:
@@ -30822,8 +31937,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the migration job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
lagTimeSeconds:
@@ -31022,8 +32135,6 @@ components:
project contains MongoDB processes that you want to return. The
MongoDB process can be either the `mongod` or `mongos`.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -31095,8 +32206,6 @@ components:
project contains MongoDB processes that you want to return. The
MongoDB process can be either the `mongod` or `mongos`.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -31168,8 +32277,6 @@ components:
project contains MongoDB processes that you want to return. The
MongoDB process can be either the `mongod` or `mongos`.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
indexIds:
@@ -31178,10 +32285,6 @@ components:
items:
type: string
description: Unique 24-hexadecimal digit string that identifies the index.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: ^([a-f0-9]{24})$
readOnly: true
indexStatsMeasurements:
type: array
@@ -31243,8 +32346,6 @@ components:
project contains MongoDB processes that you want to return. The
MongoDB process can be either the `mongod` or `mongos`.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
hardwareMeasurements:
@@ -31403,10 +32504,6 @@ components:
groupId:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: ^([a-f0-9]{24})$
readOnly: true
hostname:
type: string
@@ -31458,6 +32555,8 @@ components:
default: collection
description: Human-readable label that identifies the type of namespace.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
readOnly: true
Namespaces:
type: object
@@ -31528,8 +32627,6 @@ components:
contains the IP access list to which you want to add one or more
entries.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
ipAddress:
@@ -31650,8 +32747,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this federation.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
identityProviderId:
@@ -31659,8 +32754,6 @@ components:
description: Legacy 20-hexadecimal digit string that identifies the identity
provider connected to this organization.
example: c2777a9eca931f29fc2f
- maxLength: 20
- minLength: 20
pattern: ^([a-f0-9]{20})$
identityProviderStatus:
type: string
@@ -31679,30 +32772,20 @@ components:
groupId:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
- maxLength: 24
- minLength: 24
- pattern: ^([a-f0-9]{24})$
readOnly: true
groupName:
type: string
description: Human-readable label that identifies the project.
- maxLength: 64
- minLength: 1
pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$
orgId:
type: string
description: Unique 24-hexadecimal character string that identifies the
organization that contains the project.
- maxLength: 24
- minLength: 24
- pattern: ^([a-f0-9]{24})$
readOnly: true
orgName:
type: string
description: Human-readable label that identifies the organization that contains
the project.
- maxLength: 64
- minLength: 1
pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$
planType:
type: string
@@ -31803,6 +32886,177 @@ components:
items:
type: string
description: Organization roles available for Service Accounts.
+ OrgUserRequest:
+ type: object
+ properties:
+ roles:
+ $ref: "#/components/schemas/OrgUserRolesRequest"
+ teamIds:
+ type: array
+ description: List of unique 24-hexadecimal digit strings that identifies the
+ teams to which this MongoDB Cloud user belongs.
+ items:
+ type: string
+ uniqueItems: true
+ writeOnly: true
+ username:
+ type: string
+ format: email
+ description: Email address that represents the username of the MongoDB Cloud user.
+ writeOnly: true
+ required:
+ - roles
+ - username
+ OrgUserResponse:
+ type: object
+ properties:
+ id:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the MongoDB
+ Cloud user.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: ^([a-f0-9]{24})$
+ readOnly: true
+ orgMembershipStatus:
+ type: string
+ description: String enum that indicates whether the MongoDB Cloud user has a
+ pending invitation to join the organization or they are already
+ active in the organization.
+ readOnly: true
+ roles:
+ $ref: "#/components/schemas/OrgUserRolesResponse"
+ teamIds:
+ type: array
+ description: List of unique 24-hexadecimal digit strings that identifies the
+ teams to which this MongoDB Cloud user belongs.
+ items:
+ type: string
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: ^([a-f0-9]{24})$
+ readOnly: true
+ uniqueItems: true
+ username:
+ type: string
+ format: email
+ description: Email address that represents the username of the MongoDB Cloud user.
+ readOnly: true
+ invitationCreatedAt:
+ type: string
+ format: date-time
+ description: Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud
+ represents this timestamp in ISO 8601 format in UTC.
+ readOnly: true
+ invitationExpiresAt:
+ type: string
+ format: date-time
+ description: Date and time when the invitation from MongoDB Cloud expires.
+ MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
+ readOnly: true
+ inviterUsername:
+ type: string
+ format: email
+ description: Username of the MongoDB Cloud user who sent the invitation to join
+ the organization.
+ readOnly: true
+ country:
+ type: string
+ description: Two-character alphabetical string that identifies the MongoDB Cloud
+ user's geographic location. This parameter uses the ISO 3166-1a2
+ code format.
+ example: US
+ pattern: ^([A-Z]{2})$
+ readOnly: true
+ createdAt:
+ type: string
+ format: date-time
+ description: Date and time when MongoDB Cloud created the current account. This
+ value is in the ISO 8601 timestamp format in UTC.
+ readOnly: true
+ firstName:
+ type: string
+ description: First or given name that belongs to the MongoDB Cloud user.
+ example: John
+ readOnly: true
+ lastAuth:
+ type: string
+ format: date-time
+ description: Date and time when the current account last authenticated. This
+ value is in the ISO 8601 timestamp format in UTC.
+ readOnly: true
+ lastName:
+ type: string
+ description: Last name, family name, or surname that belongs to the MongoDB
+ Cloud user.
+ example: Doe
+ readOnly: true
+ mobileNumber:
+ type: string
+ description: Mobile phone number that belongs to the MongoDB Cloud user.
+ pattern: (?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\s*(?:[.-]\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\s*(?:[.-]\\s*)?([0-9]{4})$
+ readOnly: true
+ required:
+ - id
+ - orgMembershipStatus
+ - roles
+ - username
+ OrgUserRolesRequest:
+ type: object
+ description: Organization and project level roles to assign the MongoDB Cloud
+ user within one organization.
+ properties:
+ groupRoleAssignments:
+ type: array
+ description: List of project level role assignments to assign the MongoDB Cloud
+ user.
+ items:
+ $ref: "#/components/schemas/GroupRoleAssignment"
+ orgRoles:
+ type: array
+ description: One or more organization level roles to assign the MongoDB Cloud
+ user.
+ items:
+ type: string
+ description: Organization-level role.
+ minItems: 1
+ uniqueItems: true
+ required:
+ - orgRoles
+ writeOnly: true
+ OrgUserRolesResponse:
+ type: object
+ description: Organization- and project-level roles assigned to one MongoDB Cloud
+ user within one organization.
+ properties:
+ groupRoleAssignments:
+ type: array
+ description: List of project-level role assignments assigned to the MongoDB
+ Cloud user.
+ items:
+ $ref: "#/components/schemas/GroupRoleAssignment"
+ orgRoles:
+ type: array
+ description: One or more organization-level roles assigned to the MongoDB Cloud
+ user.
+ items:
+ type: string
+ description: Organization-level role.
+ uniqueItems: true
+ readOnly: true
+ OrgUserUpdateRequest:
+ type: object
+ properties:
+ roles:
+ $ref: "#/components/schemas/OrgUserRolesRequest"
+ teamIds:
+ type: array
+ description: List of unique 24-hexadecimal digit strings that identifies the
+ teams to assign the MongoDB Cloud user.
+ items:
+ type: string
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: ^([a-f0-9]{24})$
+ uniqueItems: true
+ writeOnly: true
OrganizationInvitation:
type: object
properties:
@@ -31829,8 +33083,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this invitation.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
inviterUsername:
@@ -31854,8 +33106,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the organization.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
orgName:
@@ -31876,10 +33126,6 @@ components:
items:
type: string
description: Unique 24-hexadecimal digit string that identifies the team.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: ^([a-f0-9]{24})$
readOnly: true
uniqueItems: true
username:
@@ -31897,8 +33143,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project to
which these roles belong.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
roles:
type: array
@@ -31929,10 +33173,6 @@ components:
items:
type: string
description: Unique 24-hexadecimal digit string that identifies the team.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: ^([a-f0-9]{24})$
uniqueItems: true
username:
type: string
@@ -31961,10 +33201,6 @@ components:
items:
type: string
description: Unique 24-hexadecimal digit string that identifies the team.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: ^([a-f0-9]{24})$
uniqueItems: true
OrganizationSettings:
type: object
@@ -32082,6 +33318,35 @@ components:
readOnly: true
readOnly: true
title: Outbound Control Plane IP Addresses By Cloud Provider
+ PaginatedApiVersions:
+ type: object
+ properties:
+ links:
+ type: array
+ 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.
+ externalDocs:
+ description: Web Linking Specification (RFC 5988)
+ url: https://datatracker.ietf.org/doc/html/rfc5988
+ items:
+ $ref: "#/components/schemas/Link"
+ readOnly: true
+ results:
+ type: array
+ description: List of returned documents that MongoDB Cloud provides when
+ completing this request.
+ items:
+ $ref: "#/components/schemas/ApiVersion"
+ readOnly: true
+ totalCount:
+ type: integer
+ format: int32
+ 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.
+ minimum: 0
+ readOnly: true
PaginatedClusterDescription20240805:
type: object
properties:
@@ -32353,8 +33618,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this index.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
impact:
@@ -32366,9 +33629,6 @@ components:
type: string
description: One unique 24-hexadecimal character string that identifies one
query shape.
- maxLength: 24
- minLength: 24
- pattern: ^([a-f0-9]{24})$
readOnly: true
index:
type: array
@@ -32469,8 +33729,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this shape. This
string exists only for the duration of this API request.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
inefficiencyScore:
@@ -32601,10 +33859,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the interface
endpoint.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: ^([a-f0-9]{24})$
readOnly: true
privateEndpointConnectionName:
type: string
@@ -32673,8 +33927,6 @@ components:
description: Atlas Data Lake supports Amazon Web Services private endpoints
using the AWS PrivateLink feature.
url: https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc
- maxLength: 22
- minLength: 22
pattern: ^vpce-[0-9a-f]{17}$
errorMessage:
type: string
@@ -32810,8 +34062,6 @@ components:
the Cluster that you exclude from the request. This corresponds to
Shard ID displayed in the UI.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
regionConfigs:
@@ -32840,8 +34090,6 @@ components:
Global Cluster. This value can be used to configure Global Cluster
backup policies.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
zoneName:
@@ -32915,8 +34163,6 @@ components:
which this role belongs. Each element within **roleAssignments** can
have a value for **groupId** or **orgId**, but not both.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
orgId:
type: string
@@ -32924,8 +34170,6 @@ components:
to which this role belongs. Each element within **roleAssignments**
can have a value for **orgId** or **groupId**, but not both.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
role:
type: string
@@ -32977,16 +34221,12 @@ components:
description: Unique 24-hexadecimal character string that identifies this sample
dataset.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
clusterName:
type: string
description: Human-readable label that identifies the cluster into which you
loaded the sample dataset.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
readOnly: true
completeDate:
@@ -33011,6 +34251,60 @@ components:
type: string
description: Status of the sample dataset load job.
readOnly: true
+ SchemaAdvisorItemRecommendation:
+ type: object
+ properties:
+ affectedNamespaces:
+ type: array
+ description: List that contains the namespaces and information on why those
+ namespaces triggered the recommendation.
+ items:
+ $ref: "#/components/schemas/SchemaAdvisorNamespaceTriggers"
+ readOnly: true
+ description:
+ type: string
+ description: Description of the specified recommendation.
+ readOnly: true
+ recommendation:
+ type: string
+ description: Type of recommendation.
+ readOnly: true
+ SchemaAdvisorNamespaceTriggers:
+ type: object
+ properties:
+ namespace:
+ type: string
+ description: Namespace of the affected collection. Will be null for
+ REDUCE_NUMBER_OF_NAMESPACE recommendation.
+ readOnly: true
+ triggers:
+ type: array
+ description: List of triggers that specify why the collection activated the
+ recommendation.
+ items:
+ $ref: "#/components/schemas/SchemaAdvisorTriggerDetails"
+ readOnly: true
+ SchemaAdvisorResponse:
+ type: object
+ properties:
+ recommendations:
+ type: array
+ description: List that contains the documents with information about the schema
+ advice that Performance Advisor suggests.
+ items:
+ $ref: "#/components/schemas/SchemaAdvisorItemRecommendation"
+ readOnly: true
+ SchemaAdvisorTriggerDetails:
+ type: object
+ properties:
+ description:
+ type: string
+ description: Description of the trigger type.
+ readOnly: true
+ triggerType:
+ type: string
+ description: Type of trigger.
+ readOnly: true
SearchIndexCreateRequest:
type: object
properties:
@@ -33029,6 +34323,8 @@ components:
type:
type: string
description: Type of the index. The default type is search.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
definition:
$ref: "#/components/schemas/BaseSearchIndexCreateRequestDefinition"
required:
@@ -33066,8 +34362,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this Atlas
Search index.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
latestDefinition:
$ref: "#/components/schemas/BaseSearchIndexResponseLatestDefinition"
@@ -33101,6 +34395,8 @@ components:
type:
type: string
description: Type of the index. The default type is search.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
synonymMappingStatus:
type: string
description: Status that describes this index's synonym mappings. This status
@@ -33150,6 +34446,8 @@ components:
externalDocs:
description: Atlas Search Analyzers
url: https://dochub.mongodb.org/core/analyzers--fts
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
analyzers:
type: array
description: List of user-defined methods to convert database field text into
@@ -33171,6 +34469,8 @@ components:
type: string
default: lucene.standard
description: Method applied to identify words when searching this index.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
storedSource:
type: object
description: Flag that indicates whether to store all fields (true) on Atlas
@@ -33235,6 +34535,8 @@ components:
type: string
description: Specific pre-defined method chosen to apply to the synonyms to be
searched.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
name:
type: string
description: Label that identifies the synonym definition. Each **synonym.name**
@@ -33256,6 +34558,8 @@ components:
deliveryType:
type: string
description: Human-readable label that categorizes the restore job to create.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
deliveryUrl:
type: array
description: 'One or more Uniform Resource Locators (URLs) that point to the
@@ -33293,8 +34597,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the restore
job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -33339,24 +34641,18 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
targetClusterName:
type: string
description: Human-readable label that identifies the target cluster to which
the restore job restores the snapshot. The resource returns this
parameter when `"deliveryType":` `"automated"`.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
targetGroupId:
type: string
description: Unique 24-hexadecimal digit string that identifies the target
project for the specified **targetClusterName**.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
timestamp:
type: string
@@ -33390,12 +34686,12 @@ components:
description: Human-readable label that identifies how often this snapshot
triggers.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -33418,19 +34714,21 @@ components:
type: string
description: Human-readable label given to the serverless instance from which
MongoDB Cloud took this snapshot.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
readOnly: true
snapshotType:
type: string
description: Human-readable label that identifies when this snapshot triggers.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
status:
type: string
description: Human-readable label that indicates the stage of the backup process
for this snapshot.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
storageSizeBytes:
type: integer
format: int64
@@ -33498,8 +34796,6 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
id:
@@ -33507,8 +34803,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the serverless
instance.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -33530,8 +34824,6 @@ components:
name:
type: string
description: Human-readable label that identifies the serverless instance.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
providerSettings:
$ref: "#/components/schemas/ServerlessProviderSettings"
@@ -33593,8 +34885,6 @@ components:
name:
type: string
description: Human-readable label that identifies the serverless instance.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
writeOnly: true
providerSettings:
@@ -33644,39 +34934,6 @@ components:
delete the serverless instance. If set to `false`, MongoDB Cloud
will delete the serverless instance.
title: Serverless Instance Description Update
- ServerlessMetricThreshold:
- type: object
- description: Threshold for the metric that, when exceeded, triggers an alert.
- The metric threshold pertains to event types which reflects changes of
- measurements and metrics about the serverless database.
- properties:
- metricName:
- type: string
- description: Human-readable label that identifies the metric against which
- MongoDB Cloud checks the configured **metricThreshold.threshold**.
- mode:
- type: string
- description: MongoDB Cloud computes the current metric value as an average.
- operator:
- type: string
- description: Comparison operator to apply when checking the current metric value.
- threshold:
- type: number
- format: double
- description: Value of metric that, when exceeded, triggers an alert.
- units:
- $ref: "#/components/schemas/ServerlessMetricUnits"
- description: Element used to express the quantity. This can be an element of
- time, storage capacity, and the like.
- required:
- - metricName
- title: Serverless Metric Threshold
- ServerlessMetricUnits:
- type: string
- description: Element used to express the quantity. This can be an element of
- time, storage capacity, and the like.
- example: RPU
- title: Serverless Metric Units
ServerlessProviderSettings:
type: object
description: Group of cloud provider settings that configure the provisioned
@@ -33686,6 +34943,20 @@ components:
type: string
description: Cloud service provider on which MongoDB Cloud provisioned the
serverless instance.
+ effectiveDiskSizeGBLimit:
+ type: integer
+ format: int32
+ description: Storage capacity of instance data volumes expressed in gigabytes.
+ This value is not configurable for Serverless or effectively Flex
+ clusters.
+ readOnly: true
+ effectiveInstanceSizeName:
+ $ref: "#/components/schemas/BaseCloudProviderInstanceSize"
+ effectiveProviderName:
+ type: string
+ description: Cloud service provider on which MongoDB Cloud effectively
+ provisioned the serverless instance.
+ readOnly: true
providerName:
type: string
default: SERVERLESS
@@ -33719,8 +34990,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the private
endpoint.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
cloudProviderEndpointId:
@@ -33805,8 +35074,6 @@ components:
id remains the same. The resource and corresponding endpoints use
the term groups."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
ServiceAccountIPAccessListEntry:
@@ -33982,9 +35249,7 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the source
project.
- example: 9b43a5b329223c3a1591a678
- maxLength: 24
- minLength: 24
+ example: 32b6e34b3d91647abb20e7b8
pattern: ^([a-f0-9]{24})$
managedAuthentication:
type: boolean
@@ -34071,6 +35336,8 @@ components:
type:
type: string
description: Type of the connection. Can be either Cluster or Kafka.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
clusterName:
type: string
description: Name of the cluster configured for this connection.
@@ -34144,8 +35411,8 @@ components:
cloudProvider:
type: string
description: Label that identifies the cloud service provider where MongoDB
- Cloud performs stream processing. Currently, this parameter supports
- AWS only.
+ Cloud performs stream processing. Currently, this parameter only
+ supports AWS and AZURE.
links:
type: array
description: List of one or more Uniform Resource Locators (URLs) that point to
@@ -34218,8 +35485,6 @@ components:
type: string
description: Reserved. Will be used by PRIVATE_LINK connection type.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
links:
type: array
@@ -34367,6 +35632,10 @@ components:
description: The ID of the Private Link connection.
example: 32b6e34b3d91647abb20e7b8
pattern: ^([a-f0-9]{24})$
+ readOnly: true
+ arn:
+ type: string
+ description: Amazon Resource Name (ARN).
dnsDomain:
type: string
description: Domain name of Privatelink connected cluster.
@@ -34376,10 +35645,15 @@ components:
availability zones.
items:
type: string
+ errorMessage:
+ type: string
+ description: Error message if the state is FAILED.
+ readOnly: true
interfaceEndpointId:
type: string
description: Interface endpoint ID that is created from the service endpoint ID
provided.
+ readOnly: true
links:
type: array
description: List of one or more Uniform Resource Locators (URLs) that point to
@@ -34394,6 +35668,10 @@ components:
provider:
type: string
description: Provider where the Kafka cluster is deployed.
+ providerAccountId:
+ type: string
+ description: Account ID from the cloud provider.
+ readOnly: true
region:
type: string
description: Domain name of Confluent cluster.
@@ -34403,6 +35681,7 @@ components:
state:
type: string
description: State the connection is in.
+ readOnly: true
vendor:
type: string
description: Vendor who manages the Kafka cluster.
@@ -34415,8 +35694,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the stream
processor.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -34452,8 +35729,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the stream
processor.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -34523,8 +35798,6 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
connections:
@@ -34539,8 +35812,6 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
hostnames:
@@ -34607,6 +35878,8 @@ components:
description: Human-readable label that identifies the service from which you
requested this response.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
build:
type: string
description: Unique 40-hexadecimal digit hash that identifies the latest git
@@ -34659,8 +35932,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this team.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -34694,8 +35965,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this team.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -34737,8 +36006,6 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the team.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
TeamUpdate:
type: object
@@ -34766,8 +36033,6 @@ components:
clusterName:
type: string
description: Human-readable label that identifies the source cluster.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
readOnly: true
deliveryType:
@@ -34786,8 +36051,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the restore job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -34806,8 +36069,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project from
which the restore job originated.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
restoreFinishedDate:
@@ -34837,8 +36098,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the snapshot to
restore.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
snapshotUrl:
type: string
@@ -34856,16 +36115,12 @@ components:
description: Human-readable label that identifies the cluster on the target
project to which you want to restore the snapshot. You can restore
the snapshot to a cluster tier *M2* or greater.
- maxLength: 64
- minLength: 1
pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$
targetProjectId:
type: string
description: Unique 24-hexadecimal digit string that identifies the project that
contains the cluster to which you want to restore the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
required:
- snapshotId
@@ -34927,8 +36182,6 @@ components:
description: Unique 40-hexadecimal digit string that identifies your New Relic
account.
example: bcc3c81b344a6030a3935c2527e2216535af7718
- maxLength: 40
- minLength: 40
pattern: ^([0-9a-f]){40}$
licenseKey:
type: string
@@ -34939,10 +36192,11 @@ components:
**IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.
- To learn more, see the New Relic Plugin EOL Statement Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.
+ Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.
example: bc3768f44193c282b2688ab39e00f8e4fc8d75ea
- maxLength: 40
- minLength: 40
+ externalDocs:
+ description: New Relic Plugin EOL Statement
+ url: https://discuss.newrelic.com/t/new-relic-plugin-eol-wednesday-june-16th-2021/127267
pattern: ^([0-9a-f]){40}$
readToken:
type: string
@@ -34978,6 +36232,8 @@ components:
serviceDiscovery:
type: string
description: Desired method to discover the Prometheus service.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
username:
type: string
description: Human-readable label that identifies your Prometheus incoming
@@ -35019,13 +36275,13 @@ components:
example: test routing
secret:
type: string
+ format: password
description: >-
An optional field returned if your webhook is configured with a
secret.
**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
- example: "******"
url:
type: string
description: >-
@@ -35044,8 +36300,6 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
writeOnly: true
required:
@@ -35188,6 +36442,8 @@ components:
items:
type: string
uniqueItems: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
usageEndDate:
type: string
format: date
@@ -35293,8 +36549,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
API key.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
UserCert:
@@ -35317,8 +36571,6 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -35381,8 +36633,6 @@ components:
type: string
description: Human-readable label that identifies the cluster or MongoDB Atlas
Data Lake that this database user can access.
- maxLength: 64
- minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
type:
type: string
@@ -35597,8 +36847,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration related to the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
cid:
@@ -35606,17 +36854,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project in
which the event occurred.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
cre:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp
- format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
description:
type: string
@@ -35632,8 +36879,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
orgId:
@@ -35641,8 +36886,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
orgName:
@@ -35686,6 +36929,8 @@ components:
externalDocs:
description: Atlas Search Analyzers
url: https://dochub.mongodb.org/core/analyzers--fts
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
analyzers:
type: array
description: List of user-defined methods to convert database field text into
@@ -35707,6 +36952,8 @@ components:
type: string
default: lucene.standard
description: Method applied to identify words when searching this index.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
storedSource:
type: object
description: Flag that indicates whether to store all fields (true) on Atlas
@@ -35769,6 +37016,8 @@ components:
externalDocs:
description: Atlas Search Analyzers
url: https://dochub.mongodb.org/core/analyzers--fts
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
analyzers:
type: array
description: List of user-defined methods to convert database field text into
@@ -35790,6 +37039,8 @@ components:
type: string
default: lucene.standard
description: Method applied to identify words when searching this index.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
storedSource:
type: object
description: Flag that indicates whether to store all fields (true) on Atlas
@@ -35862,8 +37113,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the cluster that
contains the checkpoint.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
completed:
@@ -35878,16 +37127,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project that
owns the checkpoints.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies checkpoint.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -35981,8 +37226,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization the resource belongs to.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
resourceId:
@@ -35990,8 +37233,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
non-compliant resource.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
resourceName:
@@ -36034,8 +37275,6 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
ApiAtlasPolicy:
@@ -36058,13 +37297,14 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
ApiAtlasResourcePolicyCreate:
type: object
properties:
+ description:
+ type: string
+ description: Description of the atlas resource policy.
name:
type: string
description: Human-readable label that describes the atlas resource policy.
@@ -36079,6 +37319,9 @@ components:
ApiAtlasResourcePolicyEdit:
type: object
properties:
+ description:
+ type: string
+ description: Description of the atlas resource policy.
name:
type: string
description: Human-readable label that describes the atlas resource policy.
@@ -36102,8 +37345,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the atlas
resource policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
resourcePolicyName:
@@ -36121,13 +37362,15 @@ components:
description: Date and time in UTC when the atlas resource policy was created.
example: 2022-01-01T00:00:00Z
readOnly: true
+ description:
+ type: string
+ description: Description of the atlas resource policy.
+ readOnly: true
id:
type: string
description: Unique 24-hexadecimal character string that identifies the atlas
resource policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
lastUpdatedByUser:
@@ -36147,8 +37390,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization the atlas resource policy belongs to.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
policies:
@@ -36177,8 +37418,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the cluster with
the snapshot you want to return.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
dailySnapshotRetentionDays:
type: integer
@@ -36191,8 +37430,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project that
contains the cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
links:
@@ -36247,8 +37484,6 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies a user.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
name:
@@ -36310,7 +37545,10 @@ components:
properties:
specs:
type: array
- description: List of settings that configure the Search Nodes for your cluster.
+ description: |-
+ List of settings that configure the Search Nodes for your cluster.
+
+ **NOTE**: We accept a single configuration for all nodes currently.
items:
$ref: "#/components/schemas/ApiSearchDeploymentSpec"
maxItems: 1
@@ -36324,8 +37562,6 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
id:
@@ -36333,13 +37569,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the search
deployment.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
readOnly: true
specs:
type: array
description: List of settings that configure the Search Nodes for your cluster.
+ The configuration will be returned for each region and shard.
items:
$ref: "#/components/schemas/ApiSearchDeploymentSpec"
readOnly: true
@@ -36373,13 +37608,13 @@ components:
description: Unique 24-hexadecimal character string that identifies the Export
Bucket.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: ^([a-f0-9]{24})$
frequencyType:
type: string
description: Human-readable label that indicates the rate at which the export
policy item occurs.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
title: export
CollStatsRankedNamespaces:
type: object
@@ -36425,8 +37660,7 @@ components:
where you wish to store your archived data. **AZURE** or **GCP** may
be selected only if it is the Cloud service provider for the cluster
and no archives for any other cloud provider have been created for
- the cluster. **GCP** is currently only supported in [private
- preview](https://www.mongodb.com/community/forums/t/invitation-to-participate-in-the-private-preview-program-of-online-archive-on-gcp).
+ the cluster.
region:
type: string
description: Human-readable label that identifies the geographic location of the
@@ -37193,35 +38427,6 @@ components:
and may not be exact.
minimum: 0
readOnly: true
- PaginatedAppUser:
- type: object
- properties:
- links:
- type: array
- 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.
- externalDocs:
- description: Web Linking Specification (RFC 5988)
- url: https://datatracker.ietf.org/doc/html/rfc5988
- items:
- $ref: "#/components/schemas/Link"
- readOnly: true
- results:
- type: array
- description: List of returned documents that MongoDB Cloud provides when
- completing this request.
- items:
- $ref: "#/components/schemas/CloudAppUser"
- readOnly: true
- totalCount:
- type: integer
- format: int32
- 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.
- minimum: 0
- readOnly: true
PaginatedAtlasGroup:
type: object
properties:
@@ -37573,6 +38778,35 @@ components:
and may not be exact.
minimum: 0
readOnly: true
+ PaginatedGroupUser:
+ type: object
+ properties:
+ links:
+ type: array
+ 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.
+ externalDocs:
+ description: Web Linking Specification (RFC 5988)
+ url: https://datatracker.ietf.org/doc/html/rfc5988
+ items:
+ $ref: "#/components/schemas/Link"
+ readOnly: true
+ results:
+ type: array
+ description: List of returned documents that MongoDB Cloud provides when
+ completing this request.
+ items:
+ $ref: "#/components/schemas/GroupUserResponse"
+ readOnly: true
+ totalCount:
+ type: integer
+ format: int32
+ 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.
+ minimum: 0
+ readOnly: true
PaginatedIntegration:
type: object
properties:
@@ -37689,6 +38923,35 @@ components:
and may not be exact.
minimum: 0
readOnly: true
+ PaginatedOrgUser:
+ type: object
+ properties:
+ links:
+ type: array
+ 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.
+ externalDocs:
+ description: Web Linking Specification (RFC 5988)
+ url: https://datatracker.ietf.org/doc/html/rfc5988
+ items:
+ $ref: "#/components/schemas/Link"
+ readOnly: true
+ results:
+ type: array
+ description: List of returned documents that MongoDB Cloud provides when
+ completing this request.
+ items:
+ $ref: "#/components/schemas/OrgUserResponse"
+ readOnly: true
+ totalCount:
+ type: integer
+ format: int32
+ 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.
+ minimum: 0
+ readOnly: true
PaginatedOrganization:
type: object
properties:
@@ -38115,6 +39378,8 @@ components:
MongoDB Cloud skips partition parameters of type UUID with subtype
3.
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
order:
type: integer
format: int32
@@ -38282,6 +39547,8 @@ components:
type:
type: string
description: Human-readable label that identifies this tokenizer type.
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
group:
type: integer
description: Index of the character group within the matching expression to
diff --git a/openapi/atlas-api.yaml b/openapi/atlas-api.yaml
index d46dcae9b..432eb2a31 100644
--- a/openapi/atlas-api.yaml
+++ b/openapi/atlas-api.yaml
@@ -8,7 +8,7 @@ info:
```
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
--digest \
- --header "Accept: application/vnd.atlas.2024-11-13+json" \
+ --header "Accept: application/vnd.atlas.2043-01-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true"
```
@@ -21,7 +21,7 @@ info:
termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
title: MongoDB Atlas Administration API
version: "2.0"
- x-xgen-sha: b30dca0a1318cf8279cab906a13fd2bfa4889cea
+ x-xgen-sha: 27fb2a02f640fb84a8d8e31ca77165b52569054a
servers:
- url: https://cloud.mongodb.com
security:
@@ -248,6 +248,7 @@ paths:
summary: Return the status of this MongoDB application
tags:
- Root
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/getSystemStatus
/api/atlas/v2/alertConfigs/matchers/fieldNames:
get:
description: Get all field names that the `matchers.fieldName` parameter accepts
@@ -274,6 +275,9 @@ paths:
summary: Get All Alert Configuration Matchers Field Names
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/clusters:
get:
description: "Returns the details for all clusters in all projects to which\
@@ -302,6 +306,7 @@ paths:
summary: Return All Authorized Clusters in All Projects
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClustersForAllProjects
/api/atlas/v2/eventTypes:
get:
description: "Returns a list of all event types, along with a description and\
@@ -328,6 +333,7 @@ paths:
summary: List All Possible Event Types
tags:
- Events
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listEventTypes
/api/atlas/v2/federationSettings/{federationSettingsId}:
delete:
description: "Deletes the federation settings instance and all associated data,\
@@ -355,6 +361,7 @@ paths:
summary: Delete One Federation Settings Instance
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationApp
/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs:
get:
description: "Returns all connected org configs in the specified federation.\
@@ -385,6 +392,7 @@ paths:
summary: Return All Connected Org Configs from One Federation
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listConnectedOrgConfigs
/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}:
delete:
description: "Removes one connected organization configuration from the specified\
@@ -403,8 +411,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -425,6 +431,7 @@ paths:
summary: Remove One Org Config Connected to One Federation
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeConnectedOrgConfig
get:
description: "Returns the specified connected org config from the specified\
\ federation. To use this resource, the requesting API Key must have the Organization\
@@ -441,8 +448,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -463,6 +468,7 @@ paths:
summary: Return One Org Config Connected to One Federation
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getConnectedOrgConfig
patch:
description: "Updates one connected organization configuration from the specified\
\ federation. To use this resource, the requesting API Key must have the Organization\
@@ -486,8 +492,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -515,6 +519,7 @@ paths:
summary: Update One Org Config Connected to One Federation
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig
/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings:
get:
description: "Returns all role mappings from the specified organization in the\
@@ -544,6 +549,7 @@ paths:
summary: Return All Role Mappings from One Organization
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listRoleMappings
post:
description: "Adds one role mapping to the specified organization in the specified\
\ federation. To use this resource, the requesting API Key must have the Organization\
@@ -579,6 +585,7 @@ paths:
summary: Add One Role Mapping to One Organization
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createRoleMapping
/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}:
delete:
description: "Removes one role mapping in the specified organization from the\
@@ -595,8 +602,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- $ref: "#/components/parameters/envelope"
- $ref: "#/components/parameters/orgId"
@@ -617,6 +622,7 @@ paths:
summary: Remove One Role Mapping from One Organization
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteRoleMapping
get:
description: "Returns one role mapping from the specified organization in the\
\ specified federation. To use this resource, the requesting API Key must\
@@ -632,8 +638,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- $ref: "#/components/parameters/envelope"
- $ref: "#/components/parameters/orgId"
@@ -656,6 +660,7 @@ paths:
summary: Return One Role Mapping from One Organization
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getRoleMapping
put:
description: "Updates one role mapping in the specified organization in the\
\ specified federation. To use this resource, the requesting API Key must\
@@ -671,8 +676,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- $ref: "#/components/parameters/envelope"
- $ref: "#/components/parameters/orgId"
@@ -702,6 +705,7 @@ paths:
summary: Update One Role Mapping in One Organization
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateRoleMapping
/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders:
get:
description: "Returns all identity providers with the provided protocol and\
@@ -756,6 +760,7 @@ paths:
summary: Return All Identity Providers in One Federation
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listIdentityProviders
post:
description: |-
Creates one identity provider within the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations.
@@ -793,6 +798,7 @@ paths:
summary: Create One Identity Provider
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createIdentityProvider
/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}:
delete:
description: "Deletes one identity provider in the specified federation. To\
@@ -831,6 +837,7 @@ paths:
summary: Delete One Identity Provider
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteIdentityProvider
get:
description: "Returns one identity provider in the specified federation by the\
\ identity provider's id. To use this resource, the requesting API Key must\
@@ -873,6 +880,7 @@ paths:
summary: Return One Identity Provider by ID
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProvider
patch:
description: |-
Updates one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations.
@@ -920,6 +928,7 @@ paths:
summary: Update One Identity Provider
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateIdentityProvider
/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks:
delete:
description: "Revokes the JWKS tokens from the requested OIDC identity provider.\
@@ -959,6 +968,9 @@ paths:
summary: Revoke the JWKS from One OIDC Identity Provider
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeJwksFromIdentityProvider
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml:
get:
description: "Returns the metadata of one identity provider in the specified\
@@ -987,6 +999,7 @@ paths:
summary: Return the Metadata of One Identity Provider
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProviderMetadata
/api/atlas/v2/groups:
get:
description: "Returns details about all projects. Projects group clusters into\
@@ -1018,6 +1031,7 @@ paths:
summary: Return All Projects
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjects
post:
description: "Creates one project. Projects group clusters into logical collections\
\ that support an application environment, workload, or both. Each project\
@@ -1035,8 +1049,6 @@ paths:
name: projectOwnerId
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -1068,6 +1080,7 @@ paths:
summary: Create One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProject
/api/atlas/v2/groups/byName/{groupName}:
get:
description: "Returns details about the specified project. Projects group clusters\
@@ -1108,6 +1121,9 @@ paths:
summary: Return One Project using Its Name
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectByName
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}:
delete:
description: "Removes the specified project. Projects group clusters into logical\
@@ -1138,6 +1154,7 @@ paths:
summary: Remove One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProject
get:
description: "Returns details about the specified project. Projects group clusters\
\ into logical collections that support an application environment, workload,\
@@ -1166,6 +1183,7 @@ paths:
summary: Return One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProject
patch:
description: "Updates the human-readable label that identifies the specified\
\ project, or the tags associated with the project. To use this resource,\
@@ -1203,8 +1221,10 @@ paths:
summary: Update One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProject
/api/atlas/v2/groups/{groupId}/access:
post:
+ deprecated: true
description: "Adds one MongoDB Cloud user to the specified project. If the MongoDB\
\ Cloud user is not a member of the project's organization, then the user\
\ must accept their invitation to the organization to access information within\
@@ -1244,6 +1264,10 @@ paths:
summary: Add One MongoDB Cloud User to One Project
tags:
- Projects
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addUserToProject
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/accessList:
get:
description: "Returns all access list entries from the specified project's IP\
@@ -1283,6 +1307,7 @@ paths:
summary: Return Project IP Access List
tags:
- Project IP Access List
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/listProjectIpAccessLists
post:
description: "Adds one or more access list entries to the specified project.\
\ MongoDB Cloud only allows client connections to the cluster from entries\
@@ -1335,6 +1360,7 @@ paths:
summary: Add Entries to Project IP Access List
tags:
- Project IP Access List
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/createProjectIpAccessList
/api/atlas/v2/groups/{groupId}/accessList/{entryValue}:
delete:
description: "Removes one access list entry from the specified project's IP\
@@ -1389,6 +1415,7 @@ paths:
summary: Remove One Entry from One Project IP Access List
tags:
- Project IP Access List
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/deleteProjectIpAccessList
get:
description: "Returns one access list entry from the specified project's IP\
\ access list. Each entry in the project's IP access list contains either\
@@ -1444,6 +1471,7 @@ paths:
summary: Return One Project IP Access List Entry
tags:
- Project IP Access List
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpList
/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status:
get:
description: Returns the status of one project IP access list entry. This resource
@@ -1488,6 +1516,7 @@ paths:
summary: Return Status of One Project IP Access List Entry
tags:
- Project IP Access List
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpAccessListStatus
/api/atlas/v2/groups/{groupId}/alertConfigs:
get:
description: |-
@@ -1517,6 +1546,7 @@ paths:
summary: Return All Alert Configurations for One Project
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations
post:
description: |-
Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
@@ -1551,6 +1581,7 @@ paths:
summary: Create One Alert Configuration in One Project
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration
/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}:
delete:
description: |-
@@ -1572,8 +1603,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -1590,6 +1619,7 @@ paths:
summary: Remove One Alert Configuration from One Project
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteAlertConfiguration
get:
description: |-
Returns the specified alert configuration from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
@@ -1610,8 +1640,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -1630,6 +1658,7 @@ paths:
summary: Return One Alert Configuration from One Project
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getAlertConfiguration
patch:
description: |-
Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
@@ -1652,8 +1681,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -1680,6 +1707,7 @@ paths:
summary: Toggle One State of One Alert Configuration in One Project
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration
put:
description: |-
Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
@@ -1702,8 +1730,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -1731,6 +1757,7 @@ paths:
summary: Update One Alert Configuration for One Project
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration
/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts:
get:
description: |-
@@ -1755,8 +1782,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -1775,6 +1800,7 @@ paths:
summary: Return All Open Alerts for Alert Configuration
tags:
- Alerts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlertsByAlertConfigurationId
/api/atlas/v2/groups/{groupId}/alerts:
get:
description: |-
@@ -1816,6 +1842,7 @@ paths:
summary: Return All Alerts from One Project
tags:
- Alerts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts
/api/atlas/v2/groups/{groupId}/alerts/{alertId}:
get:
description: |-
@@ -1835,8 +1862,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -1855,6 +1880,7 @@ paths:
summary: Return One Alert from One Project
tags:
- Alerts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getAlert
patch:
description: |-
Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
@@ -1873,8 +1899,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -1902,6 +1926,7 @@ paths:
summary: Acknowledge One Alert from One Project
tags:
- Alerts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert
/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs:
get:
description: |-
@@ -1924,8 +1949,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -1944,6 +1967,7 @@ paths:
summary: Return All Alert Configurations Set for One Alert
tags:
- Alert Configurations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationsByAlertId
/api/atlas/v2/groups/{groupId}/apiKeys:
get:
description: "Returns all organization API keys that you assigned to the specified\
@@ -1976,6 +2000,7 @@ paths:
summary: Return All Organization API Keys Assigned to One Project
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listProjectApiKeys
post:
description: "Creates and assigns the specified organization API key to the\
\ specified project. Users with the Project Owner role in the project associated\
@@ -2010,6 +2035,9 @@ paths:
summary: Create and Assign One Organization API Key to One Project
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}:
delete:
description: "Removes one organization API key from the specified project. To\
@@ -2028,8 +2056,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- $ref: "#/components/parameters/pretty"
responses:
@@ -2049,6 +2075,7 @@ paths:
summary: Unassign One Organization API Key from One Project
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeProjectApiKey
patch:
description: Updates the roles of the organization API key that you specify
for the project that you specify. You must specify at least one valid role
@@ -2070,8 +2097,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -2098,6 +2123,7 @@ paths:
summary: Update Roles of One Organization API Key to One Project
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKeyRoles
post:
description: "Assigns the specified organization API key to the specified project.\
\ Users with the Project Owner role in the project associated with the API\
@@ -2114,8 +2140,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- $ref: "#/components/parameters/pretty"
requestBody:
@@ -2142,6 +2166,7 @@ paths:
summary: Assign One Organization API Key to One Project
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey
/api/atlas/v2/groups/{groupId}/auditLog:
get:
description: "Returns the auditing configuration for the specified project.\
@@ -2169,6 +2194,7 @@ paths:
summary: Return the Auditing Configuration for One Project
tags:
- Auditing
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getAuditingConfiguration
patch:
description: "Updates the auditing configuration for the specified project.\
\ The auditing configuration defines the events that MongoDB Cloud records\
@@ -2204,6 +2230,7 @@ paths:
summary: Update Auditing Configuration for One Project
tags:
- Auditing
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateAuditingConfiguration
/api/atlas/v2/groups/{groupId}/awsCustomDNS:
get:
description: "Returns the custom DNS configuration for AWS clusters in the specified\
@@ -2229,6 +2256,7 @@ paths:
summary: Return One Custom DNS Configuration for Atlas Clusters on AWS
tags:
- AWS Clusters DNS
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getAwsCustomDns
patch:
description: "Enables or disables the custom DNS configuration for AWS clusters\
\ in the specified project. Enable custom DNS if you use AWS VPC peering and\
@@ -2263,6 +2291,7 @@ paths:
AWS
tags:
- AWS Clusters DNS
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns
/api/atlas/v2/groups/{groupId}/backup/exportBuckets:
get:
description: "Returns all Export Buckets associated with the specified Project.\
@@ -2291,6 +2320,7 @@ paths:
summary: Return All Snapshot Export Buckets
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listExportBuckets
post:
description: "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure\
\ Blob Storage Container. Once created, an snapshots can be exported to the\
@@ -2366,12 +2396,15 @@ paths:
summary: Create One Snapshot Export Bucket
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createExportBucket
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}:
delete:
description: "Deletes an Export Bucket. Auto export must be disabled on all\
\ clusters in this Project exporting to this Export Bucket before revoking\
\ access. To use this resource, the requesting API Key must have the Project\
- \ Owner role."
+ \ Backup Manager role."
operationId: deleteExportBucket
parameters:
- $ref: "#/components/parameters/envelope"
@@ -2384,8 +2417,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -2406,6 +2437,7 @@ paths:
summary: Delete One Snapshot Export Bucket
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteExportBucket
get:
description: "Returns one Export Bucket associated with the specified Project.\
\ To use this resource, the requesting API Key must have the Project Read\
@@ -2422,8 +2454,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -2465,6 +2495,9 @@ paths:
summary: Return One Snapshot Export Bucket
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getExportBucket
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/backupCompliancePolicy:
delete:
description: "Disables the Backup Compliance Policy settings with the specified\
@@ -2496,6 +2529,7 @@ paths:
summary: Disable the Backup Compliance Policy settings
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableDataProtectionSettings
get:
description: "Returns the Backup Compliance Policy settings with the specified\
\ project. To use this resource, the requesting API Key must have the Project\
@@ -2522,6 +2556,7 @@ paths:
summary: Return the Backup Compliance Policy settings
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getDataProtectionSettings
put:
description: "Updates the Backup Compliance Policy settings for the specified\
\ project. To use this resource, the requesting API Key must have the Project\
@@ -2565,6 +2600,7 @@ paths:
summary: Update or enable the Backup Compliance Policy settings
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateDataProtectionSettings
/api/atlas/v2/groups/{groupId}/cloudProviderAccess:
get:
description: "Returns all cloud provider access roles with access to the specified\
@@ -2590,6 +2626,7 @@ paths:
summary: Return All Cloud Provider Access Roles
tags:
- Cloud Provider Access
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listCloudProviderAccessRoles
post:
description: "Creates one access role for the specified cloud provider. Some\
\ MongoDB Cloud features use these cloud provider access roles for authentication.\
@@ -2625,6 +2662,7 @@ paths:
summary: Create One Cloud Provider Access Role
tags:
- Cloud Provider Access
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/createCloudProviderAccessRole
/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}:
delete:
description: "Revokes access to the specified project for the specified access\
@@ -2652,8 +2690,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -2670,6 +2706,9 @@ paths:
summary: Deauthorize One Cloud Provider Access Role
tags:
- Cloud Provider Access
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}:
get:
description: "Returns the access role with the specified id and with access\
@@ -2686,8 +2725,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -2704,6 +2741,7 @@ paths:
summary: Return specified Cloud Provider Access Role
tags:
- Cloud Provider Access
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/getCloudProviderAccessRole
patch:
description: "Grants access to the specified project for the specified access\
\ role. To use this resource, the requesting API Key must have the Project\
@@ -2724,8 +2762,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -2754,14 +2790,16 @@ paths:
summary: Authorize One Cloud Provider Access Role
tags:
- Cloud Provider Access
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole
/api/atlas/v2/groups/{groupId}/clusters:
get:
- description: "Returns the details for all clusters in the specific project to\
- \ which you have access. Clusters contain a group of hosts that maintain the\
- \ same data set. The response includes clusters with asymmetrically-sized\
- \ shards. To use this resource, the requesting API Key must have the Project\
- \ Read Only role. This feature is not available for serverless clusters.\
- \ Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}"
+ description: |-
+ Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters.
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the listFlexClusters endpoint for Flex clusters instead. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}
+ externalDocs:
+ description: listFlexClusters
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters
operationId: listClusters
parameters:
- $ref: "#/components/parameters/envelope"
@@ -2791,13 +2829,15 @@ paths:
summary: Return All Clusters in One Project
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters
post:
- description: "Creates one cluster in the specified project. Clusters contain\
- \ a group of hosts that maintain the same data set. This resource can create\
- \ clusters with asymmetrically-sized shards. Each project supports up to 25\
- \ database deployments. To use this resource, the requesting API Key must\
- \ have the Project Owner role. This feature is not available for serverless\
- \ clusters. Deprecated versions: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}"
+ description: |-
+ Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters.
+
+ Please note that using an instanceSize of M2 or M5 will create a Flex cluster instead. Support for the instanceSize of M2 or M5 will be discontinued in January 2026. We recommend using the createFlexCluster API for such configurations moving forward. Deprecated versions: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}
+ externalDocs:
+ description: createFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster
operationId: createCluster
parameters:
- $ref: "#/components/parameters/envelope"
@@ -2915,6 +2955,7 @@ paths:
summary: Create One Cluster from One Project
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster
/api/atlas/v2/groups/{groupId}/clusters/provider/regions:
get:
description: "Returns the list of regions available for the specified cloud\
@@ -2957,11 +2998,23 @@ paths:
summary: Return All Cloud Provider Regions
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listCloudProviderRegions
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade:
post:
description: "Upgrades a shared-tier cluster to a dedicated cluster (M10+) in\
\ the specified project. To use this resource, the requesting API key must\
- \ have the Project Cluster Manager role. Each project supports up to 25 clusters."
+ \ have the Project Cluster Manager role. Each project supports up to 25 clusters.\
+ \ \n\nThis endpoint can also be used to upgrade Flex clusters that were created\
+ \ using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster)\
+ \ API or former M2/M5 clusters that have been migrated to Flex clusters, using\
+ \ instanceSizeName to “M2” or “M5” until January 2026. This functionality\
+ \ will be available until January 2026, after which it will only be available\
+ \ for M0 clusters. Please use the upgradeFlexCluster endpoint instead."
+ externalDocs:
+ description: upgradeFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster
operationId: upgradeSharedCluster
parameters:
- $ref: "#/components/parameters/envelope"
@@ -2997,11 +3050,20 @@ paths:
summary: Upgrade One Shared-tier Cluster
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedCluster
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless:
post:
- description: "Upgrades a shared-tier cluster to a serverless instance in the\
- \ specified project. To use this resource, the requesting API key must have\
- \ the Project Cluster Manager role."
+ deprecated: true
+ description: |-
+ This endpoint has been deprecated as of February 2025 as we no longer support the creation of new serverless instances. Please use the upgradeFlexCluster endpoint to upgrade Flex clusters.
+
+ Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role.
+ externalDocs:
+ description: upgradeFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster
operationId: upgradeSharedClusterToServerless
parameters:
- $ref: "#/components/parameters/envelope"
@@ -3037,12 +3099,20 @@ paths:
summary: Upgrades One Shared-Tier Cluster to the Serverless Instance
tags:
- Clusters
+ x-sunset: 2025-02-05
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedClusterToServerless
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:
delete:
- description: "Removes one cluster from the specified project. The cluster must\
- \ have termination protection disabled in order to be deleted. To use this\
- \ resource, the requesting API Key must have the Project Owner role. This\
- \ feature is not available for serverless clusters. Deprecated versions: v2-{2023-01-01}"
+ description: |-
+ Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters.
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the deleteFlexCluster endpoint for Flex clusters instead. Deprecated versions: v2-{2023-01-01}
+ externalDocs:
+ description: deleteFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster
operationId: deleteCluster
parameters:
- $ref: "#/components/parameters/envelope"
@@ -3054,8 +3124,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Flag that indicates whether to retain backup snapshots for the
deleted dedicated cluster.
@@ -3082,13 +3150,15 @@ paths:
summary: Remove One Cluster from One Project
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/deleteCluster
get:
- description: "Returns the details for one cluster in the specified project.\
- \ Clusters contain a group of hosts that maintain the same data set. The response\
- \ includes clusters with asymmetrically-sized shards. To use this resource,\
- \ the requesting API Key must have the Project Read Only role. This feature\
- \ is not available for serverless clusters. Deprecated versions: v2-{2023-02-01},\
- \ v2-{2023-01-01}"
+ description: |-
+ Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters.
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the getFlexCluster endpoint for Flex clusters instead. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}
+ externalDocs:
+ description: getFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster
operationId: getCluster
parameters:
- $ref: "#/components/parameters/envelope"
@@ -3100,8 +3170,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -3122,6 +3190,7 @@ paths:
summary: Return One Cluster from One Project
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster
patch:
description: "Updates the details for one cluster in the specified project.\
\ Clusters contain a group of hosts that maintain the same data set. This\
@@ -3145,8 +3214,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -3177,6 +3244,7 @@ paths:
summary: Modify One Cluster from One Project
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateCluster
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports:
get:
description: "Returns all Cloud Backup Snapshot Export Jobs associated with\
@@ -3196,8 +3264,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -3214,6 +3280,7 @@ paths:
summary: Return All Snapshot Export Jobs
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupExportJobs
post:
description: "Exports one backup Snapshot for dedicated Atlas cluster using\
\ Cloud Backups to an Export Bucket. To use this resource, the requesting\
@@ -3228,8 +3295,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -3259,6 +3324,9 @@ paths:
summary: Create One Snapshot Export Job
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupExportJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}:
get:
description: "Returns one Cloud Backup Snapshot Export Job associated with the\
@@ -3274,8 +3342,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal character string that identifies the Export
Job.
@@ -3285,8 +3351,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -3303,11 +3367,14 @@ paths:
summary: Return One Snapshot Export Job
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupExportJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs:
get:
description: "Returns all cloud backup restore jobs for one cluster from the\
\ specified project. To use this resource, the requesting API Key must have\
- \ the Project Owner role."
+ \ the Project Backup Manager role."
operationId: listBackupRestoreJobs
parameters:
- $ref: "#/components/parameters/envelope"
@@ -3323,8 +3390,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -3341,11 +3406,12 @@ paths:
summary: Return All Restore Jobs for One Cluster
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupRestoreJobs
post:
description: |-
Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot.
- To use this resource, the requesting API Key must have the Project Owner role.
+ To use this resource, the requesting API Key must have the Project Backup Manager role.
operationId: createBackupRestoreJob
parameters:
- $ref: "#/components/parameters/envelope"
@@ -3357,8 +3423,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -3388,11 +3452,14 @@ paths:
summary: Restore One Snapshot of One Cluster
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}:
delete:
description: "Cancels one cloud backup restore job of one cluster from the specified\
\ project. To use this resource, the requesting API Key must have the Project\
- \ Owner role."
+ \ Backup Manager role."
operationId: cancelBackupRestoreJob
parameters:
- $ref: "#/components/parameters/envelope"
@@ -3404,8 +3471,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the restore
job to remove.
@@ -3414,8 +3479,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -3434,10 +3497,11 @@ paths:
summary: Cancel One Restore Job of One Cluster
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob
get:
description: "Returns one cloud backup restore job for one cluster from the\
\ specified project. To use this resource, the requesting API Key must have\
- \ the Project Owner role."
+ \ the Project Backup Manager role."
operationId: getBackupRestoreJob
parameters:
- $ref: "#/components/parameters/envelope"
@@ -3450,8 +3514,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the restore
job to return.
@@ -3460,8 +3522,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -3478,6 +3538,9 @@ paths:
summary: Return One Restore Job of One Cluster
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule:
delete:
description: "Removes all cloud backup schedules for the specified cluster.\
@@ -3494,8 +3557,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -3514,6 +3575,7 @@ paths:
summary: Remove All Cloud Backup Schedules
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteAllBackupSchedules
get:
description: "Returns the cloud backup schedule for the specified cluster within\
\ the specified project. This schedule defines when MongoDB Cloud takes scheduled\
@@ -3531,8 +3593,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -3549,6 +3609,7 @@ paths:
summary: Return One Cloud Backup Schedule
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupSchedule
patch:
description: "Updates the cloud backup schedule for one cluster within the specified\
\ project. This schedule defines when MongoDB Cloud takes scheduled snapshots\
@@ -3565,8 +3626,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -3595,11 +3654,14 @@ paths:
summary: Update Cloud Backup Schedule for One Cluster
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateBackupSchedule
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots:
get:
description: "Returns all snapshots of one cluster from the specified project.\
\ To use this resource, the requesting API Key must have the Project Read\
- \ Only role."
+ \ Only role or Project Backup Manager role."
operationId: listReplicaSetBackups
parameters:
- $ref: "#/components/parameters/envelope"
@@ -3614,8 +3676,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -3634,11 +3694,12 @@ paths:
summary: Return All Replica Set Cloud Backups
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listReplicaSetBackups
post:
description: |-
Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot.
- To use this resource, the requesting API Key must have the Project Owner role.
+ To use this resource, the requesting API Key must have the Project Backup Manager role.
operationId: takeSnapshot
parameters:
- $ref: "#/components/parameters/envelope"
@@ -3650,8 +3711,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -3677,11 +3736,14 @@ paths:
summary: Take One On-Demand Snapshot
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeSnapshot
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}:
delete:
description: "Removes one snapshot of one sharded cluster from the specified\
\ project. To use this resource, the requesting API Key must have the Project\
- \ Owner role."
+ \ Backup Manager role."
operationId: deleteShardedClusterBackup
parameters:
- $ref: "#/components/parameters/envelope"
@@ -3693,8 +3755,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -3703,8 +3763,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -3721,10 +3779,11 @@ paths:
summary: Remove One Sharded Cluster Cloud Backup
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteShardedClusterBackup
get:
description: "Returns one snapshot of one sharded cluster from the specified\
\ project. To use this resource, the requesting API Key must have the Project\
- \ Read Only role."
+ \ Read Only role or Project Backup Manager role."
operationId: getShardedClusterBackup
parameters:
- $ref: "#/components/parameters/envelope"
@@ -3736,8 +3795,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -3746,8 +3803,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -3766,11 +3821,14 @@ paths:
summary: Return One Sharded Cluster Cloud Backup
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getShardedClusterBackup
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters:
get:
description: "Returns all snapshots of one sharded cluster from the specified\
\ project. To use this resource, the requesting API Key must have the Project\
- \ Read Only role."
+ \ Read Only role or Project Backup Manager role."
operationId: listShardedClusterBackups
parameters:
- $ref: "#/components/parameters/envelope"
@@ -3782,8 +3840,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -3802,10 +3858,13 @@ paths:
summary: Return All Sharded Cluster Cloud Backups
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listShardedClusterBackups
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}:
delete:
description: "Removes the specified snapshot. To use this resource, the requesting\
- \ API Key must have the Project Owner role."
+ \ API Key must have the Project Backup Manager role."
operationId: deleteReplicaSetBackup
parameters:
- $ref: "#/components/parameters/envelope"
@@ -3817,8 +3876,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -3827,8 +3884,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -3847,9 +3902,11 @@ paths:
summary: Remove One Replica Set Cloud Backup
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteReplicaSetBackup
get:
description: "Returns one snapshot from the specified cluster. To use this resource,\
- \ the requesting API Key must have the Project Read Only role."
+ \ the requesting API Key must have the Project Read Only role or Project Backup\
+ \ Manager role."
operationId: getReplicaSetBackup
parameters:
- $ref: "#/components/parameters/envelope"
@@ -3861,8 +3918,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -3871,8 +3926,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -3891,9 +3944,11 @@ paths:
summary: Return One Replica Set Cloud Backup
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getReplicaSetBackup
patch:
- description: Changes the expiration date for one cloud backup snapshot for one
- cluster in the specified project.
+ description: "Changes the expiration date for one cloud backup snapshot for\
+ \ one cluster in the specified project, the requesting API Key must have the\
+ \ Project Backup Manager role."
operationId: updateSnapshotRetention
parameters:
- $ref: "#/components/parameters/envelope"
@@ -3905,8 +3960,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -3915,8 +3968,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -3943,13 +3994,18 @@ paths:
summary: Change Expiration Date for One Cloud Backup
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateSnapshotRetention
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download:
post:
- description: "Requests one snapshot for the specified shared cluster. This resource\
- \ returns a `snapshotURL` that you can use to download the snapshot. This\
- \ `snapshotURL` remains active for four hours after you make the request.\
- \ To use this resource, the requesting API Key must have the Project Owner\
- \ role."
+ description: |-
+ Requests one snapshot for the specified shared cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role.
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the downloadFlexBackup endpoint instead.
+ externalDocs:
+ description: downloadFlexBackup
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup
operationId: downloadSharedClusterBackup
parameters:
- description: Human-readable label that identifies the cluster.
@@ -3958,8 +4014,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- $ref: "#/components/parameters/envelope"
- $ref: "#/components/parameters/groupId"
@@ -3994,14 +4048,19 @@ paths:
summary: Download One M2 or M5 Cluster Snapshot
tags:
- Shared-Tier Snapshots
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadSharedClusterBackup
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore:
post:
- description: "Restores the specified cluster. MongoDB Cloud limits which clusters\
- \ can be the target clusters of a restore. The target cluster can't use encryption\
- \ at rest, run a major release MongoDB version different than the snapshot,\
- \ or receive client requests during restores. MongoDB Cloud deletes all existing\
- \ data on the target cluster prior to the restore operation. To use this resource,\
- \ the requesting API Key must have the Project Owner role."
+ description: |-
+ Restores the specified M2 or M5 cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role.
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the createFlexBackupRestoreJob endpoint instead.
+ externalDocs:
+ description: createFlexBackupRestoreJob
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob
operationId: createSharedClusterBackupRestoreJob
parameters:
- description: Human-readable label that identifies the cluster.
@@ -4010,8 +4069,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- $ref: "#/components/parameters/envelope"
- $ref: "#/components/parameters/groupId"
@@ -4044,11 +4101,19 @@ paths:
summary: Create One Restore Job from One M2 or M5 Cluster
tags:
- Shared-Tier Restore Jobs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/createSharedClusterBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores:
get:
- description: "Returns all restore jobs for the specified M2 or M5 cluster. Restore\
- \ jobs restore a cluster using a snapshot. To use this resource, the requesting\
- \ API Key must have the Project Read Only role."
+ description: |-
+ Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role.
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the listFlexBackupRestoreJobs endpoint instead.
+ externalDocs:
+ description: listFlexBackupRestoreJobs
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs
operationId: listSharedClusterBackupRestoreJobs
parameters:
- description: Human-readable label that identifies the cluster.
@@ -4057,8 +4122,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- $ref: "#/components/parameters/envelope"
- $ref: "#/components/parameters/groupId"
@@ -4080,10 +4143,18 @@ paths:
summary: Return All Restore Jobs for One M2 or M5 Cluster
tags:
- Shared-Tier Restore Jobs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/listSharedClusterBackupRestoreJobs
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}:
get:
- description: "Returns the specified restore job. To use this resource, the requesting\
- \ API Key must have the Project Read Only role."
+ description: |-
+ Returns the specified restore job for the specified M2 or M5 cluster. To use this resource, the requesting API Key must have the Project Read Only role.
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackupRestoreJob endpoint instead.
+ externalDocs:
+ description: getFlexBackupRestoreJob
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob
operationId: getSharedClusterBackupRestoreJob
parameters:
- description: Human-readable label that identifies the cluster.
@@ -4092,8 +4163,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- $ref: "#/components/parameters/envelope"
- $ref: "#/components/parameters/groupId"
@@ -4105,8 +4174,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -4125,11 +4192,18 @@ paths:
summary: Return One Restore Job for One M2 or M5 Cluster
tags:
- Shared-Tier Restore Jobs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/getSharedClusterBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots:
get:
- description: "Returns details for all snapshots for the specified shared cluster.\
- \ To use this resource, the requesting API Key must have the Project Read\
- \ Only role."
+ description: |-
+ Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role.
+
+ This API also works for Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters, until January 2026, after which this endpoint will be sunset. Please use the listFlexBackups endpoint instead.
+ externalDocs:
+ description: listFlexBackups
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups
operationId: listSharedClusterBackups
parameters:
- $ref: "#/components/parameters/envelope"
@@ -4141,8 +4215,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -4161,11 +4233,18 @@ paths:
summary: Return All Snapshots for One M2 or M5 Cluster
tags:
- Shared-Tier Snapshots
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/listSharedClusterBackups
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}:
get:
- description: "Returns details for one snapshot for the specified shared cluster.\
- \ To use this resource, the requesting API Key must have the Project Read\
- \ Only role."
+ description: |-
+ Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role.
+
+ This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackup endpoint instead.
+ externalDocs:
+ description: getFlexBackup
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup
operationId: getSharedClusterBackup
parameters:
- $ref: "#/components/parameters/envelope"
@@ -4177,8 +4256,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -4187,8 +4264,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -4207,6 +4282,9 @@ paths:
summary: Return One Snapshot for One M2 or M5 Cluster
tags:
- Shared-Tier Snapshots
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/getSharedClusterBackup
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints:
get:
deprecated: true
@@ -4228,8 +4306,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -4246,6 +4322,7 @@ paths:
summary: Return All Legacy Backup Checkpoints
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupCheckpoints
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}:
get:
deprecated: true
@@ -4263,8 +4340,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- description: Human-readable label that identifies the cluster that contains
the checkpoints that you want to return.
@@ -4273,8 +4348,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -4295,6 +4368,7 @@ paths:
summary: Return One Legacy Backup Checkpoint
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupCheckpoint
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned:
get:
description: "Returns a list of given cluster's pinned namespaces, a set of\
@@ -4310,8 +4384,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -4332,6 +4404,7 @@ paths:
summary: Return Pinned Namespaces
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getPinnedNamespaces
patch:
description: Add provided list of namespaces to existing pinned namespaces list
for collection-level latency metrics collection for the given Group and Cluster
@@ -4346,8 +4419,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -4383,6 +4454,7 @@ paths:
summary: Add Pinned Namespaces
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPatch
put:
description: Pin provided list of namespaces for collection-level latency metrics
collection for the given Group and Cluster. This initializes a pinned namespaces
@@ -4398,8 +4470,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -4435,6 +4505,9 @@ paths:
summary: Pin Namespaces
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPut
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin:
patch:
description: Unpin provided list of namespaces for collection-level latency
@@ -4450,8 +4523,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -4480,6 +4551,10 @@ paths:
summary: Unpin namespaces
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinNamespaces
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes:
post:
deprecated: true
@@ -4503,8 +4578,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -4533,6 +4606,9 @@ paths:
tags:
- Atlas Search
x-sunset: 2025-06-01
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndexDeprecated
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}:
get:
deprecated: true
@@ -4555,8 +4631,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Name of the collection that contains one or more Atlas Search
indexes.
@@ -4590,6 +4664,9 @@ paths:
tags:
- Atlas Search
x-sunset: 2025-06-01
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesDeprecated
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}:
delete:
deprecated: true
@@ -4611,8 +4688,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: "Unique 24-hexadecimal digit string that identifies the Atlas\
\ Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\
@@ -4622,8 +4697,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -4643,6 +4716,7 @@ paths:
tags:
- Atlas Search
x-sunset: 2025-06-01
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexDeprecated
get:
deprecated: true
description: "Returns one Atlas Search index in the specified project. You identify\
@@ -4664,8 +4738,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: "Unique 24-hexadecimal digit string that identifies the Application\
\ Search [index](https://dochub.mongodb.org/core/index-definitions-fts).\
@@ -4676,8 +4748,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -4695,6 +4765,7 @@ paths:
tags:
- Atlas Search
x-sunset: 2025-06-01
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexDeprecated
patch:
deprecated: true
description: "Updates one Atlas Search index that you identified with its unique\
@@ -4716,8 +4787,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: "Unique 24-hexadecimal digit string that identifies the Atlas\
\ Search [index](https://dochub.mongodb.org/core/index-definitions-fts).\
@@ -4728,8 +4797,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -4758,6 +4825,9 @@ paths:
tags:
- Atlas Search
x-sunset: 2025-06-01
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexDeprecated
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites:
get:
description: "Returns one managed namespace within the specified global cluster.\
@@ -4779,8 +4849,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -4797,6 +4865,7 @@ paths:
summary: Return One Managed Namespace in One Global Cluster
tags:
- Global Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/getManagedNamespace
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping:
delete:
description: "Removes all custom zone mappings for the specified global cluster.\
@@ -4819,8 +4888,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -4837,6 +4904,7 @@ paths:
summary: Remove All Custom Zone Mappings from One Global Cluster
tags:
- Global Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteAllCustomZoneMappings
post:
description: "Creates one custom zone mapping for the specified global cluster.\
\ A custom zone mapping matches one ISO 3166-2 location code to a zone in\
@@ -4858,8 +4926,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -4886,6 +4952,10 @@ paths:
summary: Add One Entry to One Custom Zone Mapping
tags:
- Global Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createCustomZoneMapping
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces:
delete:
description: "Removes one managed namespace within the specified global cluster.\
@@ -4907,8 +4977,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- $ref: "#/components/parameters/groupId"
- description: Human-readable label that identifies the database that contains
@@ -4940,6 +5008,7 @@ paths:
summary: Remove One Managed Namespace from One Global Cluster
tags:
- Global Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteManagedNamespace
post:
description: "Creates one managed namespace within the specified global cluster.\
\ A managed namespace identifies a collection using the database name, the\
@@ -4960,8 +5029,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -4990,6 +5057,10 @@ paths:
summary: Create One Managed Namespace in One Global Cluster
tags:
- Global Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createManagedNamespace
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index:
post:
description: "Creates an index on the cluster identified by its name in a rolling\
@@ -5013,8 +5084,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -5103,6 +5172,9 @@ paths:
summary: Create One Rolling Index
tags:
- Rolling Index
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createRollingIndex
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives:
get:
description: "Returns details of all online archives. This archive stores data\
@@ -5126,8 +5198,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -5144,6 +5214,7 @@ paths:
summary: Return All Online Archives for One Cluster
tags:
- Online Archive
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listOnlineArchives
post:
description: "Creates one online archive. This archive stores data from one\
\ cluster within one project. To use this resource, the requesting API Key\
@@ -5163,8 +5234,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -5197,6 +5266,7 @@ paths:
x-xgen-changelog:
"2023-08-02": "If 'criteria':'DATE' is specified, then you must specify 'DATE'\
\ values in partition fields"
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createOnlineArchive
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz:
get:
description: "Downloads query logs for the specified online archive. To use\
@@ -5239,8 +5309,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Flag that indicates whether to download logs for queries against
your online archive only or both your online archive and cluster.
@@ -5274,6 +5342,9 @@ paths:
summary: Download Online Archive Query Logs
tags:
- Online Archive
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}:
delete:
description: "Removes one online archive. This archive stores data from one\
@@ -5294,8 +5365,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- description: Human-readable label that identifies the cluster that contains
the collection from which you want to remove an online archive.
@@ -5304,8 +5373,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"204":
@@ -5324,6 +5391,7 @@ paths:
summary: Remove One Online Archive
tags:
- Online Archive
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteOnlineArchive
get:
description: "Returns one online archive for one cluster. This archive stores\
\ data from one cluster within one project. To use this resource, the requesting\
@@ -5343,8 +5411,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- description: Human-readable label that identifies the cluster that contains
the specified collection from which Application created the online archive.
@@ -5353,8 +5419,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -5375,6 +5439,7 @@ paths:
summary: Return One Online Archive
tags:
- Online Archive
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/getOnlineArchive
patch:
description: "Updates, pauses, or resumes one online archive. This archive stores\
\ data from one cluster within one project. To use this resource, the requesting\
@@ -5394,8 +5459,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- description: Human-readable label that identifies the cluster that contains
the specified collection from which Application created the online archive.
@@ -5404,8 +5467,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -5435,6 +5496,7 @@ paths:
summary: Update One Online Archive
tags:
- Online Archive
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/updateOnlineArchive
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation:
delete:
description: Ends a cluster outage simulation.
@@ -5453,8 +5515,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -5475,6 +5535,7 @@ paths:
summary: End an Outage Simulation
tags:
- Cluster Outage Simulation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endOutageSimulation
get:
description: Returns one outage simulation for one cluster.
externalDocs:
@@ -5492,8 +5553,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -5514,6 +5573,7 @@ paths:
summary: Return One Outage Simulation
tags:
- Cluster Outage Simulation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getOutageSimulation
post:
description: Starts a cluster outage simulation.
externalDocs:
@@ -5531,8 +5591,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -5558,6 +5616,82 @@ paths:
summary: Start an Outage Simulation
tags:
- Cluster Outage Simulation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startOutageSimulation
+ x-xgen-IPA-exception:
+ xgen-IPA-113-singleton-must-not-have-id: API predates IPA validation
+ /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions:
+ get:
+ description: "Returns the indexes that the Performance Advisor suggests to drop.\
+ \ The Performance Advisor suggests dropping unused, redundant, and hidden\
+ \ indexes to improve write performance and increase storage space. To use\
+ \ this resource, the requesting API Key must have the Project Read Only role."
+ operationId: listDropIndexes
+ parameters:
+ - $ref: "#/components/parameters/groupId"
+ - description: Human-readable label that identifies the cluster.
+ in: path
+ name: clusterName
+ required: true
+ schema:
+ type: string
+ pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2024-08-05+json:
+ schema:
+ $ref: "#/components/schemas/DropIndexSuggestionsResponse"
+ x-xgen-version: 2024-08-05
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Returns Suggested Indexes to Drop
+ tags:
+ - Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listDropIndexes
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice:
+ get:
+ description: "Returns the schema suggestions that the Performance Advisor detects.\
+ \ The Performance Advisor provides holistic schema recommendations for your\
+ \ cluster by sampling documents in your most active collections and collections\
+ \ with slow-running queries. To use this resource, the requesting API Key\
+ \ must have the Project Read Only role."
+ operationId: listSchemaAdvice
+ parameters:
+ - $ref: "#/components/parameters/groupId"
+ - description: Human-readable label that identifies the cluster.
+ in: path
+ name: clusterName
+ required: true
+ schema:
+ type: string
+ pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2024-08-05+json:
+ schema:
+ $ref: "#/components/schemas/SchemaAdvisorResponse"
+ x-xgen-version: 2024-08-05
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Return Schema Advice
+ tags:
+ - Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSchemaAdvice
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes:
get:
description: "Returns the indexes that the Performance Advisor suggests. The\
@@ -5573,8 +5707,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: "ProcessIds from which to retrieve suggested indexes. A processId\
\ is a combination of host and port that serves the MongoDB process. The\
@@ -5643,6 +5775,9 @@ paths:
summary: Return Suggested Indexes
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listClusterSuggestedIndexes
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs:
get:
description: "Returns the advanced configuration details for one cluster in\
@@ -5666,8 +5801,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -5686,6 +5819,7 @@ paths:
summary: Return One Advanced Configuration Options for One Cluster
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterAdvancedConfiguration
patch:
description: "Updates the advanced configuration details for one cluster in\
\ the specified project. Clusters contain a group of hosts that maintain the\
@@ -5708,8 +5842,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -5739,6 +5871,7 @@ paths:
summary: Update Advanced Configuration Options for One Cluster
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateClusterAdvancedConfiguration
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries:
post:
description: "Starts a failover test for the specified cluster in the specified\
@@ -5758,8 +5891,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -5774,6 +5905,9 @@ paths:
summary: Test Failover for One Cluster
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/testFailover
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs:
get:
deprecated: true
@@ -5799,8 +5933,6 @@ paths:
name: batchId
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- description: Human-readable label that identifies the cluster with the snapshot
you want to return.
@@ -5809,8 +5941,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -5829,6 +5959,7 @@ paths:
summary: Return All Legacy Backup Restore Jobs
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupRestoreJobs
post:
deprecated: true
description: "Restores one legacy backup for one cluster in the specified project.\
@@ -5857,8 +5988,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -5884,6 +6013,7 @@ paths:
summary: Create One Legacy Backup Restore Job
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/createLegacyBackupRestoreJob
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}:
get:
deprecated: true
@@ -5903,8 +6033,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the restore
job.
@@ -5913,8 +6041,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -5933,6 +6059,7 @@ paths:
summary: Return One Legacy Backup Restore Job
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupRestoreJob
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment:
delete:
description: Deletes the Search Nodes for the specified cluster.
@@ -5947,8 +6074,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"204":
@@ -5969,6 +6094,7 @@ paths:
summary: Delete Search Nodes
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchDeployment
get:
description: "Return the Search Nodes for the specified cluster. Deprecated\
\ versions: v2-{2023-01-01}"
@@ -5984,8 +6110,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -6004,6 +6128,7 @@ paths:
summary: Return Search Nodes
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchDeployment
patch:
description: "Updates the Search Nodes for the specified cluster. Deprecated\
\ versions: v2-{2023-01-01}"
@@ -6019,8 +6144,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -6048,6 +6171,7 @@ paths:
summary: Update Search Nodes
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchDeployment
post:
description: Creates Search Nodes for the specified cluster.
operationId: createAtlasSearchDeployment
@@ -6061,8 +6185,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -6090,6 +6212,10 @@ paths:
summary: Create Search Nodes
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchDeployment
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-113-singleton-must-not-have-id: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes:
get:
description: "Returns all Atlas Search indexes on the specified cluster. Atlas\
@@ -6111,8 +6237,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -6139,6 +6263,7 @@ paths:
summary: Return All Atlas Search Indexes for One Cluster
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesCluster
post:
description: "Creates one Atlas Search index on the specified collection. Atlas\
\ Search indexes define the fields on which to create the index and the analyzers\
@@ -6160,8 +6285,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -6189,6 +6312,9 @@ paths:
summary: Create One Atlas Search Index
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndex
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}:
get:
description: "Returns all Atlas Search indexes on the specified collection.\
@@ -6210,8 +6336,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Name of the collection that contains one or more Atlas Search
indexes.
@@ -6252,6 +6376,9 @@ paths:
summary: Return All Atlas Search Indexes for One Collection
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexes
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}:
delete:
description: "Removes one Atlas Search index that you identified with its database,\
@@ -6272,8 +6399,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Name of the collection that contains one or more Atlas Search
indexes.
@@ -6312,6 +6437,7 @@ paths:
summary: Remove One Atlas Search Index by Name
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexByName
get:
description: "Returns one Atlas Search index in the specified project. You identify\
\ this index using its database, collection and name. Atlas Search index contains\
@@ -6333,8 +6459,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Name of the collection that contains one or more Atlas Search
indexes.
@@ -6373,6 +6497,7 @@ paths:
summary: Return One Atlas Search Index by Name
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexByName
patch:
description: "Updates one Atlas Search index that you identified with its database,\
\ collection name, and index name. Atlas Search indexes define the fields\
@@ -6394,8 +6519,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Name of the collection that contains one or more Atlas Search
indexes.
@@ -6443,6 +6566,9 @@ paths:
summary: Update One Atlas Search Index By Name
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}:
delete:
description: "Removes one Atlas Search index that you identified with its unique\
@@ -6463,8 +6589,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: "Unique 24-hexadecimal digit string that identifies the Atlas\
\ Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\
@@ -6474,8 +6598,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -6494,6 +6616,7 @@ paths:
summary: Remove One Atlas Search Index by Id
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndex
get:
description: "Returns one Atlas Search index in the specified project. You identify\
\ this index using its unique ID. Atlas Search index contains the indexed\
@@ -6514,8 +6637,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: "Unique 24-hexadecimal digit string that identifies the Application\
\ Search [index](https://dochub.mongodb.org/core/index-definitions-fts).\
@@ -6526,8 +6647,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -6552,6 +6671,7 @@ paths:
summary: Return One Atlas Search Index by ID
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndex
patch:
description: "Updates one Atlas Search index that you identified with its unique\
\ ID. Atlas Search indexes define the fields on which to create the index\
@@ -6572,8 +6692,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: "Unique 24-hexadecimal digit string that identifies the Atlas\
\ Search [index](https://dochub.mongodb.org/core/index-definitions-fts).\
@@ -6584,8 +6702,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -6613,6 +6729,9 @@ paths:
summary: Update One Atlas Search Index By ID
tags:
- Atlas Search
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndex
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule:
get:
deprecated: true
@@ -6632,8 +6751,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -6650,6 +6767,7 @@ paths:
summary: Return One Snapshot Schedule
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshotSchedule
patch:
deprecated: true
description: |-
@@ -6668,8 +6786,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -6694,6 +6810,7 @@ paths:
summary: Update Snapshot Schedule for One Cluster
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotSchedule
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots:
get:
deprecated: true
@@ -6720,8 +6837,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: "Human-readable label that specifies whether to return only completed,\
\ incomplete, or all snapshots. By default, MongoDB Cloud only returns completed\
@@ -6735,6 +6850,9 @@ paths:
- all
- "true"
- "false"
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
responses:
"200":
content:
@@ -6750,6 +6868,7 @@ paths:
summary: Return All Legacy Backup Snapshots
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacySnapshots
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}:
delete:
deprecated: true
@@ -6773,8 +6892,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -6783,8 +6900,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -6803,6 +6918,7 @@ paths:
summary: Remove One Legacy Backup Snapshot
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/deleteLegacySnapshot
get:
deprecated: true
description: "Returns one legacy backup snapshot for one cluster in the specified\
@@ -6825,8 +6941,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -6835,8 +6949,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -6853,6 +6965,7 @@ paths:
summary: Return One Legacy Backup Snapshot
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshot
patch:
deprecated: true
description: "Changes the expiration date for one legacy backup snapshot for\
@@ -6876,8 +6989,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -6886,8 +6997,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -6911,6 +7020,7 @@ paths:
summary: Change One Legacy Backup Snapshot Expiration
tags:
- Legacy Backup
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotRetention
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status:
get:
description: "Returns the status of all changes that you made to the specified\
@@ -6929,8 +7039,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -6947,6 +7055,7 @@ paths:
summary: Return Status of All Cluster Operations
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterStatus
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces:
get:
description: Return the subset of namespaces from the given cluster sorted by
@@ -6961,8 +7070,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Human-readable label that identifies the cluster topology to
retrieve metrics for.
@@ -6994,6 +7101,9 @@ paths:
summary: Return Ranked Namespaces from a Cluster
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForCluster
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements:
get:
description: Get a list of the Coll Stats Latency cluster-level measurements
@@ -7008,8 +7118,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Human-readable label that identifies the cluster topology to
retrieve metrics for.
@@ -7085,6 +7193,9 @@ paths:
summary: Return Cluster-Level Query Latency
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceClusterMeasurements
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess:
post:
description: Grants MongoDB employee cluster access for the given duration and
@@ -7100,8 +7211,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -7132,6 +7241,9 @@ paths:
summary: Grant MongoDB employee cluster access for one cluster.
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/grantMongoDbEmployeeAccess
+ x-xgen-IPA-exception:
+ xgen-IPA-109-custom-method-must-use-camel-case: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion:
post:
description: "Pins the Feature Compatibility Version (FCV) to the current MongoDB\
@@ -7149,8 +7261,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -7180,6 +7290,7 @@ paths:
summary: Pin FCV for One Cluster from One Project
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinFeatureCompatibilityVersion
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess:
post:
description: Revokes a previously granted MongoDB employee cluster access.
@@ -7194,8 +7305,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"204":
@@ -7218,6 +7327,9 @@ paths:
summary: Revoke granted MongoDB employee cluster access for one cluster.
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/revokeMongoDbEmployeeAccess
+ x-xgen-IPA-exception:
+ xgen-IPA-109-custom-method-must-use-camel-case: API predates IPA validation
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion:
post:
description: Unpins the current fixed Feature Compatibility Version (FCV). This
@@ -7233,8 +7345,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"204":
@@ -7259,6 +7369,7 @@ paths:
summary: Unpins FCV for One Cluster from One Project
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/unpinFeatureCompatibilityVersion
/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz:
get:
description: "Returns a compressed (.gz) log file that contains a range of log\
@@ -7302,6 +7413,9 @@ paths:
externalDocs:
description: Set up Database Auditing
url: https://docs.atlas.mongodb.com/database-auditing/
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
- description: "Specifies the date and time for the ending point of the range\
\ of log messages to retrieve, in the number of seconds that have elapsed\
\ since the UNIX epoch. This value will default to 24 hours after the start\
@@ -7350,6 +7464,9 @@ paths:
summary: Download Logs for One Cluster Host in One Project
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostLogs
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/collStats/metrics:
get:
description: Returns all available Coll Stats Latency metric names and their
@@ -7377,6 +7494,9 @@ paths:
summary: Return all metric names
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceMetrics
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/containers:
get:
description: "Returns details about all network peering containers in the specified\
@@ -7422,6 +7542,7 @@ paths:
Provider
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainerByCloudProvider
post:
description: "Creates one new network peering container in the specified project.\
\ MongoDB Cloud can deploy Network Peering connections in a network peering\
@@ -7463,6 +7584,7 @@ paths:
summary: Create One New Network Peering Container
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringContainer
/api/atlas/v2/groups/{groupId}/containers/all:
get:
description: "Returns details about all network peering containers in the specified\
@@ -7492,6 +7614,9 @@ paths:
summary: Return All Network Peering Containers in One Project
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainers
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/containers/{containerId}:
delete:
description: "Removes one network peering container in the specified project.\
@@ -7510,8 +7635,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -7534,6 +7657,7 @@ paths:
summary: Remove One Network Peering Container
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringContainer
get:
description: "Returns details about one network peering container in one specified\
\ project. Network peering containers contain network peering connections.\
@@ -7552,8 +7676,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -7570,6 +7692,7 @@ paths:
summary: Return One Network Peering Container
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringContainer
patch:
description: "Updates the network details and labels of one specified network\
\ peering container in the specified project. To use this resource, the requesting\
@@ -7587,8 +7710,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -7621,6 +7742,7 @@ paths:
summary: Update One Network Peering Container
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringContainer
/api/atlas/v2/groups/{groupId}/customDBRoles/roles:
get:
description: "Returns all custom roles for the specified project. To use this\
@@ -7647,9 +7769,11 @@ paths:
summary: Return All Custom Roles in One Project
tags:
- Custom Database Roles
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/listCustomDatabaseRoles
post:
description: "Creates one custom role in the specified project. To use this\
- \ resource, the requesting API Key must have the Project Owner role."
+ \ resource, the requesting API Key must have the Project Owner role, Project\
+ \ Stream Processing Owner role, or the Project Database Access Admin role."
operationId: createCustomDatabaseRole
parameters:
- $ref: "#/components/parameters/envelope"
@@ -7685,13 +7809,17 @@ paths:
summary: Create One Custom Role
tags:
- Custom Database Roles
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/createCustomDatabaseRole
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}:
delete:
description: "Removes one custom role from the specified project. You can't\
\ remove a custom role that would leave one or more child roles with no parent\
\ roles or actions. You also can't remove a custom role that would leave one\
\ or more database users without roles. To use this resource, the requesting\
- \ API Key must have the Project Atlas Admin role."
+ \ API Key must have the Project Owner role, Project Stream Processing Owner\
+ \ role, or the Project Database Access Admin role."
operationId: deleteCustomDatabaseRole
parameters:
- $ref: "#/components/parameters/envelope"
@@ -7723,6 +7851,7 @@ paths:
summary: Remove One Custom Role from One Project
tags:
- Custom Database Roles
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/deleteCustomDatabaseRole
get:
description: "Returns one custom role for the specified project. To use this\
\ resource, the requesting API Key must have the Project Read Only role."
@@ -7755,9 +7884,11 @@ paths:
summary: Return One Custom Role in One Project
tags:
- Custom Database Roles
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/getCustomDatabaseRole
patch:
description: "Updates one custom role in the specified project. To use this\
- \ resource, the requesting API Key must have the Project Owner role."
+ \ resource, the requesting API Key must have the Project Owner role, the Project\
+ \ Stream Processing Owner role, or the Project Database Access Admin role."
operationId: updateCustomDatabaseRole
parameters:
- $ref: "#/components/parameters/envelope"
@@ -7800,6 +7931,9 @@ paths:
summary: Update One Custom Role in One Project
tags:
- Custom Database Roles
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/updateCustomDatabaseRole
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/dataFederation:
get:
description: "Returns the details of all federated database instances in the\
@@ -7836,6 +7970,7 @@ paths:
summary: Return All Federated Database Instances in One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listFederatedDatabases
post:
description: "Creates one federated database instance in the specified project.\
\ To use this resource, the requesting API Key must have the Project Owner\
@@ -7877,6 +8012,7 @@ paths:
summary: Create One Federated Database Instance in One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createFederatedDatabase
/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}:
delete:
description: "Removes one federated database instance from the specified project.\
@@ -7909,6 +8045,7 @@ paths:
summary: Remove One Federated Database Instance from One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteFederatedDatabase
get:
description: "Returns the details of one federated database instance within\
\ the specified project. To use this resource, the requesting API Key must\
@@ -7943,6 +8080,7 @@ paths:
summary: Return One Federated Database Instance in One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getFederatedDatabase
patch:
description: "Updates the details of one federated database instance in the\
\ specified project. To use this resource, the requesting API Key must have\
@@ -7993,6 +8131,7 @@ paths:
summary: Update One Federated Database Instance in One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/updateFederatedDatabase
/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits:
get:
description: "Returns query limits for a federated databases instance in the\
@@ -8029,6 +8168,7 @@ paths:
summary: Return All Query Limits for One Federated Database Instance
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimits
/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}:
delete:
description: "Deletes one query limit for one federated database instance. To\
@@ -8063,6 +8203,9 @@ paths:
- bytesProcessed.daily
- bytesProcessed.weekly
- bytesProcessed.monthly
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
responses:
"204":
content:
@@ -8078,6 +8221,7 @@ paths:
summary: Delete One Query Limit For One Federated Database Instance
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteOneDataFederationInstanceQueryLimit
get:
description: "Returns the details of one query limit for the specified federated\
\ database instance in the specified project. To use this resource, the requesting\
@@ -8113,6 +8257,9 @@ paths:
- bytesProcessed.daily
- bytesProcessed.weekly
- bytesProcessed.monthly
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
responses:
"200":
content:
@@ -8128,6 +8275,7 @@ paths:
summary: Return One Federated Database Instance Query Limit for One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimit
patch:
description: "Creates or updates one query limit for one federated database\
\ instance. To use this resource, the requesting API Key must have the Project\
@@ -8162,6 +8310,9 @@ paths:
- bytesProcessed.daily
- bytesProcessed.weekly
- bytesProcessed.monthly
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
requestBody:
content:
application/vnd.atlas.2023-01-01+json:
@@ -8189,6 +8340,7 @@ paths:
summary: Configure One Query Limit for One Federated Database Instance
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createOneDataFederationQueryLimit
/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz:
get:
description: "Downloads the query logs for the specified federated database\
@@ -8252,6 +8404,7 @@ paths:
summary: Download Query Logs for One Federated Database Instance
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs
/api/atlas/v2/groups/{groupId}/databaseUsers:
get:
description: "Returns all database users that belong to the specified project.\
@@ -8280,12 +8433,14 @@ paths:
summary: Return All Database Users from One Project
tags:
- Database Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/listDatabaseUsers
post:
description: "Creates one database user in the specified project. This MongoDB\
\ Cloud supports a maximum of 100 database users per project. If you require\
\ more than 100 database users on a project, contact [Support](https://cloud.mongodb.com/support).\
\ To use this resource, the requesting API Key must have the Project Owner\
- \ or Project Charts Admin roles."
+ \ role, the Project Charts Admin role, Project Stream Processing Owner role,\
+ \ or the Project Database Access Admin role."
operationId: createDatabaseUser
parameters:
- $ref: "#/components/parameters/envelope"
@@ -8412,10 +8567,12 @@ paths:
summary: Create One Database User in One Project
tags:
- Database Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createDatabaseUser
/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}:
delete:
description: "Removes one database user from the specified project. To use this\
- \ resource, the requesting API Key must have the Project Owner role."
+ \ resource, the requesting API Key must have the Project Owner role, the Project\
+ \ Stream Processing Owner role, or the Project Database Access Admin role."
operationId: deleteDatabaseUser
parameters:
- $ref: "#/components/parameters/envelope"
@@ -8472,6 +8629,7 @@ paths:
summary: Remove One Database User from One Project
tags:
- Database Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/deleteDatabaseUser
get:
description: "Returns one database user that belong to the specified project.\
\ To use this resource, the requesting API Key must have the Project Read\
@@ -8530,10 +8688,12 @@ paths:
summary: Return One Database User from One Project
tags:
- Database Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getDatabaseUser
patch:
description: "Updates one database user that belongs to the specified project.\
\ To use this resource, the requesting API Key must have the Project Owner\
- \ or Project Charts Admin roles."
+ \ role, Project Charts Admin role, Project Stream Processing Owner role, or\
+ \ the Project Database Access Admin role."
operationId: updateDatabaseUser
parameters:
- $ref: "#/components/parameters/envelope"
@@ -8601,6 +8761,9 @@ paths:
summary: Update One Database User in One Project
tags:
- Database Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/updateDatabaseUser
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs:
get:
description: "Returns all unexpired X.509 certificates for the specified MongoDB\
@@ -8639,6 +8802,7 @@ paths:
summary: Return All X.509 Certificates Assigned to One MongoDB User
tags:
- X.509 Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/listDatabaseUserCertificates
post:
description: |-
Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Owner role.
@@ -8694,13 +8858,14 @@ paths:
summary: Create One X.509 Certificate for One MongoDB User
tags:
- X.509 Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/createDatabaseUserCertificate
/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}:
get:
description: "Returns the access logs of one cluster identified by the cluster's\
\ name. Access logs contain a list of authentication requests made against\
\ your cluster. You can't use this feature on tenant-tier clusters (M0, M2,\
\ M5). To use this resource, the requesting API Key must have the Project\
- \ Monitoring Admin role."
+ \ Monitoring Admin role or the Project Database Access Admin role."
externalDocs:
description: Database Access History
url: https://docs.atlas.mongodb.com/access-tracking/
@@ -8721,8 +8886,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: "Date and time when to stop retrieving database history. If you\
\ specify **end**, you must also specify **start**. This parameter uses\
@@ -8773,13 +8936,16 @@ paths:
summary: Return Database Access History for One Cluster using Its Cluster Name
tags:
- Access Tracking
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}:
get:
description: "Returns the access logs of one cluster identified by the cluster's\
\ hostname. Access logs contain a list of authentication requests made against\
\ your clusters. You can't use this feature on tenant-tier clusters (M0, M2,\
\ M5). To use this resource, the requesting API Key must have the Project\
- \ Monitoring Admin role."
+ \ Monitoring Admin role or the Project Database Access Admin role."
externalDocs:
description: Database Access History
url: https://docs.atlas.mongodb.com/access-tracking/
@@ -8850,6 +9016,9 @@ paths:
summary: Return Database Access History for One Cluster using Its Hostname
tags:
- Access Tracking
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/encryptionAtRest:
get:
description: |-
@@ -8877,6 +9046,7 @@ paths:
Keys for One Project
tags:
- Encryption at Rest using Customer Key Management
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRest
patch:
description: |-
Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters.
@@ -8925,6 +9095,7 @@ paths:
Keys for One Project
tags:
- Encryption at Rest using Customer Key Management
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/updateEncryptionAtRest
/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints:
get:
description: Returns the private endpoints of the specified cloud provider for
@@ -8946,6 +9117,7 @@ paths:
type: string
enum:
- AZURE
+ - AWS
responses:
"200":
content:
@@ -8962,6 +9134,7 @@ paths:
Using Customer Key Management for One Project
tags:
- Encryption at Rest using Customer Key Management
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpointsForCloudProvider
post:
description: Creates a private endpoint in the specified region for encryption
at rest using customer key management.
@@ -8979,6 +9152,7 @@ paths:
type: string
enum:
- AZURE
+ - AWS
requestBody:
content:
application/vnd.atlas.2023-01-01+json:
@@ -9002,6 +9176,7 @@ paths:
Rest Using Customer Key Management
tags:
- Encryption at Rest using Customer Key Management
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/createEncryptionAtRestPrivateEndpoint
/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}:
delete:
description: "Deletes one private endpoint, identified by its ID, for encryption\
@@ -9020,6 +9195,7 @@ paths:
type: string
enum:
- AZURE
+ - AWS
- description: Unique 24-hexadecimal digit string that identifies the private
endpoint to delete.
in: path
@@ -9027,8 +9203,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -9045,6 +9219,7 @@ paths:
summary: Delete Private Endpoint for Encryption at Rest Using Customer Key Management
tags:
- Encryption at Rest using Customer Key Management
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestEncryptionAtRestPrivateEndpointDeletion
get:
description: "Returns one private endpoint, identified by its ID, for encryption\
\ at rest using Customer Key Management."
@@ -9062,6 +9237,7 @@ paths:
type: string
enum:
- AZURE
+ - AWS
- description: Unique 24-hexadecimal digit string that identifies the private
endpoint.
in: path
@@ -9069,8 +9245,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -9090,6 +9264,7 @@ paths:
Management
tags:
- Encryption at Rest using Customer Key Management
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpoint
/api/atlas/v2/groups/{groupId}/events:
get:
description: |-
@@ -9111,8 +9286,6 @@ paths:
type: array
items:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
style: form
- description: |-
@@ -9144,23 +9317,25 @@ paths:
type: boolean
default: false
- description: Date and time from when MongoDB Cloud stops returning events.
- This parameter uses the ISO 8601 timestamp format
- in UTC.
+ This parameter uses the ISO 8601 timestamp format in UTC.
in: query
name: maxDate
schema:
type: string
format: date-time
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
- description: Date and time from when MongoDB Cloud starts returning events.
- This parameter uses the ISO 8601 timestamp format
- in UTC.
+ This parameter uses the ISO 8601 timestamp format in UTC.
in: query
name: minDate
schema:
type: string
format: date-time
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
responses:
"200":
content:
@@ -9178,6 +9353,7 @@ paths:
summary: Return All Events from One Project
tags:
- Events
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents
/api/atlas/v2/groups/{groupId}/events/{eventId}:
get:
description: |-
@@ -9197,8 +9373,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- description: Flag that indicates whether to include the raw document in the
output. The raw document contains additional meta information about the
@@ -9225,6 +9399,7 @@ paths:
summary: Return One Event from One Project
tags:
- Events
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getProjectEvent
/api/atlas/v2/groups/{groupId}/flexClusters:
get:
description: "Returns details for all flex clusters in the specified project.\
@@ -9253,6 +9428,7 @@ paths:
summary: Return All Flex Clusters from One Project
tags:
- Flex Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters
post:
description: "Creates one flex cluster in the specified project. To use this\
\ resource, the requesting API Key must have the Project Owner role."
@@ -9287,6 +9463,7 @@ paths:
summary: Create One Flex Cluster in One Project
tags:
- Flex Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster
/api/atlas/v2/groups/{groupId}/flexClusters/{name}:
delete:
description: "Removes one flex cluster from the specified project. The flex\
@@ -9304,8 +9481,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"204":
@@ -9326,6 +9501,7 @@ paths:
summary: Remove One Flex Cluster from One Project
tags:
- Flex Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster
get:
description: "Returns details for one flex cluster in the specified project.\
\ To use this resource, the requesting API Key must have the Project Read\
@@ -9341,8 +9517,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -9363,6 +9537,7 @@ paths:
summary: Return One Flex Cluster from One Project
tags:
- Flex Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster
patch:
description: "Updates one flex cluster in the specified project. To use this\
\ resource, the requesting API Key must have the Project Owner role."
@@ -9377,8 +9552,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -9404,6 +9577,7 @@ paths:
summary: Update One Flex Cluster in One Project
tags:
- Flex Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster
/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download:
post:
description: "Requests one snapshot for the specified flex cluster. This resource\
@@ -9419,8 +9593,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- $ref: "#/components/parameters/envelope"
- $ref: "#/components/parameters/groupId"
@@ -9455,6 +9627,10 @@ paths:
summary: Download One Flex Cluster Snapshot
tags:
- Flex Snapshots
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs:
get:
description: "Returns all restore jobs for one flex cluster from the specified\
@@ -9474,8 +9650,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -9494,6 +9668,7 @@ paths:
summary: Return All Restore Jobs for One Flex Cluster
tags:
- Flex Restore Jobs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs
post:
description: "Restores one snapshot of one flex cluster from the specified project.\
\ To use this resource, the requesting API Key must have the Project Owner\
@@ -9510,8 +9685,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -9542,6 +9715,9 @@ paths:
summary: Restore One Snapshot of One Flex Cluster
tags:
- Flex Restore Jobs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}:
get:
description: "Returns one restore job for one flex cluster from the specified\
@@ -9558,8 +9734,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the restore
job to return.
@@ -9568,8 +9742,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -9588,6 +9760,9 @@ paths:
summary: Return One Restore Job for One Flex Cluster
tags:
- Flex Restore Jobs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots:
get:
description: "Returns all snapshots of one flex cluster from the specified project.\
@@ -9607,8 +9782,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -9627,6 +9800,9 @@ paths:
summary: Return All Snapshots of One Flex Cluster
tags:
- Flex Snapshots
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}:
get:
description: "Returns one snapshot of one flex cluster from the specified project.\
@@ -9642,8 +9818,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -9653,8 +9827,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -9673,6 +9845,9 @@ paths:
summary: Return One Snapshot of One Flex Cluster
tags:
- Flex Snapshots
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade:
post:
description: "Upgrades a flex cluster to a dedicated cluster (M10+) in the specified\
@@ -9713,6 +9888,7 @@ paths:
summary: Upgrade One Flex Cluster
tags:
- Flex Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster
/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics:
get:
description: Returns all Atlas Search metric types available for one process
@@ -9740,6 +9916,9 @@ paths:
summary: Return All Atlas Search Metric Types for One Process
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listMetricTypes
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements:
get:
description: Returns the Atlas Search index metrics within the specified time
@@ -9797,6 +9976,9 @@ paths:
summary: Return All Atlas Search Index Metrics for One Namespace
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listIndexMetrics
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements:
get:
description: Returns the Atlas Search metrics data series within the provided
@@ -9857,6 +10039,9 @@ paths:
summary: Return Atlas Search Metrics for One Index in One Specified Namespace
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getIndexMetrics
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements:
get:
description: Returns the Atlas Search hardware and status data series within
@@ -9919,6 +10104,9 @@ paths:
summary: Return Atlas Search Hardware and Status Metrics
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getMeasurements
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/integrations:
get:
description: "Returns the settings that permit integrations with all configured\
@@ -9952,6 +10140,7 @@ paths:
summary: Return All Active Third-Party Service Integrations
tags:
- Third-Party Integrations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/listThirdPartyIntegrations
/api/atlas/v2/groups/{groupId}/integrations/{integrationType}:
delete:
description: "Removes the settings that permit configuring one third-party service\
@@ -10004,6 +10193,7 @@ paths:
summary: Remove One Third-Party Service Integration
tags:
- Third-Party Integrations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/deleteThirdPartyIntegration
get:
description: "Returns the settings for configuring integration with one third-party\
\ service. These settings apply to all databases managed in one MongoDB Cloud\
@@ -10052,6 +10242,7 @@ paths:
summary: Return One Third-Party Service Integration
tags:
- Third-Party Integrations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/getThirdPartyIntegration
post:
description: "Adds the settings for configuring one third-party service integration.\
\ These settings apply to all databases managed in the specified MongoDB Cloud\
@@ -10113,6 +10304,7 @@ paths:
summary: Configure One Third-Party Service Integration
tags:
- Third-Party Integrations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/createThirdPartyIntegration
put:
description: "Updates the settings for configuring integration with one third-party\
\ service. These settings apply to all databases managed in one MongoDB Cloud\
@@ -10171,6 +10363,7 @@ paths:
summary: Update One Third-Party Service Integration
tags:
- Third-Party Integrations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/updateThirdPartyIntegration
/api/atlas/v2/groups/{groupId}/invites:
get:
deprecated: true
@@ -10205,6 +10398,7 @@ paths:
tags:
- Projects
x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectInvitations
patch:
deprecated: true
description: "Updates the details of one pending invitation to the specified\
@@ -10244,6 +10438,7 @@ paths:
tags:
- Projects
x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitation
post:
deprecated: true
description: "Invites one MongoDB Cloud user to join the specified project.\
@@ -10278,6 +10473,7 @@ paths:
tags:
- Projects
x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation
/api/atlas/v2/groups/{groupId}/invites/{invitationId}:
delete:
deprecated: true
@@ -10295,8 +10491,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -10314,6 +10508,7 @@ paths:
tags:
- Projects
x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectInvitation
get:
deprecated: true
description: "Returns the details of one pending invitation to the specified\
@@ -10330,8 +10525,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -10351,6 +10544,7 @@ paths:
tags:
- Projects
x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectInvitation
patch:
deprecated: true
description: "Updates the details of one pending invitation to the specified\
@@ -10368,8 +10562,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -10399,6 +10591,7 @@ paths:
tags:
- Projects
x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitationById
/api/atlas/v2/groups/{groupId}/ipAddresses:
get:
description: "Returns all IP addresses for this project. To use this resource,\
@@ -10425,6 +10618,7 @@ paths:
summary: Return All IP Addresses for One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/returnAllIpAddresses
/api/atlas/v2/groups/{groupId}/limits:
get:
description: "Returns all the limits for the specified project. To use this\
@@ -10457,6 +10651,7 @@ paths:
summary: Return All Limits for One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectLimits
/api/atlas/v2/groups/{groupId}/limits/{limitName}:
delete:
description: "Removes the specified project limit. Depending on the limit, Atlas\
@@ -10503,6 +10698,9 @@ paths:
- atlas.project.deployment.privateServiceConnectionsPerRegionGroup
- atlas.project.deployment.privateServiceConnectionsSubnetMask
- atlas.project.deployment.salesSoldM0s
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
- $ref: "#/components/parameters/envelope"
- $ref: "#/components/parameters/groupId"
- $ref: "#/components/parameters/pretty"
@@ -10525,6 +10723,7 @@ paths:
summary: Remove One Project Limit
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectLimit
get:
description: "Returns the specified limit for the specified project. To use\
\ this resource, the requesting API Key must have the Project Read Only role."
@@ -10568,6 +10767,9 @@ paths:
- atlas.project.deployment.privateServiceConnectionsPerRegionGroup
- atlas.project.deployment.privateServiceConnectionsSubnetMask
- atlas.project.deployment.salesSoldM0s
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
- $ref: "#/components/parameters/envelope"
- $ref: "#/components/parameters/groupId"
- $ref: "#/components/parameters/pretty"
@@ -10592,6 +10794,7 @@ paths:
summary: Return One Limit for One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLimit
patch:
description: |-
Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.
@@ -10637,6 +10840,9 @@ paths:
- atlas.project.deployment.privateServiceConnectionsPerRegionGroup
- atlas.project.deployment.privateServiceConnectionsSubnetMask
- atlas.project.deployment.salesSoldM0s
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
- $ref: "#/components/parameters/envelope"
- $ref: "#/components/parameters/groupId"
- $ref: "#/components/parameters/pretty"
@@ -10668,6 +10874,7 @@ paths:
summary: Set One Project Limit
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setProjectLimit
/api/atlas/v2/groups/{groupId}/liveMigrations:
post:
description: |-
@@ -10712,6 +10919,7 @@ paths:
summary: Migrate One Local Managed Cluster to MongoDB Atlas
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createPushMigration
/api/atlas/v2/groups/{groupId}/liveMigrations/validate:
post:
description: "Verifies whether the provided credentials, available disk space,\
@@ -10753,6 +10961,9 @@ paths:
summary: Validate One Migration Request
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}:
get:
description: Return the status of one migration validation job. Your API Key
@@ -10768,8 +10979,6 @@ paths:
schema:
type: string
example: 507f1f77bcf86cd799439011
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- $ref: "#/components/parameters/envelope"
responses:
@@ -10793,6 +11002,9 @@ paths:
summary: Return One Migration Validation Job
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getValidationStatus
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}:
get:
description: Return details of one cluster migration job. Each push live migration
@@ -10823,6 +11035,7 @@ paths:
summary: Return One Migration Job
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getPushMigration
/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover:
put:
description: "Cut over the migrated cluster to MongoDB Atlas. Confirm when the\
@@ -10855,6 +11068,9 @@ paths:
summary: Cut Over the Migrated Cluster
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverMigration
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/maintenanceWindow:
delete:
description: "Resets the maintenance window for the specified project. To use\
@@ -10887,6 +11103,7 @@ paths:
summary: Reset One Maintenance Window for One Project
tags:
- Maintenance Windows
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetMaintenanceWindow
get:
description: "Returns the maintenance window for the specified project. MongoDB\
\ Cloud starts those maintenance activities when needed. You can't change\
@@ -10917,6 +11134,7 @@ paths:
summary: Return One Maintenance Window for One Project
tags:
- Maintenance Windows
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/getMaintenanceWindow
patch:
description: "Updates the maintenance window for the specified project. Urgent\
\ maintenance activities such as security patches can't wait for your chosen\
@@ -10956,6 +11174,7 @@ paths:
summary: Update Maintenance Window for One Project
tags:
- Maintenance Windows
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/updateMaintenanceWindow
/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer:
post:
description: "Toggles automatic deferral of the maintenance window for the specified\
@@ -10980,6 +11199,10 @@ paths:
summary: Toggle Automatic Deferral of Maintenance for One Project
tags:
- Maintenance Windows
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleMaintenanceAutoDefer
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer:
post:
description: "Defers the maintenance window for the specified project. Urgent\
@@ -11011,6 +11234,10 @@ paths:
summary: Defer One Maintenance Window for One Project
tags:
- Maintenance Windows
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferMaintenanceWindow
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/managedSlowMs:
get:
description: Get whether the Managed Slow MS feature is enabled.
@@ -11023,6 +11250,8 @@ paths:
"200":
content:
application/vnd.atlas.2023-01-01+json:
+ schema:
+ type: boolean
x-xgen-version: 2023-01-01
description: OK
"401":
@@ -11034,6 +11263,7 @@ paths:
summary: Return Managed Slow MS enabled
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getManagedSlowMs
/api/atlas/v2/groups/{groupId}/managedSlowMs/disable:
delete:
description: "Disables the slow operation threshold that MongoDB Cloud calculated\
@@ -11065,6 +11295,10 @@ paths:
summary: Disable Managed Slow Operation Threshold
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableSlowOperationThresholding
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/managedSlowMs/enable:
post:
description: "Enables MongoDB Cloud to use its slow operation threshold for\
@@ -11096,6 +11330,10 @@ paths:
summary: Enable Managed Slow Operation Threshold
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableSlowOperationThresholding
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/mongoDBVersions:
get:
description: Returns the MongoDB Long Term Support Major Versions available
@@ -11162,6 +11400,7 @@ paths:
summary: Return Available MongoDB LTS Versions for clusters in One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLtsVersions
/api/atlas/v2/groups/{groupId}/peers:
get:
description: "Returns details about all network peering connections in the specified\
@@ -11203,6 +11442,7 @@ paths:
summary: Return All Network Peering Connections in One Project
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringConnections
post:
description: "Creates one new network peering connection in the specified project.\
\ Network peering allows multiple cloud-hosted applications to securely connect\
@@ -11245,6 +11485,7 @@ paths:
summary: Create One New Network Peering Connection
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringConnection
/api/atlas/v2/groups/{groupId}/peers/{peerId}:
delete:
description: "Removes one network peering connection in the specified project.\
@@ -11264,8 +11505,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"202":
@@ -11284,6 +11523,7 @@ paths:
summary: Remove One Existing Network Peering Connection
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringConnection
get:
description: "Returns details about one specified network peering connection\
\ in the specified project. To use this resource, the requesting API Key must\
@@ -11300,8 +11540,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -11320,6 +11558,7 @@ paths:
summary: Return One Network Peering Connection in One Project
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringConnection
patch:
description: "Updates one specified network peering connection in the specified\
\ project. To use this resource, the requesting API Key must have the Project\
@@ -11336,8 +11575,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -11367,6 +11604,7 @@ paths:
summary: Update One New Network Peering Connection
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringConnection
/api/atlas/v2/groups/{groupId}/pipelines:
get:
deprecated: true
@@ -11396,6 +11634,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelines
post:
deprecated: true
description: Creates one Data Lake Pipeline.
@@ -11434,6 +11673,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/createPipeline
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}:
delete:
deprecated: true
@@ -11448,8 +11688,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[^/\\\\ \"$]{1,64}$"
responses:
"204":
@@ -11469,6 +11707,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipeline
get:
deprecated: true
description: "Returns the details of one Data Lake Pipeline within the specified\
@@ -11485,8 +11724,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[^/\\\\ \"$]{1,64}$"
responses:
"200":
@@ -11506,6 +11743,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipeline
patch:
deprecated: true
description: Updates one Data Lake Pipeline.
@@ -11519,8 +11757,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[^/\\\\ \"$]{1,64}$"
requestBody:
content:
@@ -11551,6 +11787,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/updatePipeline
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules:
get:
deprecated: true
@@ -11568,8 +11805,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[^/\\\\ \"$]{1,64}$"
responses:
"200":
@@ -11591,6 +11826,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSchedules
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots:
get:
deprecated: true
@@ -11621,8 +11857,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[^/\\\\ \"$]{1,64}$"
responses:
"200":
@@ -11642,6 +11876,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSnapshots
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause:
post:
deprecated: true
@@ -11659,8 +11894,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[^/\\\\ \"$]{1,64}$"
responses:
"200":
@@ -11680,6 +11913,9 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pausePipeline
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume:
post:
deprecated: true
@@ -11697,8 +11933,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[^/\\\\ \"$]{1,64}$"
responses:
"200":
@@ -11718,6 +11952,9 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumePipeline
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs:
get:
deprecated: true
@@ -11745,8 +11982,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[^/\\\\ \"$]{1,64}$"
responses:
"200":
@@ -11766,6 +12001,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineRuns
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}:
delete:
deprecated: true
@@ -11782,8 +12018,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[^/\\\\ \"$]{1,64}$"
- description: Unique 24-hexadecimal character string that identifies a Data
Lake Pipeline run.
@@ -11793,8 +12027,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"202":
@@ -11814,6 +12046,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipelineRunDataset
get:
deprecated: true
description: "Returns the details of one Data Lake Pipeline run within the specified\
@@ -11830,8 +12063,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[^/\\\\ \"$]{1,64}$"
- description: Unique 24-hexadecimal character string that identifies a Data
Lake Pipeline run.
@@ -11841,8 +12072,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -11862,6 +12091,7 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipelineRun
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger:
post:
deprecated: true
@@ -11877,8 +12107,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[^/\\\\ \"$]{1,64}$"
requestBody:
content:
@@ -11905,6 +12133,9 @@ paths:
tags:
- Data Lake Pipelines
x-sunset: 2025-09-09
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerSnapshotIngestion
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService:
post:
description: "Creates one private endpoint service for the specified cloud service\
@@ -11946,6 +12177,10 @@ paths:
summary: Create One Private Endpoint Service for One Provider
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpointService
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode:
get:
description: "Checks whether each region in the specified cloud service provider\
@@ -11974,6 +12209,7 @@ paths:
summary: Return Regionalized Private Endpoint Status
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting
patch:
description: "Enables or disables the ability to create multiple private endpoints\
\ per region in all cloud service providers in one project. The cloud service\
@@ -12013,11 +12249,15 @@ paths:
summary: Toggle Regionalized Private Endpoint Status
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint:
get:
- description: Returns all private endpoints for one serverless instance. You
- must have at least the Project Read Only role for the project to successfully
- call this resource.
+ description: |-
+ Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource.
+
+ This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
operationId: listServerlessPrivateEndpoints
parameters:
- $ref: "#/components/parameters/envelope"
@@ -12029,7 +12269,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -12050,11 +12289,14 @@ paths:
summary: Return All Private Endpoints for One Serverless Instance
tags:
- Serverless Private Endpoints
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/listServerlessPrivateEndpoints
post:
description: |-
Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.
A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.
+
+ This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
externalDocs:
description: Set Up a Private Endpoint for a Serverless Instance Tutorial
url: https://dochub.mongodb.org/core/serverless-private-endpoint
@@ -12069,7 +12311,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -12096,10 +12337,15 @@ paths:
summary: Create One Private Endpoint for One Serverless Instance
tags:
- Serverless Private Endpoints
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/createServerlessPrivateEndpoint
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}:
delete:
- description: "Remove one private endpoint from one serverless instance. To use\
- \ this resource, the requesting API Key must have the Project Owner role."
+ description: |-
+ Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.
+
+ This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
operationId: deleteServerlessPrivateEndpoint
parameters:
- $ref: "#/components/parameters/envelope"
@@ -12111,7 +12357,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the tenant
endpoint which will be removed.
@@ -12120,8 +12365,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -12140,10 +12383,12 @@ paths:
summary: Remove One Private Endpoint for One Serverless Instance
tags:
- Serverless Private Endpoints
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/deleteServerlessPrivateEndpoint
get:
- description: Return one private endpoint for one serverless instance. Identify
- this endpoint using its unique ID. You must have at least the Project Read
- Only role for the project to successfully call this resource.
+ description: |-
+ Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource.
+
+ This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
operationId: getServerlessPrivateEndpoint
parameters:
- $ref: "#/components/parameters/envelope"
@@ -12155,7 +12400,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the tenant
endpoint.
@@ -12164,8 +12408,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -12184,9 +12426,12 @@ paths:
summary: Return One Private Endpoint for One Serverless Instance
tags:
- Serverless Private Endpoints
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getServerlessPrivateEndpoint
patch:
- description: "Updates one private endpoint for one serverless instance. To use\
- \ this resource, the requesting API Key must have the Project Owner role."
+ description: |-
+ Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.
+
+ This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
operationId: updateServerlessPrivateEndpoint
parameters:
- $ref: "#/components/parameters/envelope"
@@ -12198,7 +12443,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the tenant
endpoint which will be updated.
@@ -12207,8 +12451,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -12234,6 +12476,9 @@ paths:
summary: Update One Private Endpoint for One Serverless Instance
tags:
- Serverless Private Endpoints
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/updateServerlessPrivateEndpoint
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService:
get:
description: "Returns the name, interfaces, and state of all private endpoint\
@@ -12273,6 +12518,7 @@ paths:
summary: Return All Private Endpoint Services for One Provider
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/listPrivateEndpointServices
/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}:
delete:
description: "Removes one private endpoint service from the specified project.\
@@ -12302,8 +12548,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -12320,6 +12564,7 @@ paths:
summary: Remove One Private Endpoint Service for One Provider
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpointService
get:
description: "Returns the name, interfaces, and state of the specified private\
\ endpoint service from one project. The cloud service provider hosted this\
@@ -12348,8 +12593,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -12368,6 +12611,7 @@ paths:
summary: Return One Private Endpoint Service for One Provider
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpointService
/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint:
post:
description: "Creates one private endpoint for the specified cloud service provider.\
@@ -12399,8 +12643,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -12431,6 +12673,7 @@ paths:
summary: Create One Private Endpoint for One Provider
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpoint
/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}:
delete:
description: "Removes one private endpoint from the specified project and private\
@@ -12472,8 +12715,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -12490,6 +12731,7 @@ paths:
summary: Remove One Private Endpoint for One Provider
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpoint
get:
description: "Returns the connection state of the specified private endpoint.\
\ The private endpoint service manages this private endpoint which belongs\
@@ -12529,8 +12771,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -12549,6 +12789,7 @@ paths:
summary: Return One Private Endpoint for One Provider
tags:
- Private Endpoint Services
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpoint
/api/atlas/v2/groups/{groupId}/privateIpMode:
get:
deprecated: true
@@ -12578,6 +12819,7 @@ paths:
summary: Verify Connect via Peering Only Mode for One Project
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject
patch:
deprecated: true
description: "Disables Connect via Peering Only mode for the specified project.\
@@ -12615,6 +12857,7 @@ paths:
summary: Disable Connect via Peering Only Mode for One Project
tags:
- Network Peering
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disablePeering
/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds:
get:
description: "Returns all private endpoints for Federated Database Instances\
@@ -12649,6 +12892,7 @@ paths:
in One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listDataFederationPrivateEndpoints
post:
description: |-
Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region.
@@ -12701,6 +12945,9 @@ paths:
for One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createDataFederationPrivateEndpoint
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}:
delete:
description: "Removes one private endpoint for Federated Database Instances\
@@ -12719,8 +12966,6 @@ paths:
required: true
schema:
type: string
- maxLength: 22
- minLength: 22
pattern: "^vpce-[0-9a-f]{17}$"
responses:
"204":
@@ -12740,6 +12985,7 @@ paths:
from One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteDataFederationPrivateEndpoint
get:
description: "Returns the specified private endpoint for Federated Database\
\ Instances or Online Archives in the specified project. To use this resource,\
@@ -12758,8 +13004,6 @@ paths:
required: true
schema:
type: string
- maxLength: 22
- minLength: 22
pattern: "^vpce-[0-9a-f]{17}$"
responses:
"200":
@@ -12781,6 +13025,9 @@ paths:
in One Project
tags:
- Data Federation
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getDataFederationPrivateEndpoint
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/processes:
get:
description: "Returns details of all processes for the specified project. A\
@@ -12809,6 +13056,7 @@ paths:
summary: Return All MongoDB Processes in One Project
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listAtlasProcesses
/api/atlas/v2/groups/{groupId}/processes/{processId}:
get:
description: "Returns the processes for the specified host for the specified\
@@ -12848,6 +13096,7 @@ paths:
summary: Return One MongoDB Process by ID
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getAtlasProcess
/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces:
get:
description: Return the subset of namespaces from the given process ranked by
@@ -12875,11 +13124,14 @@ paths:
summary: Return Ranked Namespaces from a Host
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForHost
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/processes/{processId}/databases:
get:
description: "Returns the list of databases running on the specified host for\
- \ the specified project. `M0` free clusters, `M2`, `M5`, and serverless clusters\
- \ have some [operational limits](https://www.mongodb.com/docs/atlas/reference/free-shared-limitations/#operational-limitations).\
+ \ the specified project. `M0` free clusters, `M2`, `M5`, serverless, and Flex\
+ \ clusters have some [operational limits](https://www.mongodb.com/docs/atlas/reference/limitations/).\
\ The MongoDB Cloud process must be a `mongod`. To use this resource, the\
\ requesting API Key must have the Project Read Only role."
operationId: listDatabases
@@ -12918,6 +13170,7 @@ paths:
summary: Return Available Databases for One MongoDB Process
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDatabases
/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}:
get:
description: "Returns one database running on the specified host for the specified\
@@ -12964,6 +13217,7 @@ paths:
summary: Return One Database for a MongoDB Process
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabase
/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements:
get:
description: "Returns the measurements of one database for the specified host\
@@ -13046,6 +13300,7 @@ paths:
summary: Return Measurements of One Database for One MongoDB Process
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabaseMeasurements
/api/atlas/v2/groups/{groupId}/processes/{processId}/disks:
get:
description: "Returns the list of disks or partitions for the specified host\
@@ -13088,6 +13343,7 @@ paths:
summary: Return Available Disks for One MongoDB Process
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskPartitions
/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}:
get:
description: "Returns measurement details for one disk or partition for the\
@@ -13133,6 +13389,7 @@ paths:
summary: Return Measurements of One Disk
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskMeasurements
/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements:
get:
description: |-
@@ -13226,6 +13483,7 @@ paths:
summary: Return Measurements of One Disk for One MongoDB Process
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDiskMeasurements
/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements:
get:
description: |-
@@ -13306,7 +13564,7 @@ paths:
- MAX_PROCESS_NORMALIZED_CPU_KERNEL
- MAX_PROCESS_NORMALIZED_CPU_USER
- MAX_SWAP_USAGE_FREE
- - 'MAX_SWAP_USAGE_USED '
+ - MAX_SWAP_USAGE_USED
- MAX_SYSTEM_CPU_GUEST
- MAX_SYSTEM_CPU_IOWAIT
- MAX_SYSTEM_CPU_IRQ
@@ -13431,6 +13689,7 @@ paths:
summary: Return Measurements for One MongoDB Process
tags:
- Monitoring and Logs
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostMeasurements
/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces:
get:
description: "Returns up to 20 namespaces for collections experiencing slow\
@@ -13490,6 +13749,9 @@ paths:
summary: Return All Namespaces for One Host
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueryNamespaces
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs:
get:
description: "Returns log lines for slow queries that the Performance Advisor\
@@ -13497,8 +13759,8 @@ paths:
\ that MongoDB considers slow and suggests new indexes to improve query performance.\
\ MongoDB Cloud bases the threshold for slow queries on the average time of\
\ operations on your cluster. This enables workload-relevant recommendations.\
- \ To use this resource, the requesting API Key must have the Project Data\
- \ Access Read Write role."
+ \ To use this resource, the requesting API Key must have any Project Data\
+ \ Access role or the Project Observability Viewer role."
operationId: listSlowQueries
parameters:
- $ref: "#/components/parameters/envelope"
@@ -13572,6 +13834,9 @@ paths:
summary: Return Slow Queries
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueries
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes:
get:
description: "Returns the indexes that the Performance Advisor suggests. The\
@@ -13659,6 +13924,9 @@ paths:
summary: Return Suggested Indexes
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSuggestedIndexes
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements:
get:
description: Get a list of the Coll Stats Latency process-level measurements
@@ -13728,6 +13996,9 @@ paths:
summary: Return Host-Level Query Latency
tags:
- Collection Level Metrics
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceHostMeasurements
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/pushBasedLogExport:
delete:
description: Disables the push-based log export feature by resetting the project
@@ -13756,6 +14027,7 @@ paths:
summary: Disable the push-based log export feature for a project
tags:
- Push-Based Log Export
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deletePushBasedLogConfiguration
get:
description: Fetches the current project level settings for the push-based log
export feature.
@@ -13783,6 +14055,7 @@ paths:
summary: Get the push-based log export configuration for a project
tags:
- Push-Based Log Export
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getPushBasedLogConfiguration
patch:
description: Updates the project level settings for the push-based log export
feature.
@@ -13820,6 +14093,7 @@ paths:
summary: Update the push-based log export feature for a project
tags:
- Push-Based Log Export
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updatePushBasedLogConfiguration
post:
description: Configures the project level settings for the push-based log export
feature.
@@ -13856,6 +14130,7 @@ paths:
summary: Enable the push-based log export feature for a project
tags:
- Push-Based Log Export
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createPushBasedLogConfiguration
/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}:
post:
description: "Requests loading the MongoDB sample dataset into the specified\
@@ -13872,8 +14147,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"201":
@@ -13894,6 +14167,7 @@ paths:
summary: Load Sample Dataset Request into Cluster
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/loadSampleDataset
/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}:
get:
description: "Checks the progress of loading the sample dataset into one cluster.\
@@ -13910,8 +14184,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -13928,11 +14200,16 @@ paths:
summary: Check Status of Cluster Sample Dataset Request
tags:
- Clusters
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getSampleDatasetLoadStatus
/api/atlas/v2/groups/{groupId}/serverless:
get:
- description: "Returns details for all serverless instances in the specified\
- \ project. To use this resource, the requesting API Key must have the Project\
- \ Read Only role."
+ description: |-
+ Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+
+ This endpoint also lists Flex clusters that were created using the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or former Serverless instances that have been migrated to Flex clusters, until January 2026 after which this endpoint will be sunset. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the listFlexClusters endpoint instead.
+ externalDocs:
+ description: listFlexClusters
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters
operationId: listServerlessInstances
parameters:
- $ref: "#/components/parameters/envelope"
@@ -13956,9 +14233,15 @@ paths:
summary: Return All Serverless Instances from One Project
tags:
- Serverless Instances
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/listServerlessInstances
post:
- description: "Creates one serverless instance in the specified project. To use\
- \ this resource, the requesting API Key must have the Project Owner role."
+ description: |-
+ Update as of Feb 2025: This endpoint now creates a Flex cluster instead. This endpoint will no longer be supported starting January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect. Please use the createFlexCluster endpoint instead.
+
+ Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+ externalDocs:
+ description: createFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster
operationId: createServerlessInstance
parameters:
- $ref: "#/components/parameters/envelope"
@@ -13990,11 +14273,16 @@ paths:
summary: Create One Serverless Instance in One Project
tags:
- Serverless Instances
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance
/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs:
get:
- description: "Returns all restore jobs for one serverless instance from the\
- \ specified project. To use this resource, the requesting API Key must have\
- \ the Project Owner role."
+ description: |-
+ Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackupRestoreJobs endpoint instead.
+ externalDocs:
+ description: listFlexBackupRestoreJobs
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs
operationId: listServerlessBackupRestoreJobs
parameters:
- $ref: "#/components/parameters/envelope"
@@ -14009,8 +14297,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -14029,10 +14315,15 @@ paths:
summary: Return All Restore Jobs for One Serverless Instance
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackupRestoreJobs
post:
- description: "Restores one snapshot of one serverless instance from the specified\
- \ project. To use this resource, the requesting API Key must have the Project\
- \ Owner role."
+ description: |-
+ Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the createFlexBackupRestoreJob endpoint instead.
+ externalDocs:
+ description: createFlexBackupRestoreJob
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob
operationId: createServerlessBackupRestoreJob
parameters:
- $ref: "#/components/parameters/envelope"
@@ -14045,8 +14336,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -14077,11 +14366,18 @@ paths:
summary: Restore One Snapshot of One Serverless Instance
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createServerlessBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}:
get:
- description: "Returns one restore job for one serverless instance from the specified\
- \ project. To use this resource, the requesting API Key must have the Project\
- \ Owner role."
+ description: |-
+ Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackupRestoreJob endpoint instead.
+ externalDocs:
+ description: getFlexBackupRestoreJob
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob
operationId: getServerlessBackupRestoreJob
parameters:
- $ref: "#/components/parameters/envelope"
@@ -14093,8 +14389,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the restore
job to return.
@@ -14103,8 +14397,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -14123,11 +14415,18 @@ paths:
summary: Return One Restore Job for One Serverless Instance
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackupRestoreJob
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots:
get:
- description: "Returns all snapshots of one serverless instance from the specified\
- \ project. To use this resource, the requesting API Key must have the Project\
- \ Read Only role."
+ description: |-
+ Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackups endpoint instead.
+ externalDocs:
+ description: listFlexBackups
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups
operationId: listServerlessBackups
parameters:
- $ref: "#/components/parameters/envelope"
@@ -14142,8 +14441,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -14162,11 +14459,18 @@ paths:
summary: Return All Snapshots of One Serverless Instance
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackups
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}:
get:
- description: "Returns one snapshot of one serverless instance from the specified\
- \ project. To use this resource, the requesting API Key must have the Project\
- \ Read Only role."
+ description: |-
+ Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+
+ This endpoint can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) API or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackup endpoint instead.
+ externalDocs:
+ description: getFlexBackup
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup
operationId: getServerlessBackup
parameters:
- $ref: "#/components/parameters/envelope"
@@ -14177,8 +14481,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Unique 24-hexadecimal digit string that identifies the desired
snapshot.
@@ -14188,8 +14490,6 @@ paths:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -14208,9 +14508,20 @@ paths:
summary: Return One Snapshot of One Serverless Instance
tags:
- Cloud Backups
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackup
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing:
get:
- description: Get whether the Serverless Auto Indexing feature is enabled.
+ description: "Get whether the Serverless Auto Indexing feature is enabled. This\
+ \ endpoint returns a value for Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance)\
+ \ endpoint or Flex clusters that were migrated from Serverless instances.\
+ \ However, the value returned is not indicative of the Auto Indexing state\
+ \ as Auto Indexing is unavailable for Flex clusters. This endpoint will be\
+ \ sunset in January 2026."
+ externalDocs:
+ description: createServerlessInstance
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance
operationId: getServerlessAutoIndexing
parameters:
- $ref: "#/components/parameters/groupId"
@@ -14220,8 +14531,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- $ref: "#/components/parameters/envelope"
- $ref: "#/components/parameters/pretty"
@@ -14240,8 +14549,17 @@ paths:
summary: Return Serverless Auto Indexing Enabled
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getServerlessAutoIndexing
post:
- description: Set whether the Serverless Auto Indexing feature is enabled.
+ description: "Set whether the Serverless Auto Indexing feature is enabled. This\
+ \ endpoint sets a value for Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance)\
+ \ endpoint or Flex clusters that were migrated from Serverless instances.\
+ \ However, the value returned is not indicative of the Auto Indexing state\
+ \ as Auto Indexing is unavailable for Flex clusters. This endpoint will be\
+ \ sunset in January 2026."
+ externalDocs:
+ description: createServerlessInstance
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance
operationId: setServerlessAutoIndexing
parameters:
- $ref: "#/components/parameters/groupId"
@@ -14251,8 +14569,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
- description: Value that we want to set for the Serverless Auto Indexing toggle.
in: query
@@ -14276,12 +14592,18 @@ paths:
summary: Set Serverless Auto Indexing
tags:
- Performance Advisor
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setServerlessAutoIndexing
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/serverless/{name}:
delete:
- description: "Removes one serverless instance from the specified project. The\
- \ serverless instance must have termination protection disabled in order to\
- \ be deleted. To use this resource, the requesting API Key must have the Project\
- \ Owner role."
+ description: |-
+ Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role.
+
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the deleteFlexCluster endpoint instead.
+ externalDocs:
+ description: deleteFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster
operationId: deleteServerlessInstance
parameters:
- $ref: "#/components/parameters/envelope"
@@ -14293,8 +14615,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"202":
@@ -14315,10 +14635,15 @@ paths:
summary: Remove One Serverless Instance from One Project
tags:
- Serverless Instances
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/deleteServerlessInstance
get:
- description: "Returns details for one serverless instance in the specified project.\
- \ To use this resource, the requesting API Key must have the Project Read\
- \ Only role."
+ description: |-
+ Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. This endpoint will be sunset in January 2026. Please use the getFlexCluster endpoint instead.
+ externalDocs:
+ description: getFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster
operationId: getServerlessInstance
parameters:
- $ref: "#/components/parameters/groupId"
@@ -14330,8 +14655,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
"200":
@@ -14352,9 +14675,15 @@ paths:
summary: Return One Serverless Instance from One Project
tags:
- Serverless Instances
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/getServerlessInstance
patch:
- description: "Updates one serverless instance in the specified project. To use\
- \ this resource, the requesting API Key must have the Project Owner role."
+ description: |-
+ Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.
+
+ This API can also be used on Flex clusters that were created with the [createServerlessInstance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the updateFlexCluster endpoint instead.
+ externalDocs:
+ description: updateFlexCluster
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster
operationId: updateServerlessInstance
parameters:
- $ref: "#/components/parameters/envelope"
@@ -14366,8 +14695,6 @@ paths:
required: true
schema:
type: string
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
requestBody:
content:
@@ -14393,6 +14720,7 @@ paths:
summary: Update One Serverless Instance in One Project
tags:
- Serverless Instances
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/updateServerlessInstance
/api/atlas/v2/groups/{groupId}/serviceAccounts:
get:
description: Returns all Service Accounts for the specified Project. Available
@@ -14421,6 +14749,7 @@ paths:
summary: List All Project Service Accounts
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccounts
post:
description: Creates one Service Account for the specified Project. The Service
Account will automatically be added as an Organization Member to the Organization
@@ -14455,6 +14784,7 @@ paths:
summary: Create and Assign one Service Account to one Project
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccount
/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:
delete:
description: "Removes the specified Service Account from the specified project.\
@@ -14492,6 +14822,7 @@ paths:
summary: Unassign One Service Account from One Project
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccount
get:
description: Returns one Service Account in the specified Project. Available
as a preview feature.
@@ -14525,6 +14856,7 @@ paths:
summary: Get one Project Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getProjectServiceAccount
patch:
description: Updates one Service Account in the specified Project. Available
as a preview feature.
@@ -14567,6 +14899,7 @@ paths:
summary: Update one Project Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateProjectServiceAccount
/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList:
get:
description: Returns all access list entries that you configured for the specified
@@ -14602,6 +14935,7 @@ paths:
summary: Return All Access List entries for one Project Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccountAccessList
post:
description: Add Access List Entries for the specified Service Account for the
project. Resources require all API requests to originate from IP addresses
@@ -14652,6 +14986,9 @@ paths:
summary: Add Access List entries for one Project Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountAccessList
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}:
delete:
description: Removes the specified access list entry from the specified Service
@@ -14698,6 +15035,7 @@ paths:
summary: Remove One Access List entry from one Project Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountAccessListEntry
/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets:
post:
description: Create a secret for the specified Service Account in the specified
@@ -14739,6 +15077,9 @@ paths:
summary: Create one Project Service Account Secret
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountSecret
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}:
delete:
description: Deletes the specified Service Account secret. Available as a preview
@@ -14777,6 +15118,7 @@ paths:
summary: Delete one Project Service Account Secret
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountSecret
/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite:
post:
description: Assigns the specified Service Account to the specified Project.
@@ -14822,6 +15164,7 @@ paths:
summary: Assign One Service Account to One Project
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/addProjectServiceAccount
/api/atlas/v2/groups/{groupId}/settings:
get:
description: "Returns details about the specified project's settings. To use\
@@ -14850,6 +15193,7 @@ paths:
summary: Return One Project Settings
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectSettings
patch:
description: "Updates the settings of the specified project. You can update\
\ any of the options available. MongoDB cloud only updates the options provided\
@@ -14886,6 +15230,7 @@ paths:
summary: Update One Project Settings
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectSettings
/api/atlas/v2/groups/{groupId}/streams:
get:
description: Returns all stream instances for the specified project.
@@ -14914,6 +15259,7 @@ paths:
x-xgen-changelog:
"2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
\ part of private preview, but is subject to change until GA."
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamInstances
post:
description: "Creates one stream instance in the specified project. To use this\
\ resource, the requesting API Key must have the Project Data Access Admin\
@@ -14950,6 +15296,7 @@ paths:
x-xgen-changelog:
"2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
\ part of private preview, but is subject to change until GA."
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstance
/api/atlas/v2/groups/{groupId}/streams/accountDetails:
get:
description: "Returns the Account ID, and the VPC ID for the group and region\
@@ -14986,6 +15333,35 @@ paths:
summary: "Returns the Account ID, and the VPC ID for the group and region specified."
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ /api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections:
+ get:
+ description: Returns a list of active incoming VPC Peering Connections.
+ operationId: getActiveVpcPeeringConnections
+ parameters:
+ - $ref: "#/components/parameters/groupId"
+ - $ref: "#/components/parameters/envelope"
+ - $ref: "#/components/parameters/itemsPerPage"
+ - $ref: "#/components/parameters/pageNum"
+ - $ref: "#/components/parameters/pretty"
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2024-11-13+json:
+ x-xgen-version: 2024-11-13
+ description: OK
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Returns all the active incoming VPC Peering Connections.
+ tags:
+ - Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getActiveVpcPeeringConnections
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections:
get:
description: "Returns all Private Link connections for the specified project.To\
@@ -15018,6 +15394,7 @@ paths:
x-xgen-changelog:
"2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\
\ exposed as part of private preview, but is subject to change until GA."
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listPrivateLinkConnections
post:
description: "Creates one Private Link in the specified project. To use this\
\ resource, the requesting API Key must have the Project Owner or Project\
@@ -15057,6 +15434,9 @@ paths:
x-xgen-changelog:
"2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\
\ exposed as part of private preview, but is subject to change until GA."
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createPrivateLinkConnection
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}:
delete:
description: "Deletes one Private Link in the specified project. To use this\
@@ -15095,6 +15475,7 @@ paths:
x-xgen-changelog:
"2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\
\ exposed as part of private preview, but is subject to change until GA."
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deletePrivateLinkConnection
get:
description: "Returns the details of one Private Link connection within the\
\ project. To use this resource, the requesting API Key must have the Project\
@@ -15129,6 +15510,9 @@ paths:
x-xgen-changelog:
"2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\
\ exposed as part of private preview, but is subject to change until GA."
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getPrivateLinkConnection
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections:
get:
description: Returns a list of incoming VPC Peering Connections.
@@ -15158,6 +15542,10 @@ paths:
summary: Return All VPC Peering Connections.
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getVpcPeeringConnections
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:
delete:
description: Deletes an incoming VPC Peering connection.
@@ -15190,6 +15578,9 @@ paths:
summary: Deletes an incoming VPC Peering connection.
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteVpcPeeringConnection
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept:
post:
description: Requests the acceptance of an incoming VPC Peering connection.
@@ -15230,6 +15621,9 @@ paths:
summary: Requests the acceptance of an incoming VPC Peering connection.
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/acceptVpcPeeringConnection
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject:
post:
description: Requests the rejection of an incoming VPC Peering connection.
@@ -15262,6 +15656,9 @@ paths:
summary: Requests the rejection of an incoming VPC Peering connection.
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/rejectVpcPeeringConnection
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/streams/{tenantName}:
delete:
description: "Delete one stream instance in the specified project. To use this\
@@ -15300,6 +15697,7 @@ paths:
x-xgen-changelog:
"2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
\ part of private preview, but is subject to change until GA."
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamInstance
get:
description: "Returns the details of one stream instance within the specified\
\ project. To use this resource, the requesting API Key must have the Project\
@@ -15343,6 +15741,7 @@ paths:
x-xgen-changelog:
"2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
\ part of private preview, but is subject to change until GA."
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamInstance
patch:
description: "Update one stream instance in the specified project. To use this\
\ resource, the requesting API Key must have the Project Data Access Admin\
@@ -15390,6 +15789,7 @@ paths:
x-xgen-changelog:
"2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
\ part of private preview, but is subject to change until GA."
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamInstance
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs:
get:
description: "Downloads the audit logs for the specified Atlas Streams Processing\
@@ -15454,6 +15854,7 @@ paths:
summary: Download Audit Logs for One Atlas Stream Processing Instance
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadStreamTenantAuditLogs
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections:
get:
description: "Returns all connections of the stream instance for the specified\
@@ -15493,6 +15894,7 @@ paths:
x-xgen-changelog:
"2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
\ part of private preview, but is subject to change until GA."
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamConnections
post:
description: "Creates one connection for a stream instance in the specified\
\ project. To use this resource, the requesting API Key must have the Project\
@@ -15538,6 +15940,7 @@ paths:
x-xgen-changelog:
"2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
\ part of private preview, but is subject to change until GA."
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamConnection
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}:
delete:
description: "Delete one connection of the specified stream instance. To use\
@@ -15584,6 +15987,7 @@ paths:
x-xgen-changelog:
"2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
\ part of private preview, but is subject to change until GA."
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamConnection
get:
description: "Returns the details of one stream connection within the specified\
\ stream instance. To use this resource, the requesting API Key must have\
@@ -15625,6 +16029,7 @@ paths:
x-xgen-changelog:
"2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
\ part of private preview, but is subject to change until GA."
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamConnection
patch:
description: "Update one connection for the specified stream instance in the\
\ specified project. To use this resource, the requesting API Key must have\
@@ -15680,6 +16085,7 @@ paths:
x-xgen-changelog:
"2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
\ part of private preview, but is subject to change until GA."
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamConnection
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor:
post:
description: "Create one Stream Processor within the specified stream instance.\
@@ -15722,6 +16128,7 @@ paths:
summary: Create One Stream Processor
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamProcessor
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:
delete:
description: "Delete a Stream Processor within the specified stream instance.\
@@ -15761,6 +16168,7 @@ paths:
summary: Delete One Stream Processor
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamProcessor
get:
description: "Get one Stream Processor within the specified stream instance.\
\ To use this resource, the requesting API Key must have the Project Owner\
@@ -15801,6 +16209,7 @@ paths:
summary: Get One Stream Processor
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamProcessor
patch:
description: "Modify one existing Stream Processor within the specified stream\
\ instance. To use this resource, the requesting API Key must have the Project\
@@ -15850,6 +16259,7 @@ paths:
summary: Modify One Stream Processor
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/modifyStreamProcessor
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start:
post:
description: "Start a Stream Processor within the specified stream instance.\
@@ -15891,6 +16301,7 @@ paths:
summary: Start One Stream Processor
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessor
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop:
post:
description: "Stop a Stream Processor within the specified stream instance.\
@@ -15932,6 +16343,7 @@ paths:
summary: Stop One Stream Processor
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/stopStreamProcessor
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors:
get:
description: "Returns all Stream Processors within the specified stream instance.\
@@ -15970,6 +16382,7 @@ paths:
summary: Return All Stream Processors In The Stream Instance.
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamProcessors
/api/atlas/v2/groups/{groupId}/streams:withSampleConnections:
post:
description: "Creates one stream instance in the specified project with sample\
@@ -16005,6 +16418,7 @@ paths:
summary: Create One Stream Instance With Sample Connections
tags:
- Streams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstanceWithSampleConnections
/api/atlas/v2/groups/{groupId}/teams:
get:
description: "Returns all teams to which the authenticated user has access in\
@@ -16040,6 +16454,7 @@ paths:
summary: Return All Teams in One Project
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listProjectTeams
post:
description: "Adds one team to the specified project. All members of the team\
\ share the same project access. MongoDB Cloud limits the number of users\
@@ -16084,6 +16499,9 @@ paths:
summary: Add One or More Teams to One Project
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addAllTeamsToProject
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/teams/{teamId}:
delete:
description: "Removes one team specified using its unique 24-hexadecimal digit\
@@ -16104,8 +16522,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -16126,6 +16542,7 @@ paths:
summary: Remove One Team from One Project
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam
patch:
description: "Updates the project roles assigned to the specified team. You\
\ can grant team roles for specific projects and grant project access roles\
@@ -16147,8 +16564,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -16178,6 +16593,7 @@ paths:
summary: Update Team Roles in One Project
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/updateTeamRoles
/api/atlas/v2/groups/{groupId}/userSecurity:
get:
description: "Returns the current LDAP configuration for the specified project.\
@@ -16203,6 +16619,7 @@ paths:
summary: Return the Current LDAP or X.509 Configuration
tags:
- LDAP Configuration
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfiguration
patch:
description: |-
Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.
@@ -16237,6 +16654,7 @@ paths:
summary: Edit the LDAP or X.509 Configuration
tags:
- LDAP Configuration
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/saveLdapConfiguration
/api/atlas/v2/groups/{groupId}/userSecurity/customerX509:
delete:
description: |-
@@ -16262,6 +16680,10 @@ paths:
summary: Disable Customer-Managed X.509
tags:
- X.509 Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableCustomerManagedX509
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping:
delete:
description: "Removes the current LDAP Distinguished Name mapping captured in\
@@ -16288,6 +16710,10 @@ paths:
summary: Remove the Current LDAP User to DN Mapping
tags:
- LDAP Configuration
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/deleteLdapConfiguration
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify:
post:
description: "Verifies the LDAP configuration for the specified project. To\
@@ -16322,6 +16748,9 @@ paths:
summary: Verify the LDAP Configuration in One Project
tags:
- LDAP Configuration
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyLdapConfiguration
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}:
get:
description: "Returns the status of one request to verify one LDAP configuration\
@@ -16339,8 +16768,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -16357,12 +16784,14 @@ paths:
summary: Return the Status of One Verify LDAP Configuration Request
tags:
- LDAP Configuration
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfigurationStatus
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/groups/{groupId}/users:
get:
- deprecated: true
description: "Returns details about all users in the specified project. Users\
\ belong to an organization. To use this resource, the requesting API Key\
- \ must have the Project Read Only role."
+ \ must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}"
operationId: listProjectUsers
parameters:
- $ref: "#/components/parameters/envelope"
@@ -16394,21 +16823,13 @@ paths:
schema:
type: boolean
default: false
- - description: "Flag that indicates whether to filter the returned list by users\
- \ organization membership status. If you exclude this parameter, this resource\
- \ returns both pending and active users."
- in: query
- name: orgMembershipStatus
- schema:
- type: string
- example: ACTIVE
responses:
"200":
content:
- application/vnd.atlas.2023-01-01+json:
+ application/vnd.atlas.2043-01-01+json:
schema:
- $ref: "#/components/schemas/PaginatedAppUserView"
- x-xgen-version: 2023-01-01
+ $ref: "#/components/schemas/PaginatedGroupUserView"
+ x-xgen-version: 2043-01-01
description: OK
"401":
$ref: "#/components/responses/unauthorized"
@@ -16417,11 +16838,58 @@ paths:
summary: Return All Users in One Project
tags:
- Projects
- x-sunset: 2044-01-01
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectUsers
+ post:
+ description: "Adds one MongoDB Cloud user to one project. To use this resource,\
+ \ the requesting API Key must have the Project Owner role. \n- If the user\
+ \ has a pending invitation to join the project's organization, MongoDB Cloud\
+ \ modifies it and grants project access. \n- If the user doesn't have an invitation\
+ \ to join the organization, MongoDB Cloud sends a new invitation that grants\
+ \ the user organization and project access. \n- If the user is already active\
+ \ in the project's organization, MongoDB Cloud grants access to the project.\
+ \ \n"
+ operationId: addProjectUser
+ parameters:
+ - $ref: "#/components/parameters/envelope"
+ - $ref: "#/components/parameters/groupId"
+ - $ref: "#/components/parameters/pretty"
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/GroupUserRequest"
+ description: The active or pending MongoDB Cloud user that you want to add
+ to the specified project.
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/GroupUserResponse"
+ x-xgen-version: 2043-01-01
+ description: Created
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "409":
+ $ref: "#/components/responses/conflict"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Add One MongoDB Cloud User to One Project
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectUser
/api/atlas/v2/groups/{groupId}/users/{userId}:
delete:
description: "Removes the specified user from the specified project. To use\
- \ this resource, the requesting API Key must have the Project Owner role."
+ \ this resource, the requesting API Key must have the Project Owner role.\
+ \ Deprecated versions: v2-{2023-01-01}"
operationId: removeProjectUser
parameters:
- $ref: "#/components/parameters/envelope"
@@ -16436,14 +16904,14 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
content:
- application/vnd.atlas.2023-01-01+json:
- x-xgen-version: 2023-01-01
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/NoBody"
+ x-xgen-version: 2043-01-01
description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
@@ -16456,8 +16924,54 @@ paths:
summary: Remove One User from One Project
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/removeProjectUser
+ get:
+ description: |-
+ Returns information about the specified MongoDB Cloud user within the context of the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
+
+ **Note**: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint.
+
+ **Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: getProjectUser
+ parameters:
+ - $ref: "#/components/parameters/envelope"
+ - $ref: "#/components/parameters/groupId"
+ - $ref: "#/components/parameters/pretty"
+ - description: "Unique 24-hexadecimal digit string that identifies the pending\
+ \ or active user in the project. If you need to lookup a user's userId or\
+ \ verify a user's status in the organization, use the Return All MongoDB\
+ \ Cloud Users in One Project resource and filter by username."
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ pattern: "^([a-f0-9]{24})$"
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/GroupUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Return One MongoDB Cloud User in One Project
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getProjectUser
/api/atlas/v2/groups/{groupId}/users/{userId}/roles:
put:
+ deprecated: true
description: "Updates the roles of the specified user in the specified project.\
\ To specify the user to update, provide the unique 24-hexadecimal digit string\
\ that identifies the user in the specified project. To use this resource,\
@@ -16472,8 +16986,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- $ref: "#/components/parameters/pretty"
- $ref: "#/components/parameters/envelope"
@@ -16503,6 +17015,114 @@ paths:
summary: Update Project Roles for One MongoDB Cloud User
tags:
- Projects
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectRoles
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
+ /api/atlas/v2/groups/{groupId}/users/{userId}:addRole:
+ post:
+ description: |-
+ Adds one project-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has been invited to join the project. To use this resource, the requesting API Key must have the Project Owner role.
+
+ **Note**: This resource cannot be used to add a role to users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: addProjectRole
+ parameters:
+ - $ref: "#/components/parameters/envelope"
+ - $ref: "#/components/parameters/groupId"
+ - $ref: "#/components/parameters/pretty"
+ - description: "Unique 24-hexadecimal digit string that identifies the pending\
+ \ or active user in the project. If you need to lookup a user's userId or\
+ \ verify a user's status in the organization, use the Return All MongoDB\
+ \ Cloud Users in One Project resource and filter by username."
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ pattern: "^([a-f0-9]{24})$"
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/AddOrRemoveGroupRole"
+ description: Project-level role to assign to the MongoDB Cloud user.
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "409":
+ $ref: "#/components/responses/conflict"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Add One Project Role to One MongoDB Cloud User
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectRole
+ /api/atlas/v2/groups/{groupId}/users/{userId}:removeRole:
+ post:
+ description: |-
+ Removes one project-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has been invited to join the project. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Project Owner role.
+
+ **Note**: This resource cannot be used to remove a role from users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: removeProjectRole
+ parameters:
+ - $ref: "#/components/parameters/envelope"
+ - $ref: "#/components/parameters/groupId"
+ - $ref: "#/components/parameters/pretty"
+ - description: "Unique 24-hexadecimal digit string that identifies the pending\
+ \ or active user in the project. If you need to lookup a user's userId or\
+ \ verify a user's status in the organization, use the Return All MongoDB\
+ \ Cloud Users in One Project resource and filter by username."
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ pattern: "^([a-f0-9]{24})$"
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/AddOrRemoveGroupRole"
+ description: Project-level role to remove from the MongoDB Cloud user.
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "409":
+ $ref: "#/components/responses/conflict"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Remove One Project Role from One MongoDB Cloud User
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectRole
/api/atlas/v2/groups/{groupId}:migrate:
post:
description: "Migrates a project from its current organization to another organization.\
@@ -16539,6 +17159,7 @@ paths:
summary: Migrate One Project to Another Organization
tags:
- Projects
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/migrateProjectToAnotherOrg
/api/atlas/v2/orgs:
get:
description: "Returns all organizations to which the requesting API Key has\
@@ -16579,6 +17200,7 @@ paths:
summary: Return All Organizations
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizations
post:
description: "Creates one organization in MongoDB Cloud and links it to the\
\ requesting API Key's organization. To use this resource, the requesting\
@@ -16620,6 +17242,7 @@ paths:
summary: Create One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganization
/api/atlas/v2/orgs/{orgId}:
delete:
description: |-
@@ -16655,6 +17278,7 @@ paths:
summary: Remove One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganization
get:
description: "Returns one organization to which the requesting API key has access.\
\ To use this resource, the requesting API Key must have the Organization\
@@ -16685,6 +17309,7 @@ paths:
summary: Return One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganization
patch:
description: "Updates one organization. To use this resource, the requesting\
\ API Key must have the Organization Owner role."
@@ -16721,6 +17346,7 @@ paths:
summary: Update One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganization
/api/atlas/v2/orgs/{orgId}/apiKeys:
get:
description: "Returns all organization API keys for the specified organization.\
@@ -16754,6 +17380,7 @@ paths:
summary: Return All Organization API Keys
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeys
post:
description: "Creates one API key for the specified organization. An organization\
\ API key grants programmatic access to an organization. You can't use the\
@@ -16789,6 +17416,7 @@ paths:
summary: Create One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey
/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}:
delete:
description: "Removes one organization API key from the specified organization.\
@@ -16810,8 +17438,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -16828,6 +17454,7 @@ paths:
summary: Remove One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKey
get:
description: "Returns one organization API key. The organization API keys grant\
\ programmatic access to an organization. You can't use the API key to log\
@@ -16848,8 +17475,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -16866,6 +17491,7 @@ paths:
summary: Return One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey
patch:
description: "Updates one organization API key in the specified organization.\
\ The organization API keys grant programmatic access to an organization.\
@@ -16886,8 +17512,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -16914,6 +17538,7 @@ paths:
summary: Update One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKey
/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList:
get:
description: "Returns all access list entries that you configured for the specified\
@@ -16937,8 +17562,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -16955,6 +17578,7 @@ paths:
summary: Return All Access List Entries for One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeyAccessListsEntries
post:
description: "Creates the access list entries for the specified organization\
\ API key. Resources require all API requests originate from IP addresses\
@@ -16975,8 +17599,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -17007,6 +17629,7 @@ paths:
summary: Create Access List Entries for One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKeyAccessList
/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}:
delete:
description: "Removes the specified access list entry from the specified organization\
@@ -17029,8 +17652,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- description: "One IP address or multiple IP addresses represented as one CIDR\
\ block to limit requests to API resources in the specified organization.\
@@ -17063,6 +17684,7 @@ paths:
summary: Remove One Access List Entry for One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry
get:
description: "Returns one access list entry for the specified organization API\
\ key. Resources require all API requests originate from IP addresses on\
@@ -17095,8 +17717,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -17115,6 +17735,7 @@ paths:
summary: Return One Access List Entry for One Organization API Key
tags:
- Programmatic API Keys
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKeyAccessList
/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage:
post:
description: Creates a query process within the Cost Explorer for the given
@@ -17148,6 +17769,9 @@ paths:
summary: Create Cost Explorer query process
tags:
- Invoices
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/createCostExplorerQueryProcess
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}:
get:
description: "Returns the usage details for a Cost Explorer query, if the query\
@@ -17193,6 +17817,9 @@ paths:
\ results are not ready yet."
tags:
- Invoices
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getCostExplorerQueryProcess
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/orgs/{orgId}/events:
get:
description: |-
@@ -17226,24 +17853,25 @@ paths:
type: boolean
default: false
- description: Date and time from when MongoDB Cloud stops returning events.
- This parameter uses the ISO 8601 timestamp format
- in UTC.
+ This parameter uses the ISO 8601 timestamp format in UTC.
in: query
name: maxDate
schema:
type: string
format: date-time
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
- description: Date and time from when MongoDB Cloud starts returning events.
- This parameter uses the ISO 8601 timestamp format
- in UTC.
+ This parameter uses the ISO 8601 timestamp format in UTC.
in: query
name: minDate
schema:
type: string
format: date-time
- example: 2021-11-17T23:15:00.06Z
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
responses:
"200":
content:
@@ -17259,6 +17887,7 @@ paths:
summary: Return All Events from One Organization
tags:
- Events
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents
/api/atlas/v2/orgs/{orgId}/events/{eventId}:
get:
description: |-
@@ -17278,8 +17907,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- description: Flag that indicates whether to include the raw document in the
output. The raw document contains additional meta information about the
@@ -17306,6 +17933,7 @@ paths:
summary: Return One Event from One Organization
tags:
- Events
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getOrganizationEvent
/api/atlas/v2/orgs/{orgId}/federationSettings:
get:
description: "Returns information about the federation settings for the specified\
@@ -17335,6 +17963,9 @@ paths:
summary: Return Federation Settings for One Organization
tags:
- Federated Authentication
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettings
+ x-xgen-IPA-exception:
+ xgen-IPA-113-singleton-must-not-have-id: API predates IPA validation
/api/atlas/v2/orgs/{orgId}/groups:
get:
description: |-
@@ -17380,8 +18011,10 @@ paths:
summary: Return One or More Projects in One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationProjects
/api/atlas/v2/orgs/{orgId}/invites:
get:
+ deprecated: true
description: "Returns all pending invitations to the specified organization.\
\ To use this resource, the requesting API Key must have the Organization\
\ Owner role."
@@ -17418,7 +18051,10 @@ paths:
summary: Return All Organization Invitations
tags:
- Organizations
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationInvitations
patch:
+ deprecated: true
description: "Updates the details of one pending invitation to the specified\
\ organization. To specify which invitation, provide the username of the invited\
\ user. To use this resource, the requesting API Key must have the Organization\
@@ -17455,7 +18091,10 @@ paths:
summary: Update One Organization Invitation
tags:
- Organizations
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitation
post:
+ deprecated: true
description: "Invites one MongoDB Cloud user to join the specified organization.\
\ The user must accept the invitation to access information within the specified\
\ organization. To use this resource, the requesting API Key must have the\
@@ -17491,8 +18130,11 @@ paths:
summary: Invite One MongoDB Cloud User to Join One Atlas Organization
tags:
- Organizations
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganizationInvitation
/api/atlas/v2/orgs/{orgId}/invites/{invitationId}:
delete:
+ deprecated: true
description: "Cancels one pending invitation sent to the specified MongoDB Cloud\
\ user to join an organization. You can't cancel an invitation that the user\
\ accepted. To use this resource, the requesting API Key must have the Organization\
@@ -17527,7 +18169,10 @@ paths:
summary: Cancel One Organization Invitation
tags:
- Organizations
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganizationInvitation
get:
+ deprecated: true
description: "Returns the details of one pending invitation to the specified\
\ organization. To use this resource, the requesting API Key must have the\
\ Organization Owner role."
@@ -17541,8 +18186,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -17563,7 +18206,10 @@ paths:
summary: Return One Organization Invitation
tags:
- Organizations
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationInvitation
patch:
+ deprecated: true
description: "Updates the details of one pending invitation to the specified\
\ organization. To specify which invitation, provide the unique identification\
\ string for that invitation. Use the Return All Organization Invitations\
@@ -17580,8 +18226,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -17610,6 +18254,8 @@ paths:
summary: Update One Organization Invitation by Invitation ID
tags:
- Organizations
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitationById
/api/atlas/v2/orgs/{orgId}/invoices:
get:
description: |-
@@ -17688,6 +18334,9 @@ paths:
enum:
- desc
- asc
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
responses:
"200":
content:
@@ -17705,6 +18354,7 @@ paths:
summary: Return All Invoices for One Organization
tags:
- Invoices
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listInvoices
/api/atlas/v2/orgs/{orgId}/invoices/pending:
get:
description: "Returns all invoices accruing charges for the current billing\
@@ -17735,6 +18385,9 @@ paths:
summary: Return All Pending Invoices for One Organization
tags:
- Invoices
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listPendingInvoices
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}:
get:
description: |-
@@ -17753,8 +18406,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -17777,6 +18428,7 @@ paths:
summary: Return One Organization Invoice
tags:
- Invoices
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getInvoice
/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv:
get:
description: |-
@@ -17820,6 +18472,7 @@ paths:
summary: Return One Organization Invoice as CSV
tags:
- Invoices
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/downloadInvoiceCsv
/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search:
get:
description: Query the lineItems of the specified invoice and return the result
@@ -17838,8 +18491,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -17867,6 +18518,7 @@ paths:
summary: Query lineItems of the specified invoiceId
tags:
- Invoices
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/queryLineItemsFromSingleInvoice
/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects:
get:
description: Return all projects that you can migrate to the specified organization.
@@ -17894,6 +18546,9 @@ paths:
summary: Return All Projects Available for Migration
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/listSourceProjects
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens:
delete:
description: Remove one organization link and its associated public API key.
@@ -17922,6 +18577,7 @@ paths:
summary: Remove One Link-Token
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/deleteLinkToken
post:
description: Create one link-token that contains all the information required
to complete the link. MongoDB Atlas uses the link-token for push live migrations
@@ -17957,6 +18613,10 @@ paths:
summary: Create One Link-Token
tags:
- Cloud Migration Service
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createLinkToken
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/orgs/{orgId}/nonCompliantResources:
get:
description: Return all non-compliant resources for an org.
@@ -17989,6 +18649,7 @@ paths:
summary: Return all non-compliant resources
tags:
- Resource Policies
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getResourcesNonCompliant
/api/atlas/v2/orgs/{orgId}/resourcePolicies:
get:
description: Return all Atlas Resource Policies for the org.
@@ -18021,6 +18682,7 @@ paths:
summary: Return all Atlas Resource Policies
tags:
- Resource Policies
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicies
post:
description: Create one Atlas Resource Policy for an org.
externalDocs:
@@ -18063,6 +18725,7 @@ paths:
summary: Create one Atlas Resource Policy
tags:
- Resource Policies
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/createAtlasResourcePolicy
/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}:
delete:
description: Delete one Atlas Resource Policy for an org.
@@ -18084,8 +18747,6 @@ paths:
description: Unique 24-hexadecimal character string that identifies the
atlas resource policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
responses:
@@ -18107,6 +18768,7 @@ paths:
summary: Delete one Atlas Resource Policy
tags:
- Resource Policies
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteAtlasResourcePolicy
get:
description: Return one Atlas Resource Policy for an org.
externalDocs:
@@ -18127,8 +18789,6 @@ paths:
description: Unique 24-hexadecimal character string that identifies the
atlas resource policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
responses:
@@ -18150,6 +18810,7 @@ paths:
summary: Return one Atlas Resource Policy
tags:
- Resource Policies
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicy
patch:
description: Update one Atlas Resource Policy for an org.
externalDocs:
@@ -18170,8 +18831,6 @@ paths:
description: Unique 24-hexadecimal character string that identifies the
atlas resource policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
requestBody:
@@ -18206,6 +18865,7 @@ paths:
summary: Update one Atlas Resource Policy
tags:
- Resource Policies
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/updateAtlasResourcePolicy
/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate:
post:
description: Validate one Atlas Resource Policy for an org.
@@ -18249,6 +18909,7 @@ paths:
summary: Validate one Atlas Resource Policy
tags:
- Resource Policies
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/validateAtlasResourcePolicy
/api/atlas/v2/orgs/{orgId}/serviceAccounts:
get:
description: Returns all Service Accounts for the specified Organization. Available
@@ -18277,6 +18938,7 @@ paths:
summary: List All Organization Service Accounts
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccounts
post:
description: Creates one Service Account for the specified Organization. Available
as a preview feature.
@@ -18309,6 +18971,7 @@ paths:
summary: Create one Organization Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccount
/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}:
delete:
description: Deletes the specified Service Account. Available as a preview feature.
@@ -18340,6 +19003,7 @@ paths:
summary: Delete one Organization Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccount
get:
description: Returns the specified Service Account. Available as a preview feature.
operationId: getServiceAccount
@@ -18372,6 +19036,7 @@ paths:
summary: Get one Organization Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getServiceAccount
patch:
description: Updates the specified Service Account in the specified Organization.
Available as a preview feature.
@@ -18414,6 +19079,7 @@ paths:
summary: Update one Organization Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateServiceAccount
/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList:
get:
description: Returns all access list entries that you configured for the specified
@@ -18449,6 +19115,7 @@ paths:
summary: Return All Access List entries for one Organization Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountAccessList
post:
description: Add Access List Entries for the specified Service Account for the
organization. Resources require all API requests to originate from IP addresses
@@ -18499,6 +19166,9 @@ paths:
summary: Add Access List entries for one Organization Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountAccessList
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}:
delete:
description: Removes the specified access list entry from the specified Service
@@ -18545,6 +19215,7 @@ paths:
summary: Remove One Access List entry from one Organization Service Account
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountAccessListEntry
/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups:
get:
description: Returns a list of all projects the specified Service Account is
@@ -18581,6 +19252,7 @@ paths:
summary: Return All Service Account Project assignments
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountProjects
/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets:
post:
description: Create a secret for the specified Service Account. Available as
@@ -18622,6 +19294,9 @@ paths:
summary: Create one Organization Service Account Secret
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountSecret
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}:
delete:
description: Deletes the specified Service Account secret. Available as a preview
@@ -18660,6 +19335,7 @@ paths:
summary: Delete a Organization Service Account Secret
tags:
- Service Accounts
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountSecret
/api/atlas/v2/orgs/{orgId}/settings:
get:
description: "Returns details about the specified organization's settings. To\
@@ -18689,6 +19365,7 @@ paths:
summary: Return Settings for One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationSettings
patch:
description: "Updates the organization's settings. To use this resource, the\
\ requesting API Key must have the Organization Owner role."
@@ -18725,6 +19402,7 @@ paths:
summary: Update Settings for One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationSettings
/api/atlas/v2/orgs/{orgId}/teams:
get:
description: "Returns all teams that belong to the specified organization. Teams\
@@ -18761,6 +19439,7 @@ paths:
summary: Return All Teams in One Organization
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listOrganizationTeams
post:
description: "Creates one team in the specified organization. Teams enable you\
\ to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits\
@@ -18802,6 +19481,7 @@ paths:
summary: Create One Team in One Organization
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/createTeam
/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}:
get:
description: "Returns one team that you identified using its human-readable\
@@ -18841,6 +19521,9 @@ paths:
summary: Return One Team using its Name
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamByName
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/orgs/{orgId}/teams/{teamId}:
delete:
description: "Removes one team specified using its unique 24-hexadecimal digit\
@@ -18862,8 +19545,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -18884,6 +19565,7 @@ paths:
summary: Remove One Team from One Organization
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/deleteTeam
get:
description: "Returns one team that you identified using its unique 24-hexadecimal\
\ digit ID. This team belongs to one organization. Teams enable you to grant\
@@ -18904,8 +19586,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -18926,6 +19606,7 @@ paths:
summary: Return One Team using its ID
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamById
patch:
description: "Renames one team in the specified organization. Teams enable you\
\ to grant project access roles to MongoDB Cloud users. To use this resource,\
@@ -18945,8 +19626,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -18976,13 +19655,14 @@ paths:
summary: Rename One Team
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameTeam
/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users:
get:
description: "Returns all MongoDB Cloud users assigned to the team specified\
\ using its unique 24-hexadecimal digit identifier. This team belongs to one\
\ organization. Teams enable you to grant project access roles to MongoDB\
\ Cloud users. To use this resource, the requesting API Key must have the\
- \ Organization Member role."
+ \ Organization Member role. Deprecated versions: v2-{2023-01-01}"
externalDocs:
description: Manage Organization Teams
url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
@@ -19000,16 +19680,14 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
content:
- application/vnd.atlas.2023-01-01+json:
+ application/vnd.atlas.2043-01-01+json:
schema:
- $ref: "#/components/schemas/PaginatedAppUserView"
- x-xgen-version: 2023-01-01
+ $ref: "#/components/schemas/PaginatedOrgUserView"
+ x-xgen-version: 2043-01-01
description: OK
"400":
$ref: "#/components/responses/badRequest"
@@ -19024,7 +19702,9 @@ paths:
summary: Return All MongoDB Cloud Users Assigned to One Team
tags:
- Teams
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listTeamUsers
post:
+ deprecated: true
description: "Adds one or more MongoDB Cloud users from the specified organization\
\ to the specified team. Teams enable you to grant project access roles to\
\ MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one\
@@ -19045,8 +19725,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
requestBody:
content:
@@ -19079,8 +19757,13 @@ paths:
summary: Assign MongoDB Cloud Users from One Organization to One Team
tags:
- Teams
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addTeamUser
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}:
delete:
+ deprecated: true
description: "Removes one MongoDB Cloud user from the specified team. This team\
\ belongs to one organization. Teams enable you to grant project access roles\
\ to MongoDB Cloud users. To use this resource, the requesting API Key must\
@@ -19100,8 +19783,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- description: Unique 24-hexadecimal digit string that identifies MongoDB Cloud
user that you want to remove from the specified team.
@@ -19110,8 +19791,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
@@ -19130,13 +19809,113 @@ paths:
summary: Remove One MongoDB Cloud User from One Team
tags:
- Teams
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeTeamUser
+ /api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser:
+ post:
+ description: |-
+ Adds one MongoDB Cloud user to one team. You can add an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.
+
+ **Note**: This resource cannot be used to add a user invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: addUserToTeam
+ parameters:
+ - $ref: "#/components/parameters/envelope"
+ - $ref: "#/components/parameters/orgId"
+ - $ref: "#/components/parameters/pretty"
+ - description: Unique 24-hexadecimal digit string that identifies the team to
+ add the MongoDB Cloud user to.
+ in: path
+ name: teamId
+ required: true
+ schema:
+ type: string
+ pattern: "^([a-f0-9]{24})$"
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/AddOrRemoveUserFromTeam"
+ description: The active or pending MongoDB Cloud user that you want to add
+ to the specified team.
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Add One MongoDB Cloud User to One Team
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addUserToTeam
+ /api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser:
+ post:
+ description: |-
+ Removes one MongoDB Cloud user from one team. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.
+
+ **Note**: This resource cannot be used to remove a user invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: removeUserFromTeam
+ parameters:
+ - $ref: "#/components/parameters/envelope"
+ - $ref: "#/components/parameters/orgId"
+ - $ref: "#/components/parameters/pretty"
+ - description: Unique 24-hexadecimal digit string that identifies the team to
+ remove the MongoDB user from.
+ in: path
+ name: teamId
+ required: true
+ schema:
+ type: string
+ pattern: "^([a-f0-9]{24})$"
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/AddOrRemoveUserFromTeam"
+ description: The id of the active or pending MongoDB Cloud user that you want
+ to remove from the specified team.
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Remove One MongoDB Cloud User from One Team
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeUserFromTeam
/api/atlas/v2/orgs/{orgId}/users:
get:
description: "Returns details about the MongoDB Cloud users associated with\
\ the specified organization. Each MongoDB Cloud user returned must belong\
\ to the specified organization or to a project within the specified organization.\
\ To use this resource, the requesting API Key must have the Organization\
- \ Member role."
+ \ Member role. Deprecated versions: v2-{2023-01-01}"
operationId: listOrganizationUsers
parameters:
- $ref: "#/components/parameters/envelope"
@@ -19148,10 +19927,10 @@ paths:
responses:
"200":
content:
- application/vnd.atlas.2023-01-01+json:
+ application/vnd.atlas.2043-01-01+json:
schema:
- $ref: "#/components/schemas/PaginatedAppUserView"
- x-xgen-version: 2023-01-01
+ $ref: "#/components/schemas/PaginatedOrgUserView"
+ x-xgen-version: 2043-01-01
description: OK
"400":
$ref: "#/components/responses/badRequest"
@@ -19164,11 +19943,53 @@ paths:
summary: Return All MongoDB Cloud Users in One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationUsers
+ post:
+ description: |-
+ Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting API Key must have the Organization Owner role.
+
+ **Note**: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization.
+ operationId: createOrganizationUser
+ parameters:
+ - $ref: "#/components/parameters/envelope"
+ - $ref: "#/components/parameters/orgId"
+ - $ref: "#/components/parameters/pretty"
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserRequest"
+ description: Represents the MongoDB Cloud user to be created within the organization.
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: Created
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "409":
+ $ref: "#/components/responses/conflict"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Add One MongoDB Cloud User to One Organization
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrganizationUser
/api/atlas/v2/orgs/{orgId}/users/{userId}:
delete:
description: "Removes one MongoDB Cloud user from the specified organization.\
\ To use this resource, the requesting API Key must have the Organization\
- \ User Admin role."
+ \ User Admin role. Deprecated versions: v2-{2023-01-01}"
operationId: removeOrganizationUser
parameters:
- $ref: "#/components/parameters/envelope"
@@ -19181,16 +20002,14 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"204":
content:
- application/vnd.atlas.2023-01-01+json:
+ application/vnd.atlas.2043-01-01+json:
schema:
$ref: "#/components/schemas/NoBody"
- x-xgen-version: 2023-01-01
+ x-xgen-version: 2043-01-01
description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
@@ -19205,8 +20024,105 @@ paths:
summary: Remove One MongoDB Cloud User From One Organization
tags:
- Organizations
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/removeOrganizationUser
+ get:
+ description: |-
+ Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting API Key must have the Organization Member role.
+
+ **Note**: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint.
+
+ **Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: getOrganizationUser
+ parameters:
+ - $ref: "#/components/parameters/envelope"
+ - $ref: "#/components/parameters/orgId"
+ - $ref: "#/components/parameters/pretty"
+ - description: "Unique 24-hexadecimal digit string that identifies the pending\
+ \ or active user in the organization. If you need to lookup a user's userId\
+ \ or verify a user's status in the organization, use the Return All MongoDB\
+ \ Cloud Users in One Organization resource and filter by username."
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ pattern: "^([a-f0-9]{24})$"
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Return One MongoDB Cloud User in One Organization
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrganizationUser
+ patch:
+ description: |-
+ Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.
+
+ **Note**: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user.
+
+ **Note**: This resource cannot be used to update pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: updateOrganizationUser
+ parameters:
+ - $ref: "#/components/parameters/envelope"
+ - $ref: "#/components/parameters/orgId"
+ - $ref: "#/components/parameters/pretty"
+ - description: "Unique 24-hexadecimal digit string that identifies the pending\
+ \ or active user in the organization. If you need to lookup a user's userId\
+ \ or verify a user's status in the organization, use the Return All MongoDB\
+ \ Cloud Users in One Organization resource and filter by username."
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ pattern: "^([a-f0-9]{24})$"
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserUpdateRequest"
+ description: Represents the roles and teams to assign the MongoDB Cloud user.
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Update One MongoDB Cloud User in One Organization
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser
/api/atlas/v2/orgs/{orgId}/users/{userId}/roles:
put:
+ deprecated: true
description: "Updates the roles of the specified user in the specified organization.\
\ To specify the user to update, provide the unique 24-hexadecimal digit string\
\ that identifies the user in the specified organization. To use this resource,\
@@ -19221,8 +20137,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
- $ref: "#/components/parameters/pretty"
- $ref: "#/components/parameters/envelope"
@@ -19252,6 +20166,116 @@ paths:
summary: Update Organization Roles for One MongoDB Cloud User
tags:
- Organizations
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationRoles
+ x-xgen-IPA-exception:
+ xgen-IPA-104-resource-has-GET: API predates IPA validation
+ /api/atlas/v2/orgs/{orgId}/users/{userId}:addRole:
+ post:
+ description: |-
+ Adds one organization-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.
+
+ **Note**: This operation is atomic.
+
+ **Note**: This resource cannot be used to add a role to users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: addOrganizationRole
+ parameters:
+ - $ref: "#/components/parameters/envelope"
+ - $ref: "#/components/parameters/orgId"
+ - $ref: "#/components/parameters/pretty"
+ - description: "Unique 24-hexadecimal digit string that identifies the pending\
+ \ or active user in the organization. If you need to lookup a user's userId\
+ \ or verify a user's status in the organization, use the Return All MongoDB\
+ \ Cloud Users in One Organization resource and filter by username."
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ pattern: "^([a-f0-9]{24})$"
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/AddOrRemoveOrgRole"
+ description: Organization-level role to assign to the MongoDB Cloud user.
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "409":
+ $ref: "#/components/responses/conflict"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Add One Organization Role to One MongoDB Cloud User
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrganizationRole
+ /api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole:
+ post:
+ description: |-
+ Removes one organization-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Organization Owner role.
+
+ **Note**: This operation is atomic.
+
+ **Note**: This resource cannot be used to remove a role from users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
+ operationId: removeOrganizationRole
+ parameters:
+ - $ref: "#/components/parameters/envelope"
+ - $ref: "#/components/parameters/orgId"
+ - $ref: "#/components/parameters/pretty"
+ - description: "Unique 24-hexadecimal digit string that identifies the pending\
+ \ or active user in the organization. If you need to lookup a user's userId\
+ \ or verify a user's status in the organization, use the Return All MongoDB\
+ \ Cloud Users in One Organization resource and filter by username."
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ pattern: "^([a-f0-9]{24})$"
+ requestBody:
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/AddOrRemoveOrgRole"
+ description: Organization-level role to remove from the MongoDB Cloud user.
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2043-01-01+json:
+ schema:
+ $ref: "#/components/schemas/OrgUserResponse"
+ x-xgen-version: 2043-01-01
+ description: OK
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ summary: Remove One Organization Role from One MongoDB Cloud User
+ tags:
+ - MongoDB Cloud Users
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationRole
/api/atlas/v2/unauth/controlPlaneIPAddresses:
get:
description: Returns all control plane IP addresses.
@@ -19272,8 +20296,54 @@ paths:
summary: Return All Control Plane IP Addresses
tags:
- Root
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/returnAllControlPlaneIpAddresses
+ /api/atlas/v2/unauth/openapi/versions:
+ get:
+ description: API that provides a list of available versionsfor a given environment.
+ operationId: getApiVersions
+ parameters:
+ - $ref: "#/components/parameters/envelope"
+ - $ref: "#/components/parameters/itemsPerPage"
+ - $ref: "#/components/parameters/pageNum"
+ - $ref: "#/components/parameters/pretty"
+ - description: "The environment to get the versions from. If not provided, it\
+ \ returnsthe versions for the given MongoDB URL. (E.g. prod for cloud.mongodb.com)"
+ in: query
+ name: env
+ schema:
+ type: string
+ enum:
+ - dev
+ - qa
+ - prod
+ - stage
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
+ responses:
+ "200":
+ content:
+ application/vnd.atlas.2024-08-05+json:
+ schema:
+ $ref: "#/components/schemas/PaginatedApiVersions"
+ x-xgen-version: 2024-08-05
+ application/vnd.atlas.2024-08-05+yaml:
+ schema:
+ $ref: "#/components/schemas/PaginatedApiVersions"
+ x-xgen-version: 2024-08-05
+ description: OK
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ security: []
+ summary: Provides a list of versions for a given environment.
+ tags:
+ - OpenAPI
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/OpenAPI/operation/getApiVersions
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/users:
post:
+ deprecated: true
description: |-
Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.
@@ -19308,8 +20378,11 @@ paths:
summary: Create One MongoDB Cloud User
tags:
- MongoDB Cloud Users
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createUser
/api/atlas/v2/users/byName/{userName}:
get:
+ deprecated: true
description: "Returns the details for one MongoDB Cloud user account with the\
\ specified username. You can't use this endpoint to return information about\
\ an API Key. To return information about an API Key, use the [Return One\
@@ -19345,8 +20418,13 @@ paths:
summary: Return One MongoDB Cloud User using Their Username
tags:
- MongoDB Cloud Users
+ x-sunset: 2026-07-31
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUserByUsername
+ x-xgen-IPA-exception:
+ xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation
/api/atlas/v2/users/{userId}:
get:
+ deprecated: true
description: "Returns the details for one MongoDB Cloud user account with the\
\ specified unique identifier for the user. You can't use this endpoint to\
\ return information on an API Key. To return information about an API Key,\
@@ -19365,8 +20443,6 @@ paths:
required: true
schema:
type: string
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
responses:
"200":
@@ -19385,6 +20461,8 @@ paths:
summary: Return One MongoDB Cloud User using Its ID
tags:
- MongoDB Cloud Users
+ x-sunset: 2044-01-01
+ x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUser
components:
parameters:
collectionName:
@@ -19434,8 +20512,6 @@ components:
schema:
type: string
example: 55fa922fb343282757d9554e
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
granularity:
description: Duration that specifies the interval at which Atlas reports the
@@ -19458,8 +20534,6 @@ components:
schema:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
identityProviderId:
description: Legacy 20-hexadecimal digit string that identifies the identity
@@ -19472,8 +20546,6 @@ components:
schema:
type: string
example: c2777a9eca931f29fc2f
- maxLength: 20
- minLength: 20
pattern: "^([a-f0-9]{20})$"
includeCount:
description: Flag that indicates whether the response returns the total number
@@ -19512,8 +20584,6 @@ components:
schema:
type: string
example: 6296fb4c7c7aa997cf94e9a8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
orgId:
description: "Unique 24-hexadecimal digit string that identifies the organization\
@@ -19526,8 +20596,6 @@ components:
schema:
type: string
example: 4888442a3354817a7320eb61
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
pageNum:
description: Number of the page that displays the current set of the total objects
@@ -19788,7 +20856,6 @@ components:
type: string
description: Unique string that identifies the MongoDB Cloud VPC on AWS.
example: vpc-b555d3b0d9cb783b0
- minLength: 5
pattern: "^vpc-[0-9a-f]{17}$"
readOnly: true
description: Collection of settings that configures the network container for
@@ -20239,10 +21306,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the interface
endpoint.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
readOnly: true
required:
- cloudProvider
@@ -20323,14 +21386,16 @@ components:
- CA_WEST_1
- GLOBAL
title: AWS Regions
+ requirePrivateNetworking:
+ type: boolean
+ description: Enable connection to your Amazon Web Services (AWS) Key Management
+ Service (KMS) over private networking.
roleId:
type: string
description: Unique 24-hexadecimal digit string that identifies an Amazon
Web Services (AWS) Identity and Access Management (IAM) role. This IAM
role has the permissions required to manage your AWS customer master key.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
writeOnly: true
secretAccessKey:
@@ -20344,6 +21409,145 @@ components:
description: Flag that indicates whether the Amazon Web Services (AWS) Key
Management Service (KMS) encryption key can encrypt and decrypt data.
readOnly: true
+ AWSKMSEARPrivateEndpoint:
+ type: object
+ description: AWS Key Management Service Encryption At Rest Private Endpoint.
+ properties:
+ cloudProvider:
+ type: string
+ description: Human-readable label that identifies the cloud provider for
+ the Encryption At Rest private endpoint.
+ enum:
+ - AZURE
+ - AWS
+ readOnly: true
+ errorMessage:
+ type: string
+ description: Error message for failures associated with the Encryption At
+ Rest private endpoint.
+ readOnly: true
+ id:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the Private
+ Endpoint Service.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ regionName:
+ type: object
+ description: Cloud provider region in which the Encryption At Rest private
+ endpoint is located.
+ oneOf:
+ - type: string
+ description: Microsoft Azure Regions.
+ enum:
+ - 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_CENTRAL
+ - GERMANY_NORTH_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
+ title: Azure Regions
+ - type: string
+ description: "Physical location where MongoDB Cloud deploys your AWS-hosted\
+ \ MongoDB cluster nodes. The region you choose can affect network latency\
+ \ for clients accessing your databases. 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. MongoDB Cloud assigns the VPC a CIDR block. To\
+ \ limit a new VPC peering connection to one CIDR block and region, create\
+ \ the connection first. Deploy the cluster after the connection starts."
+ enum:
+ - 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
+ - GLOBAL
+ title: AWS Regions
+ status:
+ type: string
+ description: State of the Encryption At Rest private endpoint.
+ enum:
+ - INITIATING
+ - PENDING_ACCEPTANCE
+ - ACTIVE
+ - FAILED
+ - PENDING_RECREATION
+ - DELETING
+ readOnly: true
+ title: AWS Key Management Service EAR Private Endpoint
AWSPrivateLinkConnection:
type: object
description: Group of Private Endpoint Service settings.
@@ -20373,8 +21577,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the Private
Endpoint Service.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
interfaceEndpoints:
@@ -20386,8 +21588,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the interface
endpoint.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
readOnly: true
@@ -20468,10 +21668,12 @@ components:
type: string
format: date-time
description: Date and time until which this alert has been acknowledged.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC. The resource returns this parameter if a MongoDB User previously
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC. The resource returns this parameter if a MongoDB User previously
acknowledged this alert.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
acknowledgementComment:
type: string
description: Comment that a MongoDB Cloud user submitted when acknowledging
@@ -20510,6 +21712,9 @@ components:
- GROUP_DATA_ACCESS_READ_ONLY
- GROUP_READ_ONLY
- GROUP_SEARCH_INDEX_EDITOR
+ - GROUP_BACKUP_MANAGER
+ - GROUP_OBSERVABILITY_VIEWER
+ - GROUP_DATABASE_ACCESS_ADMIN
required:
- groupRole
AddOrRemoveOrgRole:
@@ -20535,8 +21740,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud user.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
writeOnly: true
required:
@@ -20549,8 +21752,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud user.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
required:
- id
@@ -20696,16 +21897,12 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
labels:
@@ -20749,8 +21946,6 @@ components:
name:
type: string
description: Human-readable label that identifies the advanced cluster.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
paused:
type: boolean
@@ -20860,8 +22055,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this backup
policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
policyItems:
type: array
@@ -20877,27 +22070,24 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
associated with the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/AlertAuditTypeView"
@@ -20906,16 +22096,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -20940,138 +22126,128 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- readOnly: true
- raw:
- $ref: "#/components/schemas/raw"
- remoteAddress:
- type: string
- description: IPv4 or IPv6 address from which the user triggered this event.
- example: 216.172.40.186
- pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
- readOnly: true
- userId:
- type: string
- description: "Unique 24-hexadecimal digit string that identifies the console\
- \ user who triggered the event. If this resource returns this parameter,\
- \ it doesn't return the **apiKeyId** parameter."
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
- readOnly: true
- username:
- type: string
- format: email
- description: "Email address for the user who triggered this event. If this\
- \ resource returns this parameter, it doesn't return the **publicApiKey**\
+ description: "Public part of the API Key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
+ readOnly: true
+ raw:
+ $ref: "#/components/schemas/raw"
+ remoteAddress:
+ type: string
+ description: IPv4 or IPv6 address from which the user triggered this event.
+ example: 216.172.40.186
+ pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
+ readOnly: true
+ userId:
+ type: string
+ description: "Unique 24-hexadecimal digit string that identifies the console\
+ \ user who triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **apiKeyId** parameter."
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ username:
+ type: string
+ format: email
+ description: "Email address for the user who triggered this event. If this\
+ \ resource returns this parameter, it doesn't return the **publicApiKey**\
+ \ parameter."
+ readOnly: true
+ required:
+ - created
+ - eventTypeName
+ - id
+ title: Alert Audits
+ AlertAuditTypeView:
+ type: string
+ description: Unique identifier of event type.
+ enum:
+ - ALERT_ACKNOWLEDGED_AUDIT
+ - ALERT_UNACKNOWLEDGED_AUDIT
+ example: ALERT_ACKNOWLEDGED_AUDIT
+ title: Alert Audit Types
+ AlertConfigAudit:
+ type: object
+ description: Alert config audit indicates any activities around alert settings.
+ properties:
+ alertConfigId:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the alert
+ configuration associated with the **alertId**.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ apiKeyId:
+ type: string
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ created:
+ type: string
+ format: date-time
+ description: Date and time when this event occurred. This parameter expresses
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
+ readOnly: true
+ eventTypeName:
+ $ref: "#/components/schemas/AlertConfigAuditTypeView"
+ groupId:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the project
+ in which the event occurred. The **eventId** identifies the specific event.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ id:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the event.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ isGlobalAdmin:
+ type: boolean
+ default: false
+ description: Flag that indicates whether a MongoDB employee triggered the
+ specified event.
+ readOnly: true
+ links:
+ type: array
+ 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."
+ externalDocs:
+ description: Web Linking Specification (RFC 5988)
+ url: https://datatracker.ietf.org/doc/html/rfc5988
+ items:
+ $ref: "#/components/schemas/Link"
+ readOnly: true
+ orgId:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the organization
+ to which these events apply.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ publicKey:
+ type: string
+ format: email
+ description: "Public part of the API Key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
\ parameter."
- example: test.user@mongodb.com
- readOnly: true
- required:
- - created
- - eventTypeName
- - id
- title: Alert Audits
- AlertAuditTypeView:
- type: string
- description: Unique identifier of event type.
- enum:
- - ALERT_ACKNOWLEDGED_AUDIT
- - ALERT_UNACKNOWLEDGED_AUDIT
- example: ALERT_ACKNOWLEDGED_AUDIT
- title: Alert Audit Types
- AlertConfigAudit:
- type: object
- description: Alert config audit indicates any activities around alert settings.
- properties:
- alertConfigId:
- type: string
- description: Unique 24-hexadecimal digit string that identifies the alert
- configuration associated with the **alertId**.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
- readOnly: true
- apiKeyId:
- type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
- readOnly: true
- created:
- type: string
- format: date-time
- description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
- readOnly: true
- eventTypeName:
- $ref: "#/components/schemas/AlertConfigAuditTypeView"
- groupId:
- type: string
- description: Unique 24-hexadecimal digit string that identifies the project
- in which the event occurred. The **eventId** identifies the specific event.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
- readOnly: true
- id:
- type: string
- description: Unique 24-hexadecimal digit string that identifies the event.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
- readOnly: true
- isGlobalAdmin:
- type: boolean
- default: false
- description: Flag that indicates whether a MongoDB employee triggered the
- specified event.
- readOnly: true
- links:
- type: array
- 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."
externalDocs:
- description: Web Linking Specification (RFC 5988)
- url: https://datatracker.ietf.org/doc/html/rfc5988
- items:
- $ref: "#/components/schemas/Link"
- readOnly: true
- orgId:
- type: string
- description: Unique 24-hexadecimal digit string that identifies the organization
- to which these events apply.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
- readOnly: true
- publicKey:
- type: string
- format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -21087,8 +22263,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -21097,7 +22271,6 @@ components:
description: "Email address for the user who triggered this event. If this\
\ resource returns this parameter, it doesn't return the **publicApiKey**\
\ parameter."
- example: test.user@mongodb.com
readOnly: true
required:
- created
@@ -21124,9 +22297,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -21141,8 +22316,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -21150,8 +22323,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -21179,9 +22350,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- notifications
@@ -21228,11 +22401,14 @@ components:
type: string
format: date-time
description: |-
- Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
+ Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
- To acknowledge this alert forever, set the parameter value to 100 years in the future.
- To unacknowledge a previously acknowledged alert, do not set this parameter value.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
acknowledgementComment:
type: string
description: Comment that a MongoDB Cloud user submitted when acknowledging
@@ -21251,43 +22427,40 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration that sets this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when MongoDB Cloud created this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
groupId:
type: string
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lastNotified:
type: string
format: date-time
description: Date and time that any notifications were last sent for this
- alert. This parameter expresses its value in the ISO 8601 timestamp format
+ alert. This parameter expresses its value in the ISO 8601 timestamp format
in UTC. The resource returns this parameter if MongoDB Cloud has sent
notifications for this alert.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
links:
type: array
@@ -21305,18 +22478,18 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization that owns the project to which this alert applies.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
resolved:
type: string
format: date-time
description: "Date and time that this alert changed to `\"status\" : \"\
- CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
+ CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
\ format in UTC. The resource returns this parameter once `\"status\"\
\ : \"CLOSED\"`."
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
status:
type: string
@@ -21332,9 +22505,10 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- alertConfigId
@@ -21441,6 +22615,9 @@ components:
- thousand
- million
- billion
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
title: Threshold
AlertsToggle:
type: object
@@ -21460,8 +22637,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the cluster
that contains the checkpoint.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
completed:
@@ -21476,16 +22651,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns the checkpoints.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies checkpoint.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -21713,8 +22884,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization the resource belongs to.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
resourceId:
@@ -21722,8 +22891,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
non-compliant resource.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
resourceName:
@@ -21742,6 +22909,8 @@ components:
type: string
description: Human-readable label that displays the type of a resource.
enum:
+ - DEPRECATED_PROJECT
+ - DEPRECATED_CLUSTER
- PROJECT
- CLUSTER
readOnly: true
@@ -21770,8 +22939,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
ApiAtlasPolicyView:
@@ -21795,13 +22962,14 @@ components:
description: Unique 24-hexadecimal character string that identifies the
policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
ApiAtlasResourcePolicyCreateView:
type: object
properties:
+ description:
+ type: string
+ description: Description of the atlas resource policy.
name:
type: string
description: Human-readable label that describes the atlas resource policy.
@@ -21816,6 +22984,9 @@ components:
ApiAtlasResourcePolicyEditView:
type: object
properties:
+ description:
+ type: string
+ description: Description of the atlas resource policy.
name:
type: string
description: Human-readable label that describes the atlas resource policy.
@@ -21839,8 +23010,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
atlas resource policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
resourcePolicyName:
@@ -21858,13 +23027,15 @@ components:
description: Date and time in UTC when the atlas resource policy was created.
example: 2022-01-01T00:00:00Z
readOnly: true
+ description:
+ type: string
+ description: Description of the atlas resource policy.
+ readOnly: true
id:
type: string
description: Unique 24-hexadecimal character string that identifies the
atlas resource policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lastUpdatedByUser:
@@ -21885,8 +23056,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization the atlas resource policy belongs to.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
policies:
@@ -21919,8 +23088,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the cluster
with the snapshot you want to return.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
dailySnapshotRetentionDays:
type: integer
@@ -21946,8 +23113,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that contains the cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -22045,8 +23210,6 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies a user.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
name:
@@ -22157,8 +23320,6 @@ components:
The project contains MongoDB processes that you want to return. The MongoDB
process can be either the `mongod` or `mongos`.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
hostname:
@@ -22261,8 +23422,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this organization
API key.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
@@ -22300,8 +23459,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this organization
API key assigned to this project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -22371,8 +23528,6 @@ components:
The project contains MongoDB processes that you want to return. The MongoDB
process can be either the `mongod` or `mongos`.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
hostId:
@@ -22443,8 +23598,6 @@ components:
description: Unique 22-character alphanumeric string that identifies the
private endpoint.
example: vpce-3bf78b0ddee411ba1
- maxLength: 22
- minLength: 22
pattern: "^vpce-[0-9a-f]{17}$"
ApiPublicUsageDetailsQueryRequest:
type: object
@@ -22473,7 +23626,10 @@ components:
properties:
specs:
type: array
- description: List of settings that configure the Search Nodes for your cluster.
+ description: |-
+ List of settings that configure the Search Nodes for your cluster.
+
+ **NOTE**: We accept a single configuration for all nodes currently.
items:
$ref: "#/components/schemas/ApiSearchDeploymentSpecView"
maxItems: 1
@@ -22488,8 +23644,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -22497,13 +23651,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the search
deployment.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
specs:
type: array
description: List of settings that configure the Search Nodes for your cluster.
+ The configuration will be returned for each region and shard.
items:
$ref: "#/components/schemas/ApiSearchDeploymentSpecView"
readOnly: true
@@ -22543,6 +23696,11 @@ components:
- S130_LOWCPU_NVME
- S135_LOWCPU_NVME
- S140_LOWCPU_NVME
+ - S40_STORAGE_NVME
+ - S50_STORAGE_NVME
+ - S60_STORAGE_NVME
+ - S80_STORAGE_NVME
+ - S90_STORAGE_NVME
nodeCount:
type: integer
format: int32
@@ -22576,6 +23734,8 @@ components:
- westus
- eastus2
- westeurope
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
ApiUserEventTypeViewForNdsGroup:
type: string
description: Unique identifier of event type.
@@ -22615,21 +23775,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/ApiUserEventTypeViewForNdsGroup"
@@ -22638,16 +23797,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -22672,17 +23827,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -22698,8 +23852,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -22722,21 +23874,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/ApiUserEventTypeViewForOrg"
@@ -22745,16 +23896,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -22779,17 +23926,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -22805,8 +23951,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -22837,9 +23981,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -22853,8 +23999,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -22862,8 +24006,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -22894,9 +24036,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -22910,11 +24054,14 @@ components:
type: string
format: date-time
description: |-
- Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
+ Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
- To acknowledge this alert forever, set the parameter value to 100 years in the future.
- To unacknowledge a previously acknowledged alert, do not set this parameter value.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
acknowledgementComment:
type: string
description: Comment that a MongoDB Cloud user submitted when acknowledging
@@ -22933,17 +24080,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration that sets this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when MongoDB Cloud created this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/AppServiceEventTypeViewAlertable"
@@ -22952,26 +24098,24 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lastNotified:
type: string
format: date-time
description: Date and time that any notifications were last sent for this
- alert. This parameter expresses its value in the ISO 8601 timestamp format
+ alert. This parameter expresses its value in the ISO 8601 timestamp format
in UTC. The resource returns this parameter if MongoDB Cloud has sent
notifications for this alert.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
links:
type: array
@@ -22989,18 +24133,18 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization that owns the project to which this alert applies.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
resolved:
type: string
format: date-time
description: "Date and time that this alert changed to `\"status\" : \"\
- CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
+ CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
\ format in UTC. The resource returns this parameter once `\"status\"\
\ : \"CLOSED\"`."
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
status:
type: string
@@ -23016,9 +24160,10 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- alertConfigId
@@ -23096,8 +24241,10 @@ components:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/AppServiceEventTypeView"
@@ -23106,16 +24253,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -23134,8 +24277,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
raw:
@@ -23154,9 +24295,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -23170,8 +24313,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -23179,8 +24320,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -23213,9 +24352,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -23356,6 +24497,9 @@ components:
- thousand
- million
- billion
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- metricName
title: App Services Metric Threshold
@@ -23403,8 +24547,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the organization.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isDeleted:
@@ -23425,8 +24567,6 @@ components:
name:
type: string
description: Human-readable label that identifies the organization.
- maxLength: 64
- minLength: 1
pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
skipDefaultAlertsSettings:
type: boolean
@@ -23442,21 +24582,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
type: string
@@ -23472,16 +24611,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -23506,16 +24641,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
+ description: "Public part of the API Key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -23530,8 +24665,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
resource policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
userId:
@@ -23540,8 +24673,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -23550,7 +24681,6 @@ components:
description: "Email address for the user who triggered this event. If this\
\ resource returns this parameter, it doesn't return the **publicApiKey**\
\ parameter."
- example: test.user@mongodb.com
readOnly: true
required:
- created
@@ -23717,16 +24847,12 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
labels:
@@ -23776,8 +24902,6 @@ components:
name:
type: string
description: Human-readable label that identifies the cluster.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
paused:
type: boolean
@@ -23921,8 +25045,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this role
mapping.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
roleAssignments:
@@ -23947,8 +25069,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
Export Bucket.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
frequencyType:
type: string
@@ -23957,6 +25077,9 @@ components:
enum:
- monthly
- yearly
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
title: export
AutomationConfigEventTypeView:
type: string
@@ -23972,21 +25095,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/AutomationConfigEventTypeView"
@@ -23995,16 +25117,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -24029,17 +25147,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -24055,8 +25172,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -24097,8 +25212,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
dbSizeBytes:
@@ -24174,8 +25287,6 @@ components:
description: Unique twelve-digit string that identifies the Amazon Web Services
(AWS) account that owns the VPC that you peered with the MongoDB Cloud
VPC.
- maxLength: 12
- minLength: 12
pattern: "^[0-9]{12}$"
connectionId:
type: string
@@ -24186,8 +25297,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud network container that contains the specified network peering connection.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
errorStateName:
type: string
@@ -24204,8 +25313,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the network
peering connection.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
providerName:
@@ -24238,7 +25345,6 @@ components:
type: string
description: Unique string that identifies the VPC on Amazon Web Services
(AWS) that you want to peer with the MongoDB Cloud VPC.
- minLength: 5
pattern: "^vpc-[0-9a-f]{17}$"
required:
- accepterRegionName
@@ -24334,14 +25440,15 @@ components:
- POLAND_CENTRAL
- ISRAEL_CENTRAL
- ITALY_NORTH
+ - SPAIN_CENTRAL
+ - MEXICO_CENTRAL
+ - NEW_ZEALAND_NORTH
vnetName:
type: string
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.
- maxLength: 38
- minLength: 38
- pattern: "^([-\\w._()])+$"
+ pattern: "^([-\\w._()])$"
readOnly: true
description: Collection of settings that configures the network container for
a virtual private connection on Amazon Web Services.
@@ -24754,6 +25861,7 @@ components:
the Encryption At Rest private endpoint.
enum:
- AZURE
+ - AWS
readOnly: true
errorMessage:
type: string
@@ -24765,8 +25873,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the Private
Endpoint Service.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
privateEndpointConnectionName:
@@ -24831,6 +25937,51 @@ components:
- UAE_NORTH
- QATAR_CENTRAL
title: Azure Regions
+ - type: string
+ description: "Physical location where MongoDB Cloud deploys your AWS-hosted\
+ \ MongoDB cluster nodes. The region you choose can affect network latency\
+ \ for clients accessing your databases. 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. MongoDB Cloud assigns the VPC a CIDR block. To\
+ \ limit a new VPC peering connection to one CIDR block and region, create\
+ \ the connection first. Deploy the cluster after the connection starts."
+ enum:
+ - 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
+ - GLOBAL
+ title: AWS Regions
status:
type: string
description: State of the Encryption At Rest private endpoint.
@@ -24862,8 +26013,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud network container that contains the specified network peering connection.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
errorState:
type: string
@@ -24876,8 +26025,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the network
peering connection.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
providerName:
@@ -24908,7 +26055,7 @@ components:
type: string
description: Human-readable label that identifies the VNet that you want
to peer with the MongoDB Cloud VNet.
- pattern: "^([-\\w._()])+$"
+ pattern: "^([-\\w._()])$"
required:
- azureDirectoryId
- azureSubscriptionId
@@ -24991,8 +26138,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the Private
Endpoint Service.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
privateEndpoints:
@@ -25012,8 +26157,6 @@ components:
type: string
description: Unique string that identifies the Azure Private Link Service
that MongoDB Cloud manages.
- maxLength: 24
- minLength: 24
pattern: "^pls_[0-9a-f]{24}$"
readOnly: true
privateLinkServiceResourceId:
@@ -25122,13 +26265,14 @@ components:
with the backup policy.
enum:
- ondemand
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
id:
type: string
description: Unique 24-hexadecimal digit string that identifies this backup
policy item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
retentionUnit:
@@ -25139,6 +26283,9 @@ components:
- weeks
- months
- years
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
retentionValue:
type: integer
format: int32
@@ -25210,13 +26357,14 @@ components:
- weekly
- monthly
- yearly
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
id:
type: string
description: Unique 24-hexadecimal digit string that identifies this backup
policy item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
retentionUnit:
@@ -25227,6 +26375,9 @@ components:
- weeks
- months
- years
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
retentionValue:
type: integer
format: int32
@@ -25261,16 +26412,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the online
archive.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
clusterName:
type: string
description: Human-readable label that identifies the cluster that contains
the collection for which you want to create an online archive.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
collName:
@@ -25311,8 +26458,6 @@ components:
that contains the specified cluster. The specified cluster contains the
collection for which to create the online archive.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
partitionFields:
@@ -25373,16 +26518,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the online
archive.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
clusterName:
type: string
description: Human-readable label that identifies the cluster that contains
the collection for which you want to create an online archive.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
collName:
@@ -25423,8 +26564,6 @@ components:
that contains the specified cluster. The specified cluster contains the
collection for which to create the online archive.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
partitionFields:
@@ -25490,8 +26629,6 @@ components:
to which this restore job belongs. This parameter exists only for a sharded
cluster restore.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
checkpointId:
@@ -25502,8 +26639,6 @@ components:
- If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**.
- If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
writeOnly: true
clusterId:
@@ -25512,16 +26647,12 @@ components:
with the snapshot you want to return. This parameter returns for restore
clusters.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
clusterName:
type: string
description: Human-readable label that identifies the cluster containing
the snapshots you want to retrieve.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
created:
@@ -25542,8 +26673,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns the snapshots.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
hashes:
@@ -25560,8 +26689,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the restore
job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -25621,8 +26748,6 @@ components:
\ to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**,\
\ **pointInTimeUTCMillis**, or **checkpointId**."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
statusName:
type: string
@@ -25719,8 +26844,6 @@ components:
To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
targetClusterName:
type: string
@@ -25733,8 +26856,6 @@ components:
- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.
To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
targetGroupId:
type: string
@@ -25743,8 +26864,6 @@ components:
\ returns this parameter when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"\
`."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
url:
type: string
@@ -25771,8 +26890,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the cluster
with the snapshots you want to return.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
clusterName:
@@ -25802,16 +26919,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns the snapshots.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
incremental:
@@ -25850,8 +26963,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the cluster
with the snapshots you want to return.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
completedTime:
@@ -25990,8 +27101,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the restore
job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -26131,6 +27240,7 @@ components:
- R400
- R600
title: GCP Instance Sizes
+ readOnly: true
BaseNetworkPeeringConnectionSettings:
type: object
discriminator:
@@ -26149,16 +27259,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud network container that contains the specified network peering connection.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the network
peering connection.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
providerName:
@@ -26323,21 +27429,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/BillingEventTypeViewForNdsGroup"
@@ -26346,16 +27451,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
invoiceId:
@@ -26363,8 +27464,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies of the invoice
associated with the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -26389,8 +27488,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
paymentId:
@@ -26398,17 +27495,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the invoice
payment associated with this event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -26424,8 +27520,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -26448,21 +27542,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/BillingEventTypeViewForOrg"
@@ -26471,16 +27564,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
invoiceId:
@@ -26488,8 +27577,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies of the invoice
associated with the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -26514,8 +27601,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
paymentId:
@@ -26523,17 +27608,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the invoice
payment associated with this event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -26549,8 +27633,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -26608,8 +27690,6 @@ components:
submitted to the specified organization. Charges typically post the next
day.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lineItems:
@@ -26641,8 +27721,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
charged for services consumed from MongoDB Cloud.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
payments:
@@ -26757,8 +27835,6 @@ components:
submitted to the specified organization. Charges typically post the next
day.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
linkedInvoices:
@@ -26784,8 +27860,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
charged for services consumed from MongoDB Cloud.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
salesTaxCents:
@@ -26880,8 +27954,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this payment
toward the associated invoice.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
salesTaxCents:
@@ -26962,8 +28034,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the payment
that the organization had made.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
reason:
@@ -26981,9 +28051,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -26997,8 +28069,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -27006,8 +28076,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -27037,9 +28105,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -27136,8 +28206,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud user.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lastAuth:
@@ -27236,6 +28304,9 @@ components:
- unavailable
- warning
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
backupEnabled:
type: boolean
description: "Flag that indicates whether the cluster can perform backups.\
@@ -27249,8 +28320,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
cluster. Each ``clusterId`` is used only once across all MongoDB Cloud
deployments.
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
dataSizeBytes:
@@ -27262,8 +28331,6 @@ components:
name:
type: string
description: Human-readable label that identifies the cluster.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
nodeCount:
@@ -27318,6 +28385,9 @@ components:
enum:
- admin
- $external
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
deleteAfterDate:
type: string
format: date-time
@@ -27332,10 +28402,6 @@ components:
groupId:
type: string
description: Unique 24-hexadecimal digit string that identifies the project.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
writeOnly: true
labels:
type: array
@@ -27588,8 +28654,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
description: Details that describe the features linked to the Amazon Web Services
@@ -27649,8 +28713,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
required:
@@ -27709,8 +28771,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
description: Details that describe the features linked to the Amazon Web Services
@@ -27727,8 +28787,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
atlasAzureAppId:
@@ -27778,8 +28836,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
atlasAzureAppId:
@@ -27836,8 +28892,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
atlasAzureAppId:
@@ -27941,8 +28995,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies your project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
name:
@@ -27959,16 +29011,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the AWS
S3 bucket to which you export your snapshots.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
groupId:
type: string
description: Unique 24-hexadecimal digit string that identifies your project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId:
@@ -27986,8 +29034,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies your project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
CloudProviderAccessGCPServiceAccount:
@@ -28013,15 +29059,11 @@ components:
gcpServiceAccountForAtlas:
type: string
description: Email address for the Google Service Account created by Atlas.
- maxLength: 82
- minLength: 57
pattern: "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$"
roleId:
type: string
description: Unique 24-hexadecimal digit string that identifies the role.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
description: Details that describe the features linked to the GCP Service Account.
@@ -28187,8 +29229,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the network
peering container.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
providerName:
@@ -28664,8 +29704,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
hardwareMetrics:
@@ -28720,9 +29758,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -28736,8 +29776,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -28745,8 +29783,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -28777,9 +29813,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -28794,11 +29832,14 @@ components:
type: string
format: date-time
description: |-
- Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
+ Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
- To acknowledge this alert forever, set the parameter value to 100 years in the future.
- To unacknowledge a previously acknowledged alert, do not set this parameter value.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
acknowledgementComment:
type: string
description: Comment that a MongoDB Cloud user submitted when acknowledging
@@ -28817,8 +29858,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration that sets this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
clusterName:
@@ -28827,17 +29866,16 @@ components:
\ this alert applies. This resource returns this parameter for alerts\
\ of events impacting backups, replica sets, or sharded clusters."
example: cluster1
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when MongoDB Cloud created this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/ClusterEventTypeViewAlertable"
@@ -28846,26 +29884,24 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lastNotified:
type: string
format: date-time
description: Date and time that any notifications were last sent for this
- alert. This parameter expresses its value in the ISO 8601 timestamp format
+ alert. This parameter expresses its value in the ISO 8601 timestamp format
in UTC. The resource returns this parameter if MongoDB Cloud has sent
notifications for this alert.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
links:
type: array
@@ -28883,18 +29919,18 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization that owns the project to which this alert applies.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
resolved:
type: string
format: date-time
description: "Date and time that this alert changed to `\"status\" : \"\
- CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
+ CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
\ format in UTC. The resource returns this parameter once `\"status\"\
\ : \"CLOSED\"`."
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
status:
type: string
@@ -28910,9 +29946,10 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- alertConfigId
@@ -29215,16 +30252,12 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
labels:
@@ -29274,8 +30307,6 @@ components:
name:
type: string
description: Human-readable label that identifies the cluster.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
paused:
type: boolean
@@ -29505,6 +30536,9 @@ components:
externalDocs:
description: This option corresponds to the global default read concern.
url: https://docs.mongodb.com/manual/reference/read-concern/
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
defaultWriteConcern:
type: string
description: Default level of acknowledgment requested from MongoDB for
@@ -29816,8 +30850,10 @@ components:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/ClusterEventTypeViewForNdsGroup"
@@ -29826,16 +30862,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -29854,8 +30886,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
raw:
@@ -29920,11 +30950,17 @@ components:
description: "Cloud service provider on which MongoDB Cloud provisioned\
\ the multi-tenant host. The resource returns this parameter when **providerSettings.providerName**\
\ is `TENANT` and **providerSetting.instanceSizeName** is `M0`, `M2`\
- \ or `M5`."
+ \ or `M5`. \n\nPlease note that using an instanceSize of M2 or M5 will\
+ \ create a Flex cluster instead. Support for the instanceSize of M2\
+ \ or M5 will be discontinued in January 2026. We recommend using the\
+ \ createFlexCluster API for such configurations moving forward."
enum:
- AWS
- GCP
- AZURE
+ externalDocs:
+ description: createFlexCluster API
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster
effectiveInstanceSizeName:
type: string
description: The true tenant instance size. This is present to support
@@ -30042,8 +31078,6 @@ components:
type: string
description: Human-readable label that identifies the cluster that undergoes
outage simulation.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
groupId:
@@ -30051,8 +31085,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project that contains the cluster to undergo outage simulation.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -30060,8 +31092,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
outage simulation.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
outageFilters:
@@ -30143,8 +31173,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this Atlas
Search index.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
name:
@@ -30183,6 +31211,9 @@ components:
enum:
- search
- vectorSearch
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- collectionName
- database
@@ -30270,6 +31301,9 @@ components:
enum:
- non-ignorable
- shifted
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
backwards:
type: boolean
default: false
@@ -30295,6 +31329,9 @@ components:
- lower
- "off"
- upper
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
caseLevel:
type: boolean
default: false
@@ -30422,6 +31459,9 @@ components:
- yo
- zu
- simple
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
maxVariable:
type: string
description: |
@@ -30434,6 +31474,9 @@ components:
enum:
- punct
- space
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
normalization:
type: boolean
default: false
@@ -30499,10 +31542,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that represents the id
of the identity providers that can be used for data access in this organization.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
uniqueItems: true
domainAllowList:
type: array
@@ -30522,16 +31561,12 @@ components:
id can be found within the Federation Management Console > Identity Providers
tab by clicking the info icon in the IdP ID row of a configured identity
provider.
- maxLength: 20
- minLength: 20
pattern: "^([a-f0-9]{20})$"
orgId:
type: string
description: Unique 24-hexadecimal digit string that identifies the connected
organization configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
postAuthRoleGrants:
@@ -30603,6 +31638,9 @@ components:
- projects
- clusters
- services
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
includePartialMatches:
type: boolean
description: "Flag to control whether usage that matches the filter criteria,\
@@ -30656,6 +31694,9 @@ components:
- Flex Consulting
- Support
- Credits
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
startDate:
type: string
format: date
@@ -30696,9 +31737,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -30712,8 +31755,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -30721,8 +31762,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -30752,9 +31791,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -30841,6 +31882,8 @@ components:
- GROUP_CLUSTER_MANAGER
- GROUP_SEARCH_INDEX_EDITOR
- GROUP_STREAM_PROCESSING_OWNER
+ - GROUP_BACKUP_MANAGER
+ - GROUP_OBSERVABILITY_VIEWER
minItems: 1
required:
- desc
@@ -30880,14 +31923,14 @@ components:
properties:
cloudProvider:
type: string
- description: "Human-readable label that identifies the Cloud service provider\
- \ where you wish to store your archived data. **AZURE** or **GCP** may\
- \ be selected only if it is the Cloud service provider for the cluster\
- \ and no archives for any other cloud provider have been created for the\
- \ cluster. **GCP** is currently only supported in [private preview](https://www.mongodb.com/community/forums/t/invitation-to-participate-in-the-private-preview-program-of-online-archive-on-gcp)."
+ description: Human-readable label that identifies the Cloud service provider
+ where you wish to store your archived data. **AZURE** or **GCP** may be
+ selected only if it is the Cloud service provider for the cluster and
+ no archives for any other cloud provider have been created for the cluster.
enum:
- AWS
- AZURE
+ - GCP
writeOnly: true
CreateEndpointRequest:
type: object
@@ -30959,14 +32002,10 @@ components:
\ Organization Owner of the new organization must have the Organization\
\ Owner role in an organization associated with the federation."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
name:
type: string
description: Human-readable label that identifies the organization.
- maxLength: 64
- minLength: 1
pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
orgOwnerId:
type: string
@@ -30978,8 +32017,6 @@ components:
\ This parameter is required only when you authenticate with Programmatic\
\ API Keys."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
skipDefaultAlertsSettings:
type: boolean
@@ -30998,8 +32035,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the federation
that you linked the newly created organization to.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
orgOwnerId:
@@ -31007,8 +32042,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud user that you assigned the Organization Owner role in the new organization.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
organization:
@@ -31237,13 +32270,10 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
collection:
@@ -31257,8 +32287,10 @@ components:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
database:
type: string
@@ -31275,16 +32307,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -31316,17 +32344,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -31342,8 +32369,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -31359,6 +32384,118 @@ components:
- eventTypeName
- id
title: Data Explorer Accessed Events
+ DataExplorerEvent:
+ type: object
+ description: Data Explorer event tracks different Data Explorer operations.
+ properties:
+ apiKeyId:
+ type: string
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ created:
+ type: string
+ format: date-time
+ description: Date and time when this event occurred. This parameter expresses
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
+ readOnly: true
+ eventTypeName:
+ $ref: "#/components/schemas/DataExplorerEventTypeView"
+ groupId:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the project
+ in which the event occurred. The **eventId** identifies the specific event.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ id:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the event.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ isGlobalAdmin:
+ type: boolean
+ default: false
+ description: Flag that indicates whether a MongoDB employee triggered the
+ specified event.
+ readOnly: true
+ links:
+ type: array
+ 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."
+ externalDocs:
+ description: Web Linking Specification (RFC 5988)
+ url: https://datatracker.ietf.org/doc/html/rfc5988
+ items:
+ $ref: "#/components/schemas/Link"
+ readOnly: true
+ orgId:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the organization
+ to which these events apply.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ publicKey:
+ type: string
+ format: email
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
+ readOnly: true
+ raw:
+ $ref: "#/components/schemas/raw"
+ remoteAddress:
+ type: string
+ description: IPv4 or IPv6 address from which the user triggered this event.
+ example: 216.172.40.186
+ pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
+ readOnly: true
+ sessionId:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the Data
+ Explorer session associated with the event.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ userId:
+ type: string
+ description: "Unique 24-hexadecimal digit string that identifies the console\
+ \ user who triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **apiKeyId** parameter."
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ username:
+ type: string
+ format: email
+ description: "Email address for the user who triggered this event. If this\
+ \ resource returns this parameter, it doesn't return the **publicApiKey**\
+ \ parameter."
+ example: test.user@mongodb.com
+ readOnly: true
+ required:
+ - created
+ - eventTypeName
+ - id
+ title: Data Explorer Events
+ DataExplorerEventTypeView:
+ type: string
+ description: Unique identifier of event type.
+ enum:
+ - DATA_EXPLORER_SESSION_CREATED
+ example: DATA_EXPLORER_SESSION_CREATED
+ title: Data Explorer Event Types
DataFederationAzureCloudProviderConfig:
type: object
description: Configuration for running Data Federation in Azure.
@@ -32201,8 +33338,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the Data
Lake Pipeline.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
createdDate:
@@ -32216,8 +33351,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the group.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lastUpdatedDate:
@@ -32431,8 +33564,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
hostnames:
@@ -32471,11 +33602,14 @@ components:
type: string
format: date-time
description: |-
- Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
+ Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
- To acknowledge this alert forever, set the parameter value to 100 years in the future.
- To unacknowledge a previously acknowledged alert, do not set this parameter value.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
acknowledgementComment:
type: string
description: Comment that a MongoDB Cloud user submitted when acknowledging
@@ -32494,8 +33628,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration that sets this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
clusterName:
@@ -32504,17 +33636,16 @@ components:
\ this alert applies. This resource returns this parameter for alerts\
\ of events impacting backups, replica sets, or sharded clusters."
example: cluster1
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when MongoDB Cloud created this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
currentValue:
$ref: "#/components/schemas/DataMetricValueView"
@@ -32525,8 +33656,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
hostnameAndPort:
@@ -32540,18 +33669,18 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lastNotified:
type: string
format: date-time
description: Date and time that any notifications were last sent for this
- alert. This parameter expresses its value in the ISO 8601 timestamp format
+ alert. This parameter expresses its value in the ISO 8601 timestamp format
in UTC. The resource returns this parameter if MongoDB Cloud has sent
notifications for this alert.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
links:
type: array
@@ -32579,8 +33708,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization that owns the project to which this alert applies.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
replicaSetName:
@@ -32594,10 +33721,12 @@ components:
type: string
format: date-time
description: "Date and time that this alert changed to `\"status\" : \"\
- CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
+ CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
\ format in UTC. The resource returns this parameter once `\"status\"\
\ : \"CLOSED\"`."
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
status:
type: string
@@ -32613,9 +33742,10 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- alertConfigId
@@ -32629,21 +33759,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
currentValue:
$ref: "#/components/schemas/DataMetricValueView"
@@ -32662,16 +33791,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -32701,8 +33826,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
port:
@@ -32714,10 +33837,11 @@ components:
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -32744,8 +33868,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -32896,8 +34018,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
for the Backup Compliance Policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
restoreWindowDays:
type: integer
@@ -32996,8 +34116,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
for the Backup Compliance Policy.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
restoreWindowDays:
type: integer
@@ -33248,6 +34366,9 @@ components:
- readWrite
- readWriteAnyDatabase
-
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- databaseName
- roleName
@@ -33274,10 +34395,8 @@ components:
nullable: true
region:
type: string
- description: |-
- Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API.
-
- To learn more about Datadog's regions, see Datadog Sites.
+ description: Two-letter code that indicates which regional URL MongoDB uses
+ to access the Datadog API.
enum:
- US
- EU
@@ -33285,6 +34404,9 @@ components:
- US5
- AP1
- US1_FED
+ externalDocs:
+ description: Datadog regions
+ url: https://docs.datadoghq.com/getting_started/site/
sendCollectionLatencyMetrics:
type: boolean
default: false
@@ -33325,10 +34447,9 @@ components:
datadogRegion:
type: string
default: US
- description: |-
- Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `"notifications.[n].typeName" : "DATADOG"`.
-
- To learn more about Datadog's regions, see Datadog Sites.
+ description: "Datadog region that indicates which API Uniform Resource Locator\
+ \ (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\"\
+ \ : \"DATADOG\"`."
enum:
- US
- EU
@@ -33336,6 +34457,9 @@ components:
- US5
- AP1
- US1_FED
+ externalDocs:
+ description: Datadog regions
+ url: https://docs.datadoghq.com/getting_started/site/
delayMin:
type: integer
format: int32
@@ -33485,9 +34609,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -33602,8 +34728,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -33611,8 +34735,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -33640,9 +34762,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -33656,11 +34780,14 @@ components:
type: string
format: date-time
description: |-
- Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
+ Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
- To acknowledge this alert forever, set the parameter value to 100 years in the future.
- To unacknowledge a previously acknowledged alert, do not set this parameter value.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
acknowledgementComment:
type: string
description: Comment that a MongoDB Cloud user submitted when acknowledging
@@ -33679,17 +34806,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration that sets this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when MongoDB Cloud created this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
type: object
@@ -33779,6 +34905,10 @@ components:
enum:
- OUTSIDE_SERVERLESS_METRIC_THRESHOLD
title: Serverless Event Types
+ - type: string
+ enum:
+ - OUTSIDE_FLEX_METRIC_THRESHOLD
+ title: Flex Metric Event Types
- type: string
enum:
- JOINED_GROUP
@@ -33824,26 +34954,24 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lastNotified:
type: string
format: date-time
description: Date and time that any notifications were last sent for this
- alert. This parameter expresses its value in the ISO 8601 timestamp format
+ alert. This parameter expresses its value in the ISO 8601 timestamp format
in UTC. The resource returns this parameter if MongoDB Cloud has sent
notifications for this alert.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
links:
type: array
@@ -33861,18 +34989,18 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization that owns the project to which this alert applies.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
resolved:
type: string
format: date-time
description: "Date and time that this alert changed to `\"status\" : \"\
- CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
+ CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
\ format in UTC. The resource returns this parameter once `\"status\"\
\ : \"CLOSED\"`."
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
status:
type: string
@@ -33888,9 +35016,10 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- alertConfigId
@@ -33906,21 +35035,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
type: object
@@ -34170,6 +35298,11 @@ components:
- INSIDE_SERVERLESS_METRIC_THRESHOLD
- OUTSIDE_SERVERLESS_METRIC_THRESHOLD
title: Serverless Event Types
+ - type: string
+ enum:
+ - INSIDE_FLEX_METRIC_THRESHOLD
+ - OUTSIDE_FLEX_METRIC_THRESHOLD
+ title: Flex Metric Event Types
- type: string
enum:
- SETUP_SERVERLESS_INITIATED
@@ -34226,16 +35359,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -34260,17 +35389,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -34286,8 +35414,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -34309,21 +35435,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
type: object
@@ -34406,16 +35531,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -34440,17 +35561,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -34466,8 +35586,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -34607,9 +35725,7 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the destination
project.
- example: 9b43a5b329223c3a1591a678
- maxLength: 24
- minLength: 24
+ example: 32b6e34b3d91647abb20e7b8
pattern: "^([a-f0-9]{24})$"
hostnameSchemaType:
type: string
@@ -34687,13 +35803,14 @@ components:
- monthly
- yearly
- ondemand
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
id:
type: string
description: Unique 24-hexadecimal digit string that identifies this backup
policy item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
retentionUnit:
@@ -34704,6 +35821,9 @@ components:
- weeks
- months
- years
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
retentionValue:
type: integer
format: int32
@@ -34832,8 +35952,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
Export Bucket.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
exportStatus:
@@ -34849,8 +35967,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
restore job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -34876,8 +35992,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
state:
type: string
@@ -34889,6 +36003,9 @@ components:
- Queued
- Successful
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
stateReason:
$ref: "#/components/schemas/StateReason"
required:
@@ -34908,8 +36025,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
Export Bucket.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
writeOnly: true
links:
@@ -34928,8 +36043,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
Cloud Backup Snapshot to export.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
writeOnly: true
required:
@@ -34943,8 +36056,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
the Cloud Backup snapshot export job for each shard in a sharded cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
replicaSetName:
@@ -35027,12 +36138,13 @@ components:
- monthly
- yearly
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -35067,8 +36179,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies one policy
item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
replicaSetName:
@@ -35083,7 +36193,11 @@ components:
enum:
- onDemand
- scheduled
+ - fallback
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
status:
type: string
description: Human-readable label that indicates the stage of the backup
@@ -35094,6 +36208,9 @@ components:
- completed
- failed
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
storageSizeBytes:
type: integer
format: int64
@@ -35107,6 +36224,9 @@ components:
- replicaSet
- shardedCluster
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
title: Replica Set Snapshot
DiskBackupRestoreMember:
type: object
@@ -35172,12 +36292,13 @@ components:
- monthly
- yearly
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -35220,8 +36341,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies one policy
item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
snapshotIds:
@@ -35236,8 +36355,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the snapshot
for part of the sharded cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
readOnly: true
@@ -35247,7 +36364,11 @@ components:
enum:
- onDemand
- scheduled
+ - fallback
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
status:
type: string
description: Human-readable label that indicates the stage of the backup
@@ -35258,6 +36379,9 @@ components:
- completed
- failed
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
storageSizeBytes:
type: integer
format: int64
@@ -35271,6 +36395,9 @@ components:
- replicaSet
- shardedCluster
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
title: Sharded Cluster Snapshot
DiskBackupShardedClusterSnapshotMember:
type: object
@@ -35289,8 +36416,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
replicaSetName:
@@ -35339,12 +36464,13 @@ components:
- monthly
- yearly
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -35379,8 +36505,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies one policy
item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
snapshotType:
@@ -35389,7 +36513,11 @@ components:
enum:
- onDemand
- scheduled
+ - fallback
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
status:
type: string
description: Human-readable label that indicates the stage of the backup
@@ -35400,6 +36528,9 @@ components:
- completed
- failed
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
storageSizeBytes:
type: integer
format: int64
@@ -35413,6 +36544,9 @@ components:
- replicaSet
- shardedCluster
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
DiskBackupSnapshotAWSExportBucketRequest:
type: object
allOf:
@@ -35422,12 +36556,9 @@ components:
iamRoleId:
type: string
description: Unique 24-hexadecimal character string that identifies the
- Unified AWS Access role ID that MongoDB Cloud uses
- to access the AWS S3 bucket.
+ Unified AWS Access role ID that MongoDB Cloud uses to access the AWS
+ S3 bucket.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
required:
- bucketName
@@ -35441,8 +36572,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
Export Bucket.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
bucketName:
type: string
@@ -35461,12 +36590,9 @@ components:
iamRoleId:
type: string
description: Unique 24-hexadecimal character string that identifies the
- Unified AWS Access role ID that MongoDB Cloud uses
- to access the AWS S3 bucket.
+ Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3
+ bucket.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
links:
type: array
@@ -35503,8 +36629,6 @@ components:
Cloud Provider Access Role that MongoDB Cloud uses to access the Azure
Blob Storage Container.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
serviceUrl:
type: string
@@ -35537,8 +36661,6 @@ components:
Cloud Provider Access Role that MongoDB Cloud uses to access the Azure
Blob Storage Container.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
serviceUrl:
type: string
@@ -35616,8 +36738,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
Export Bucket.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
bucketName:
type: string
@@ -35669,6 +36789,9 @@ components:
- automated
- download
- pointInTime
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
deliveryUrl:
type: array
description: "One or more Uniform Resource Locators (URLs) that point to\
@@ -35706,8 +36829,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
restore job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -35762,8 +36883,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
targetClusterName:
type: string
@@ -35771,8 +36890,6 @@ components:
which the restore job restores the snapshot. The resource returns this
parameter when `"deliveryType":` `"automated"`. Required for `automated`
and `pointInTime` restore types.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
targetGroupId:
type: string
@@ -35780,8 +36897,6 @@ components:
project for the specified **targetClusterName**. Required for `automated`
and `pointInTime` restore types.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
timestamp:
type: string
@@ -35804,16 +36919,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the cluster
with the Snapshot you want to return.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
clusterName:
type: string
description: Human-readable label that identifies the cluster with the Snapshot
you want to return.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
copySettings:
@@ -35898,16 +37009,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the cluster
with the Snapshot you want to return.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
clusterName:
type: string
description: Human-readable label that identifies the cluster with the Snapshot
you want to return.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
copySettings:
@@ -35993,11 +37100,75 @@ components:
type: object
additionalProperties:
type: object
+ DropIndexSuggestionsIndex:
+ type: object
+ properties:
+ accessCount:
+ type: integer
+ format: int64
+ description: Usage count (since last restart) of index.
+ index:
+ type: array
+ description: List that contains documents that specify a key in the index
+ and its sort order.
+ items:
+ type: object
+ description: One index key paired with its sort order. A value of `1`
+ indicates an ascending sort order. A value of `-1` indicates a descending
+ sort order. Keys in indexes with multiple keys appear in the same order
+ that they appear in the index.
+ name:
+ type: string
+ description: Name of index.
+ namespace:
+ type: string
+ description: Human-readable label that identifies the namespace on the specified
+ host. The resource expresses this parameter value as `.`.
+ shards:
+ type: array
+ description: List that contains strings that specifies the shards where
+ the index is found.
+ items:
+ type: string
+ description: Shard name.
+ since:
+ type: string
+ format: date-time
+ description: Date of most recent usage of index.
+ sizeBytes:
+ type: integer
+ format: int64
+ description: Size of index.
+ DropIndexSuggestionsResponse:
+ type: object
+ properties:
+ hiddenIndexes:
+ type: array
+ description: List that contains the documents with information about the
+ hidden indexes that the Performance Advisor suggests to remove.
+ items:
+ $ref: "#/components/schemas/DropIndexSuggestionsIndex"
+ readOnly: true
+ redundantIndexes:
+ type: array
+ description: List that contains the documents with information about the
+ redundant indexes that the Performance Advisor suggests to remove.
+ items:
+ $ref: "#/components/schemas/DropIndexSuggestionsIndex"
+ readOnly: true
+ unusedIndexes:
+ type: array
+ description: List that contains the documents with information about the
+ unused indexes that the Performance Advisor suggests to remove.
+ items:
+ $ref: "#/components/schemas/DropIndexSuggestionsIndex"
+ readOnly: true
EARPrivateEndpoint:
type: object
description: Encryption At Rest Private Endpoint.
oneOf:
- $ref: "#/components/schemas/AzureKeyVaultEARPrivateEndpoint"
+ - $ref: "#/components/schemas/AWSKMSEARPrivateEndpoint"
properties:
cloudProvider:
type: string
@@ -36005,6 +37176,7 @@ components:
the Encryption At Rest private endpoint.
enum:
- AZURE
+ - AWS
readOnly: true
errorMessage:
type: string
@@ -36016,8 +37188,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the Private
Endpoint Service.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
regionName:
@@ -36078,6 +37248,51 @@ components:
- UAE_NORTH
- QATAR_CENTRAL
title: Azure Regions
+ - type: string
+ description: "Physical location where MongoDB Cloud deploys your AWS-hosted\
+ \ MongoDB cluster nodes. The region you choose can affect network latency\
+ \ for clients accessing your databases. 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. MongoDB Cloud assigns the VPC a CIDR block. To\
+ \ limit a new VPC peering connection to one CIDR block and region, create\
+ \ the connection first. Deploy the cluster after the connection starts."
+ enum:
+ - 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
+ - GLOBAL
+ title: AWS Regions
status:
type: string
description: State of the Encryption At Rest private endpoint.
@@ -36182,9 +37397,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -36198,8 +37415,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -36207,8 +37422,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -36238,9 +37451,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -36285,8 +37500,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the Private
Endpoint Service.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
regionName:
@@ -36465,6 +37678,10 @@ components:
- DATA_EXPLORER_CRUD_ERROR
- DATA_EXPLORER_CRUD
title: Data Explorer Accessed Event Types
+ - type: string
+ enum:
+ - DATA_EXPLORER_SESSION_CREATED
+ title: Data Explorer Event Types
- type: string
enum:
- CPS_DATA_PROTECTION_ENABLE_REQUESTED
@@ -36584,6 +37801,15 @@ components:
- SSH_KEY_NDS_HOST_ACCESS_ATTEMPT
- SSH_KEY_NDS_HOST_ACCESS_GRANTED
- HOST_SSH_SESSION_ENDED
+ - HOST_X509_CERTIFICATE_CERTIFICATE_GENERATED_FOR_SUPPORT_ACCESS
+ - PUSH_BASED_LOG_EXPORT_RESUMED
+ - PUSH_BASED_LOG_EXPORT_STOPPED
+ - PUSH_BASED_LOG_EXPORT_DROPPED_LOG
+ - HOST_VERSION_BEHIND
+ - VERSION_BEHIND
+ - HOST_EXPOSED
+ - HOST_SSL_CERTIFICATE_STALE
+ - HOST_SECURITY_CHECKUP_NOT_MET
title: Host Event Types
- type: string
enum:
@@ -36645,6 +37871,7 @@ components:
- ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED
- MONGODB_LOGS_DOWNLOADED
- MONGOSQLD_LOGS_DOWNLOADED
+ - MONGOT_LOGS_DOWNLOADED
- MONGODB_USER_ADDED
- MONGODB_USER_DELETED
- MONGODB_USER_X509_CERT_CREATED
@@ -36767,6 +37994,8 @@ components:
- UIS_PANICKED
- TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL
- TENANT_UPGRADE_TO_SERVERLESS_FAILED
+ - SERVERLESS_UPGRADE_TO_DEDICATED_SUCCESSFUL
+ - SERVERLESS_UPGRADE_TO_DEDICATED_FAILED
- CLUSTER_FORCE_RECONFIG_REQUESTED
- PROJECT_BYPASSED_MAINTENANCE
- FEATURE_FLAG_MAINTENANCE
@@ -36810,6 +38039,11 @@ components:
- SSL_CERTIFICATE_ISSUED
- PROJECT_SCHEDULED_MAINTENANCE_OUTSIDE_OF_PROTECTED_HOURS
- CLUSTER_CANCELING_SHARD_DRAIN_REQUESTED
+ - CLUSTER_MIGRATE_BACK_TO_AWS_MANAGED_IP_REQUESTED
+ - CLUSTER_IP_MIGRATED_FIRST_ROUND
+ - CLUSTER_IP_MIGRATED_SECOND_ROUND
+ - CLUSTER_IP_MIGRATED_FINAL_ROUND
+ - CLUSTER_IP_ROLLED_BACK
title: NDS Audit Types
- type: string
enum:
@@ -36930,6 +38164,8 @@ components:
- ONE_PRIMARY
- NO_PRIMARY
- TOO_MANY_ELECTIONS
+ - TOO_FEW_HEALTHY_MEMBERS
+ - TOO_MANY_UNHEALTHY_MEMBERS
title: ReplicaSet Event Types
- type: string
enum:
@@ -36953,6 +38189,11 @@ components:
- INSIDE_SERVERLESS_METRIC_THRESHOLD
- OUTSIDE_SERVERLESS_METRIC_THRESHOLD
title: Serverless Event Types
+ - type: string
+ enum:
+ - INSIDE_FLEX_METRIC_THRESHOLD
+ - OUTSIDE_FLEX_METRIC_THRESHOLD
+ title: Flex Metric Event Types
- type: string
enum:
- SETUP_SERVERLESS_INITIATED
@@ -37321,6 +38562,7 @@ components:
- $ref: "#/components/schemas/BillingEventViewForNdsGroup"
- $ref: "#/components/schemas/ClusterEventViewForNdsGroup"
- $ref: "#/components/schemas/DataExplorerAccessedEventView"
+ - $ref: "#/components/schemas/DataExplorerEvent"
- $ref: "#/components/schemas/FTSIndexAuditView"
- $ref: "#/components/schemas/HostEventViewForNdsGroup"
- $ref: "#/components/schemas/HostMetricEvent"
@@ -37454,21 +38696,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/FTSIndexAuditTypeView"
@@ -37477,16 +38718,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -37511,16 +38748,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
+ description: "Public part of the API Key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -37536,8 +38773,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -37546,7 +38781,6 @@ components:
description: "Email address for the user who triggered this event. If this\
\ resource returns this parameter, it doesn't return the **publicApiKey**\
\ parameter."
- example: test.user@mongodb.com
readOnly: true
required:
- created
@@ -37621,8 +38855,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the federation
to which this MongoDB Cloud user belongs.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
firstName:
type: string
@@ -37635,8 +38867,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this user.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
required:
@@ -37675,8 +38905,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the identity
provider.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
idpType:
@@ -37694,8 +38922,6 @@ components:
type: string
description: Legacy 20-hexadecimal digit string that identifies the identity
provider.
- maxLength: 20
- minLength: 20
pattern: "^([a-f0-9]{20})$"
protocol:
type: string
@@ -37789,8 +39015,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the identity
provider.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
idpType:
@@ -37808,8 +39032,6 @@ components:
type: string
description: Legacy 20-hexadecimal digit string that identifies the identity
provider.
- maxLength: 20
- minLength: 20
pattern: "^([a-f0-9]{20})$"
protocol:
type: string
@@ -37930,8 +39152,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the identity
provider.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
idpType:
@@ -37949,8 +39169,6 @@ components:
type: string
description: Legacy 20-hexadecimal digit string that identifies the identity
provider.
- maxLength: 20
- minLength: 20
pattern: "^([a-f0-9]{20})$"
protocol:
type: string
@@ -38082,8 +39300,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the identity
provider.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
idpType:
@@ -38101,8 +39317,6 @@ components:
type: string
description: Legacy 20-hexadecimal digit string that identifies the identity
provider.
- maxLength: 20
- minLength: 20
pattern: "^([a-f0-9]{20})$"
protocol:
type: string
@@ -38211,8 +39425,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the identity
provider.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
idpType:
@@ -38230,8 +39442,6 @@ components:
type: string
description: Legacy 20-hexadecimal digit string that identifies the identity
provider.
- maxLength: 20
- minLength: 20
pattern: "^([a-f0-9]{20})$"
pemFileInfo:
$ref: "#/components/schemas/PemFileInfo"
@@ -38250,6 +39460,9 @@ components:
enum:
- HTTP-POST
- HTTP-REDIRECT
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
responseSignatureAlgorithm:
type: string
description: Signature algorithm that Federated Authentication uses to encrypt
@@ -38257,6 +39470,9 @@ components:
enum:
- SHA-1
- SHA-256
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
slug:
type: string
description: Custom SSO Url for the identity provider.
@@ -38331,6 +39547,9 @@ components:
enum:
- HTTP-POST
- HTTP-REDIRECT
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
responseSignatureAlgorithm:
type: string
description: Signature algorithm that Federated Authentication uses to encrypt
@@ -38338,6 +39557,9 @@ components:
enum:
- SHA-1
- SHA-256
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
slug:
type: string
description: Custom SSO Url for the identity provider.
@@ -38409,15 +39631,11 @@ components:
description: Unique 24-hexadecimal digit string that identifies the restore
job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
instanceName:
type: string
description: Human-readable label that identifies the source instance.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
links:
@@ -38436,8 +39654,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
from which the restore job originated.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
restoreFinishedDate:
@@ -38466,8 +39682,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the snapshot
to restore.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
snapshotUrl:
@@ -38492,8 +39706,6 @@ components:
description: Human-readable label that identifies the instance or cluster
on the target project to which you want to restore the snapshot. You can
restore the snapshot to another flex or dedicated cluster tier.
- maxLength: 64
- minLength: 1
pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
readOnly: true
targetProjectId:
@@ -38502,8 +39714,6 @@ components:
that contains the instance or cluster to which you want to restore the
snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
title: Flex Backup Restore Job
@@ -38530,15 +39740,11 @@ components:
description: Unique 24-hexadecimal digit string that identifies the restore
job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
instanceName:
type: string
description: Human-readable label that identifies the source instance.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
links:
@@ -38557,8 +39763,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
from which the restore job originated.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
restoreFinishedDate:
@@ -38587,8 +39791,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the snapshot
to restore.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
writeOnly: true
snapshotUrl:
@@ -38613,8 +39815,6 @@ components:
description: Human-readable label that identifies the instance or cluster
on the target project to which you want to restore the snapshot. You can
restore the snapshot to another flex cluster or dedicated cluster tier.
- maxLength: 64
- minLength: 1
pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
writeOnly: true
targetProjectId:
@@ -38623,8 +39823,6 @@ components:
that contains the instance or cluster to which you want to restore the
snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
writeOnly: true
required:
@@ -38667,8 +39865,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -38731,8 +39927,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the snapshot
to download.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
writeOnly: true
required:
@@ -38746,10 +39940,10 @@ components:
$ref: "#/components/schemas/FlexBackupSettings20241113"
clusterType:
type: string
+ default: REPLICASET
description: Flex cluster topology.
enum:
- REPLICASET
- - LOADBALANCED
readOnly: true
connectionStrings:
$ref: "#/components/schemas/FlexConnectionStrings20241113"
@@ -38764,16 +39958,12 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the instance.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -38795,8 +39985,6 @@ components:
name:
type: string
description: Human-readable label that identifies the instance.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
providerSettings:
@@ -38855,8 +40043,6 @@ components:
name:
type: string
description: Human-readable label that identifies the instance.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
writeOnly: true
providerSettings:
@@ -38911,6 +40097,93 @@ components:
\ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\
\ If set to `false`, MongoDB Cloud will delete the cluster."
title: Flex Cluster Description Update
+ FlexClusterMetricThreshold:
+ type: object
+ description: "Threshold for the metric that, when exceeded, triggers an alert.\
+ \ The metric threshold pertains to event types which reflects changes of measurements\
+ \ and metrics about the serverless database."
+ discriminator:
+ mapping:
+ FLEX_AVG_COMMAND_EXECUTION_TIME: "#/components/schemas/TimeMetricThresholdView"
+ FLEX_AVG_READ_EXECUTION_TIME: "#/components/schemas/TimeMetricThresholdView"
+ FLEX_AVG_WRITE_EXECUTION_TIME: "#/components/schemas/TimeMetricThresholdView"
+ FLEX_CONNECTIONS: "#/components/schemas/RawMetricThresholdView"
+ FLEX_CONNECTIONS_PERCENT: "#/components/schemas/RawMetricThresholdView"
+ FLEX_DATA_SIZE_TOTAL: "#/components/schemas/DataMetricThresholdView"
+ FLEX_NETWORK_BYTES_IN: "#/components/schemas/DataMetricThresholdView"
+ FLEX_NETWORK_BYTES_OUT: "#/components/schemas/DataMetricThresholdView"
+ FLEX_NETWORK_NUM_REQUESTS: "#/components/schemas/RawMetricThresholdView"
+ FLEX_OPCOUNTER_CMD: "#/components/schemas/RawMetricThresholdView"
+ FLEX_OPCOUNTER_DELETE: "#/components/schemas/RawMetricThresholdView"
+ FLEX_OPCOUNTER_GETMORE: "#/components/schemas/RawMetricThresholdView"
+ FLEX_OPCOUNTER_INSERT: "#/components/schemas/RawMetricThresholdView"
+ FLEX_OPCOUNTER_QUERY: "#/components/schemas/RawMetricThresholdView"
+ FLEX_OPCOUNTER_UPDATE: "#/components/schemas/RawMetricThresholdView"
+ propertyName: metricName
+ properties:
+ metricName:
+ type: string
+ description: Human-readable label that identifies the metric against which
+ MongoDB Cloud checks the configured **metricThreshold.threshold**.
+ mode:
+ type: string
+ description: MongoDB Cloud computes the current metric value as an average.
+ enum:
+ - AVERAGE
+ operator:
+ type: string
+ description: Comparison operator to apply when checking the current metric
+ value.
+ enum:
+ - LESS_THAN
+ - GREATER_THAN
+ threshold:
+ type: number
+ format: double
+ description: "Value of metric that, when exceeded, triggers an alert."
+ units:
+ type: string
+ description: "Element used to express the quantity. This can be an element\
+ \ of time, storage capacity, and the like."
+ enum:
+ - bits
+ - Kbits
+ - Mbits
+ - Gbits
+ - bytes
+ - KB
+ - MB
+ - GB
+ - TB
+ - PB
+ - nsec
+ - msec
+ - sec
+ - min
+ - hours
+ - million minutes
+ - days
+ - requests
+ - 1000 requests
+ - GB seconds
+ - GB hours
+ - GB days
+ - RPU
+ - thousand RPU
+ - million RPU
+ - WPU
+ - thousand WPU
+ - million WPU
+ - count
+ - thousand
+ - million
+ - billion
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
+ required:
+ - metricName
+ title: Flex Cluster Metric Threshold
FlexConnectionStrings20241113:
type: object
description: Collection of Uniform Resource Locators that point to the MongoDB
@@ -38937,6 +40210,86 @@ components:
readOnly: true
readOnly: true
title: Flex Cluster Connection Strings
+ FlexMetricAlertConfigViewForNdsGroup:
+ type: object
+ description: Flex metric alert configuration allows to select which Flex database
+ metrics trigger alerts and how users are notified.
+ properties:
+ created:
+ type: string
+ format: date-time
+ description: Date and time when MongoDB Cloud created the alert configuration.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
+ readOnly: true
+ enabled:
+ type: boolean
+ default: false
+ description: Flag that indicates whether someone enabled this alert configuration
+ for the specified project.
+ eventTypeName:
+ $ref: "#/components/schemas/FlexMetricEventTypeViewAlertable"
+ groupId:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the project
+ that owns this alert configuration.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ id:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies this alert
+ configuration.
+ example: 32b6e34b3d91647abb20e7b8
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ links:
+ type: array
+ 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."
+ externalDocs:
+ description: Web Linking Specification (RFC 5988)
+ url: https://datatracker.ietf.org/doc/html/rfc5988
+ items:
+ $ref: "#/components/schemas/Link"
+ readOnly: true
+ matchers:
+ type: array
+ description: Matching conditions for target resources.
+ items:
+ $ref: "#/components/schemas/AlertMatcher"
+ metricThreshold:
+ $ref: "#/components/schemas/FlexClusterMetricThreshold"
+ notifications:
+ type: array
+ description: List that contains the targets that MongoDB Cloud sends notifications.
+ items:
+ $ref: "#/components/schemas/AlertsNotificationRootForGroup"
+ updated:
+ type: string
+ format: date-time
+ description: Date and time when someone last updated this alert configuration.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
+ readOnly: true
+ required:
+ - eventTypeName
+ - notifications
+ title: Flex Alert Configuration
+ FlexMetricEventTypeViewAlertable:
+ type: string
+ description: Event type that triggers an alert.
+ enum:
+ - OUTSIDE_FLEX_METRIC_THRESHOLD
+ example: OUTSIDE_FLEX_METRIC_THRESHOLD
+ title: Flex Metric Event Types
FlexProviderSettings20241113:
type: object
description: Group of cloud provider settings that configure the provisioned
@@ -39023,8 +40376,10 @@ components:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup"
@@ -39033,16 +40388,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -39061,8 +40412,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
port:
@@ -39140,8 +40489,6 @@ components:
description: Unique string that identifies the GCP project in which MongoDB
Cloud clusters in this network peering container exist. The response
returns **null** if no clusters exist in this network peering container.
- maxLength: 26
- minLength: 26
pattern: "^p-[0-9a-z]{24}$"
readOnly: true
networkName:
@@ -39150,8 +40497,6 @@ components:
MongoDB Cloud clusters in this network peering container exist. MongoDB
Cloud returns **null** if no clusters exist in this network peering
container.
- maxLength: 36
- minLength: 36
pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$"
readOnly: true
regions:
@@ -39355,8 +40700,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the Private
Endpoint Service.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
regionName:
@@ -39490,8 +40833,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud network container that contains the specified network peering connection.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
errorMessage:
type: string
@@ -39502,24 +40843,18 @@ components:
type: string
description: Human-readable label that identifies the GCP project that contains
the network that you want to peer with the MongoDB Cloud VPC.
- maxLength: 30
- minLength: 6
pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}"
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the network
peering connection.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
networkName:
type: string
description: Human-readable label that identifies the network to peer with
the MongoDB Cloud VPC.
- maxLength: 63
- minLength: 1
pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?"
providerName:
type: string
@@ -39732,9 +41067,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -39748,8 +41085,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -39757,8 +41092,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -39791,9 +41124,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -39834,8 +41169,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -39853,16 +41186,12 @@ components:
type: string
description: Human-readable label that identifies the project included in
the MongoDB Cloud organization.
- maxLength: 64
- minLength: 1
pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
orgId:
type: string
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud organization to which the project belongs.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
regionUsageRestrictions:
type: string
@@ -39971,6 +41300,7 @@ components:
- $ref: "#/components/schemas/ReplicaSetAlertConfigViewForNdsGroup"
- $ref: "#/components/schemas/ReplicaSetThresholdAlertConfigViewForNdsGroup"
- $ref: "#/components/schemas/ServerlessMetricAlertConfigViewForNdsGroup"
+ - $ref: "#/components/schemas/FlexMetricAlertConfigViewForNdsGroup"
- $ref: "#/components/schemas/StreamProcessorAlertConfigViewForNdsGroup"
GroupIPAddresses:
type: object
@@ -39981,8 +41311,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
services:
@@ -40008,16 +41336,12 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
groupName:
type: string
description: Human-readable label that identifies the project to which you
invited the MongoDB Cloud user.
- maxLength: 64
- minLength: 1
pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
readOnly: true
id:
@@ -40025,8 +41349,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
invitation.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
inviterUsername:
@@ -40166,8 +41488,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to move the specified project to.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
destinationOrgPrivateApiKey:
type: string
@@ -40332,8 +41652,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
to which this role belongs.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
groupRole:
type: string
@@ -40368,8 +41686,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
to which these roles belong.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
groupRoles:
type: array
@@ -40387,6 +41703,9 @@ components:
- GROUP_DATA_ACCESS_READ_ONLY
- GROUP_READ_ONLY
- GROUP_SEARCH_INDEX_EDITOR
+ - GROUP_BACKUP_MANAGER
+ - GROUP_OBSERVABILITY_VIEWER
+ - GROUP_DATABASE_ACCESS_ADMIN
uniqueItems: true
GroupService:
type: object
@@ -40433,6 +41752,8 @@ components:
- GROUP_CLUSTER_MANAGER
- GROUP_SEARCH_INDEX_EDITOR
- GROUP_STREAM_PROCESSING_OWNER
+ - GROUP_BACKUP_MANAGER
+ - GROUP_OBSERVABILITY_VIEWER
uniqueItems: true
secrets:
type: array
@@ -40471,6 +41792,8 @@ components:
- GROUP_CLUSTER_MANAGER
- GROUP_SEARCH_INDEX_EDITOR
- GROUP_STREAM_PROCESSING_OWNER
+ - GROUP_BACKUP_MANAGER
+ - GROUP_OBSERVABILITY_VIEWER
secretExpiresAfterHours:
type: integer
format: int32
@@ -40502,6 +41825,8 @@ components:
- GROUP_CLUSTER_MANAGER
- GROUP_SEARCH_INDEX_EDITOR
- GROUP_STREAM_PROCESSING_OWNER
+ - GROUP_BACKUP_MANAGER
+ - GROUP_OBSERVABILITY_VIEWER
uniqueItems: true
required:
- roles
@@ -40536,26 +41861,39 @@ components:
- GROUP_CLUSTER_MANAGER
- GROUP_SEARCH_INDEX_EDITOR
- GROUP_STREAM_PROCESSING_OWNER
+ - GROUP_BACKUP_MANAGER
+ - GROUP_OBSERVABILITY_VIEWER
GroupSettings:
type: object
description: Collection of settings that configures the project.
properties:
isCollectDatabaseSpecificsStatisticsEnabled:
type: boolean
- description: Flag that indicates whether to collect database-specific metrics for
- the specified project.
+ description: Flag that indicates whether to collect database-specific metrics
+ for the specified project.
isDataExplorerEnabled:
type: boolean
description: Flag that indicates whether to enable the Data Explorer for
the specified project.
+ isDataExplorerGenAIFeaturesEnabled:
+ type: boolean
+ description: Flag that indicates whether to enable the use of generative
+ AI features which make requests to 3rd party services in Data Explorer
+ for the specified project.
+ isDataExplorerGenAISampleDocumentPassingEnabled:
+ type: boolean
+ default: false
+ description: Flag that indicates whether to enable the passing of sample
+ field values with the use of generative AI features in the Data Explorer
+ for the specified project.
isExtendedStorageSizesEnabled:
type: boolean
- description: Flag that indicates whether to enable extended storage sizes for
- the specified project.
+ description: Flag that indicates whether to enable extended storage sizes
+ for the specified project.
isPerformanceAdvisorEnabled:
type: boolean
description: Flag that indicates whether to enable the Performance Advisor
- and Profiler for the specified project.
+ and Profiler for the specified project.
isRealtimePerformancePanelEnabled:
type: boolean
description: Flag that indicates whether to enable the Real Time Performance
@@ -40600,6 +41938,9 @@ components:
- GROUP_DATA_ACCESS_READ_ONLY
- GROUP_READ_ONLY
- GROUP_SEARCH_INDEX_EDITOR
+ - GROUP_BACKUP_MANAGER
+ - GROUP_OBSERVABILITY_VIEWER
+ - GROUP_DATABASE_ACCESS_ADMIN
minItems: 1
uniqueItems: true
writeOnly: true
@@ -40628,8 +41969,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud user.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
orgMembershipStatus:
@@ -40657,6 +41996,9 @@ components:
- GROUP_DATA_ACCESS_READ_ONLY
- GROUP_READ_ONLY
- GROUP_SEARCH_INDEX_EDITOR
+ - GROUP_BACKUP_MANAGER
+ - GROUP_OBSERVABILITY_VIEWER
+ - GROUP_DATABASE_ACCESS_ADMIN
readOnly: true
uniqueItems: true
username:
@@ -40772,9 +42114,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -40788,8 +42132,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -40797,8 +42139,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -40829,9 +42169,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -40845,11 +42187,14 @@ components:
type: string
format: date-time
description: |-
- Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
+ Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
- To acknowledge this alert forever, set the parameter value to 100 years in the future.
- To unacknowledge a previously acknowledged alert, do not set this parameter value.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
acknowledgementComment:
type: string
description: Comment that a MongoDB Cloud user submitted when acknowledging
@@ -40868,8 +42213,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration that sets this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
clusterName:
@@ -40878,17 +42221,16 @@ components:
\ this alert applies. This resource returns this parameter for alerts\
\ of events impacting backups, replica sets, or sharded clusters."
example: cluster1
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when MongoDB Cloud created this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/HostEventTypeViewForNdsGroupAlertable"
@@ -40897,8 +42239,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
hostnameAndPort:
@@ -40912,18 +42252,18 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lastNotified:
type: string
format: date-time
description: Date and time that any notifications were last sent for this
- alert. This parameter expresses its value in the ISO 8601 timestamp format
+ alert. This parameter expresses its value in the ISO 8601 timestamp format
in UTC. The resource returns this parameter if MongoDB Cloud has sent
notifications for this alert.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
links:
type: array
@@ -40941,8 +42281,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization that owns the project to which this alert applies.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
replicaSetName:
@@ -40956,10 +42294,12 @@ components:
type: string
format: date-time
description: "Date and time that this alert changed to `\"status\" : \"\
- CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
+ CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
\ format in UTC. The resource returns this parameter once `\"status\"\
\ : \"CLOSED\"`."
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
status:
type: string
@@ -40975,9 +42315,10 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- alertConfigId
@@ -41008,6 +42349,15 @@ components:
- SSH_KEY_NDS_HOST_ACCESS_ATTEMPT
- SSH_KEY_NDS_HOST_ACCESS_GRANTED
- HOST_SSH_SESSION_ENDED
+ - HOST_X509_CERTIFICATE_CERTIFICATE_GENERATED_FOR_SUPPORT_ACCESS
+ - PUSH_BASED_LOG_EXPORT_RESUMED
+ - PUSH_BASED_LOG_EXPORT_STOPPED
+ - PUSH_BASED_LOG_EXPORT_DROPPED_LOG
+ - HOST_VERSION_BEHIND
+ - VERSION_BEHIND
+ - HOST_EXPOSED
+ - HOST_SSL_CERTIFICATE_STALE
+ - HOST_SECURITY_CHECKUP_NOT_MET
example: HOST_DOWN
title: Host Event Types
HostEventTypeViewForNdsGroupAlertable:
@@ -41021,6 +42371,13 @@ components:
- HOST_NOT_ENOUGH_DISK_SPACE
- SSH_KEY_NDS_HOST_ACCESS_REQUESTED
- SSH_KEY_NDS_HOST_ACCESS_REFRESHED
+ - PUSH_BASED_LOG_EXPORT_STOPPED
+ - PUSH_BASED_LOG_EXPORT_DROPPED_LOG
+ - HOST_VERSION_BEHIND
+ - VERSION_BEHIND
+ - HOST_EXPOSED
+ - HOST_SSL_CERTIFICATE_STALE
+ - HOST_SECURITY_CHECKUP_NOT_MET
example: HOST_DOWN
title: Host Event Types
HostEventViewForNdsGroup:
@@ -41029,21 +42386,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
deskLocation:
type: string
@@ -41060,16 +42416,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -41094,8 +42446,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
port:
@@ -41107,10 +42457,11 @@ components:
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -41137,8 +42488,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -41366,11 +42715,14 @@ components:
type: string
format: date-time
description: |-
- Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
+ Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
- To acknowledge this alert forever, set the parameter value to 100 years in the future.
- To unacknowledge a previously acknowledged alert, do not set this parameter value.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
acknowledgementComment:
type: string
description: Comment that a MongoDB Cloud user submitted when acknowledging
@@ -41389,8 +42741,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration that sets this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
clusterName:
@@ -41399,17 +42749,16 @@ components:
\ this alert applies. This resource returns this parameter for alerts\
\ of events impacting backups, replica sets, or sharded clusters."
example: cluster1
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when MongoDB Cloud created this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
currentValue:
$ref: "#/components/schemas/HostMetricValue"
@@ -41420,8 +42769,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
hostnameAndPort:
@@ -41435,18 +42782,18 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lastNotified:
type: string
format: date-time
description: Date and time that any notifications were last sent for this
- alert. This parameter expresses its value in the ISO 8601 timestamp format
+ alert. This parameter expresses its value in the ISO 8601 timestamp format
in UTC. The resource returns this parameter if MongoDB Cloud has sent
notifications for this alert.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
links:
type: array
@@ -41474,8 +42821,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization that owns the project to which this alert applies.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
replicaSetName:
@@ -41489,10 +42834,12 @@ components:
type: string
format: date-time
description: "Date and time that this alert changed to `\"status\" : \"\
- CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
+ CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
\ format in UTC. The resource returns this parameter once `\"status\"\
\ : \"CLOSED\"`."
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
status:
type: string
@@ -41508,9 +42855,10 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- alertConfigId
@@ -41529,9 +42877,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -41545,8 +42895,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -41554,8 +42902,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -41588,9 +42934,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -41770,21 +43118,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
currentValue:
$ref: "#/components/schemas/HostMetricValue"
@@ -41803,16 +43150,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -41842,8 +43185,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
port:
@@ -41855,10 +43196,11 @@ components:
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -41885,8 +43227,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -42140,6 +43480,9 @@ components:
- thousand
- million
- billion
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- metricName
title: Host Metric Threshold
@@ -42193,6 +43536,9 @@ components:
- million
- billion
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
readOnly: true
InboundControlPlaneCloudProviderIPAddresses:
type: object
@@ -42436,8 +43782,6 @@ components:
description: Unique 24-hexadecimal character string that identifies a Data
Lake Pipeline run.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
backupFrequencyType:
@@ -42470,8 +43814,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lastUpdatedDate:
@@ -42493,8 +43835,6 @@ components:
description: Unique 24-hexadecimal character string that identifies a Data
Lake Pipeline.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
scheduledDeletionDate:
@@ -42508,8 +43848,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
snapshot of a cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
state:
@@ -42567,8 +43905,6 @@ components:
type: string
description: Human-readable label that identifies the cluster that incurred
the charge.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
created:
@@ -42596,8 +43932,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
associated to this line item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
groupName:
@@ -43176,8 +44510,6 @@ components:
associated with this Lightweight Directory Access Protocol (LDAP) over
Transport Layer Security (TLS) configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -43198,8 +44530,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this request
to verify an Lightweight Directory Access Protocol (LDAP) configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
status:
@@ -43446,16 +44776,12 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
labels:
@@ -43526,8 +44852,6 @@ components:
name:
type: string
description: Human-readable label that identifies the cluster.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
numShards:
type: integer
@@ -43788,16 +45112,12 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the cluster.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
labels:
@@ -43868,8 +45188,6 @@ components:
name:
type: string
description: Human-readable label that identifies the cluster.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
numShards:
type: integer
@@ -44018,8 +45336,6 @@ components:
- If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
numShards:
type: integer
@@ -44083,9 +45399,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -44099,8 +45417,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -44108,8 +45424,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -44142,9 +45456,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -44206,8 +45522,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
to be migrated.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
required:
@@ -44220,8 +45534,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the validation.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
errorMessage:
@@ -44234,8 +45546,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
to validate.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
sourceGroupId:
@@ -44243,8 +45553,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the source
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
status:
type: string
@@ -44263,9 +45571,7 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the migration
request.
- example: 507f1f77bcf86cd799439011
- maxLength: 24
- minLength: 24
+ example: 32b6e34b3d91647abb20e7b8
pattern: "^([a-f0-9]{24})$"
readOnly: true
destination:
@@ -44298,9 +45604,7 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the migration
request.
- example: 507f1f77bcf86cd799439011
- maxLength: 24
- minLength: 24
+ example: 32b6e34b3d91647abb20e7b8
pattern: "^([a-f0-9]{24})$"
readOnly: true
destination:
@@ -44345,8 +45649,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the migration
job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lagTimeSeconds:
@@ -44601,8 +45903,6 @@ components:
The project contains MongoDB processes that you want to return. The MongoDB
process can be either the `mongod` or `mongos`.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -44680,8 +45980,6 @@ components:
The project contains MongoDB processes that you want to return. The MongoDB
process can be either the `mongod` or `mongos`.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -44759,8 +46057,6 @@ components:
The project contains MongoDB processes that you want to return. The MongoDB
process can be either the `mongod` or `mongos`.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
indexIds:
@@ -44769,10 +46065,6 @@ components:
items:
type: string
description: Unique 24-hexadecimal digit string that identifies the index.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
readOnly: true
indexStatsMeasurements:
type: array
@@ -44840,8 +46132,6 @@ components:
The project contains MongoDB processes that you want to return. The MongoDB
process can be either the `mongod` or `mongos`.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
hardwareMeasurements:
@@ -45097,10 +46387,6 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the
project.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
readOnly: true
hostname:
type: string
@@ -45227,6 +46513,7 @@ components:
- ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED
- MONGODB_LOGS_DOWNLOADED
- MONGOSQLD_LOGS_DOWNLOADED
+ - MONGOT_LOGS_DOWNLOADED
- MONGODB_USER_ADDED
- MONGODB_USER_DELETED
- MONGODB_USER_X509_CERT_CREATED
@@ -45349,6 +46636,8 @@ components:
- UIS_PANICKED
- TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL
- TENANT_UPGRADE_TO_SERVERLESS_FAILED
+ - SERVERLESS_UPGRADE_TO_DEDICATED_SUCCESSFUL
+ - SERVERLESS_UPGRADE_TO_DEDICATED_FAILED
- CLUSTER_FORCE_RECONFIG_REQUESTED
- PROJECT_BYPASSED_MAINTENANCE
- FEATURE_FLAG_MAINTENANCE
@@ -45392,6 +46681,11 @@ components:
- SSL_CERTIFICATE_ISSUED
- PROJECT_SCHEDULED_MAINTENANCE_OUTSIDE_OF_PROTECTED_HOURS
- CLUSTER_CANCELING_SHARD_DRAIN_REQUESTED
+ - CLUSTER_MIGRATE_BACK_TO_AWS_MANAGED_IP_REQUESTED
+ - CLUSTER_IP_MIGRATED_FIRST_ROUND
+ - CLUSTER_IP_MIGRATED_SECOND_ROUND
+ - CLUSTER_IP_MIGRATED_FINAL_ROUND
+ - CLUSTER_IP_ROLLED_BACK
example: CLUSTER_CREATED
title: NDS Audit Types
NDSAuditTypeViewForOrg:
@@ -45408,21 +46702,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
dbUserUsername:
type: string
@@ -45437,16 +46730,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -45471,16 +46760,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
+ description: "Public part of the API Key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -45496,8 +46785,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -45506,7 +46793,6 @@ components:
description: "Email address for the user who triggered this event. If this\
\ resource returns this parameter, it doesn't return the **publicApiKey**\
\ parameter."
- example: test.user@mongodb.com
readOnly: true
whitelistEntry:
type: string
@@ -45526,21 +46812,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
dbUserUsername:
type: string
@@ -45555,16 +46840,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -45589,16 +46870,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
+ description: "Public part of the API Key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -45614,8 +46895,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -45624,7 +46903,6 @@ components:
description: "Email address for the user who triggered this event. If this\
\ resource returns this parameter, it doesn't return the **publicApiKey**\
\ parameter."
- example: test.user@mongodb.com
readOnly: true
whitelistEntry:
type: string
@@ -45662,21 +46940,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup"
@@ -45685,16 +46962,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -45719,16 +46992,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
+ description: "Public part of the API Key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -45744,8 +47017,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -45754,7 +47025,6 @@ components:
description: "Email address for the user who triggered this event. If this\
\ resource returns this parameter, it doesn't return the **publicApiKey**\
\ parameter."
- example: test.user@mongodb.com
readOnly: true
required:
- created
@@ -45823,21 +47093,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/NDSServerlessInstanceAuditTypeView"
@@ -45846,16 +47115,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -45880,16 +47145,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
+ description: "Public part of the API Key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -45905,8 +47170,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -45915,7 +47178,6 @@ components:
description: "Email address for the user who triggered this event. If this\
\ resource returns this parameter, it doesn't return the **publicApiKey**\
\ parameter."
- example: test.user@mongodb.com
readOnly: true
required:
- created
@@ -45945,29 +47207,26 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
endpointId:
type: string
description: Unique 24-hexadecimal digit string that identifies the endpoint
associated with this event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
eventTypeName:
@@ -45977,16 +47236,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -46011,8 +47266,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
providerEndpointId:
@@ -46024,9 +47277,11 @@ components:
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
+ description: "Public part of the API Key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -46042,8 +47297,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -46052,7 +47305,6 @@ components:
description: "Email address for the user who triggered this event. If this\
\ resource returns this parameter, it doesn't return the **publicApiKey**\
\ parameter."
- example: test.user@mongodb.com
readOnly: true
required:
- created
@@ -46069,9 +47321,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -46085,8 +47339,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -46094,8 +47346,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -46125,9 +47375,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -46159,6 +47411,9 @@ components:
enum:
- collection
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
readOnly: true
Namespaces:
type: object
@@ -46228,8 +47483,6 @@ components:
that contains the IP access list to which you want to add one or more
entries.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
ipAddress:
@@ -46284,8 +47537,6 @@ components:
description: Unique 40-hexadecimal digit string that identifies your New
Relic account.
example: bcc3c81b344a6030a3935c2527e2216535af7718
- maxLength: 40
- minLength: 40
pattern: "^([0-9a-f]){40}$"
id:
type: string
@@ -46297,10 +47548,11 @@ components:
Unique 40-hexadecimal digit string that identifies your New Relic license.
**IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.
- To learn more, see the New Relic Plugin EOL Statement Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.
+ Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.
example: bc3768f44193c282b2688ab39e00f8e4fc8d75ea
- maxLength: 40
- minLength: 40
+ externalDocs:
+ description: New Relic Plugin EOL Statement
+ url: https://discuss.newrelic.com/t/new-relic-plugin-eol-wednesday-june-16th-2021/127267
pattern: "^([0-9a-f]){40}$"
readToken:
type: string
@@ -46333,11 +47585,14 @@ components:
type: string
format: date-time
description: |-
- Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
+ Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
- To acknowledge this alert forever, set the parameter value to 100 years in the future.
- To unacknowledge a previously acknowledged alert, do not set this parameter value.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
acknowledgementComment:
type: string
description: Comment that a MongoDB Cloud user submitted when acknowledging
@@ -46356,8 +47611,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration that sets this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
clusterName:
@@ -46366,17 +47619,16 @@ components:
\ this alert applies. This resource returns this parameter for alerts\
\ of events impacting backups, replica sets, or sharded clusters."
example: cluster1
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when MongoDB Cloud created this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
currentValue:
$ref: "#/components/schemas/NumberMetricValueView"
@@ -46387,8 +47639,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
hostnameAndPort:
@@ -46402,18 +47652,18 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lastNotified:
type: string
format: date-time
description: Date and time that any notifications were last sent for this
- alert. This parameter expresses its value in the ISO 8601 timestamp format
+ alert. This parameter expresses its value in the ISO 8601 timestamp format
in UTC. The resource returns this parameter if MongoDB Cloud has sent
notifications for this alert.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
links:
type: array
@@ -46441,8 +47691,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization that owns the project to which this alert applies.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
replicaSetName:
@@ -46456,10 +47704,12 @@ components:
type: string
format: date-time
description: "Date and time that this alert changed to `\"status\" : \"\
- CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
+ CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
\ format in UTC. The resource returns this parameter once `\"status\"\
\ : \"CLOSED\"`."
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
status:
type: string
@@ -46475,9 +47725,10 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- alertConfigId
@@ -46491,21 +47742,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
currentValue:
$ref: "#/components/schemas/NumberMetricValueView"
@@ -46524,16 +47774,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -46563,8 +47809,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
port:
@@ -46576,10 +47820,11 @@ components:
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -46606,8 +47851,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -46697,8 +47940,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
description: On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.
@@ -46736,6 +47977,8 @@ components:
enum:
- <
- '>'
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation
OpsGenie:
type: object
description: Details to integrate one Opsgenie account with one MongoDB Cloud
@@ -46951,21 +48194,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/OrgEventTypeViewForOrg"
@@ -46974,16 +48216,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
invoiceId:
@@ -46991,8 +48229,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies of the invoice
associated with the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -47017,17 +48253,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -47043,8 +48278,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -47080,8 +48313,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this federation.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
identityProviderId:
@@ -47089,8 +48320,6 @@ components:
description: Legacy 20-hexadecimal digit string that identifies the identity
provider connected to this organization.
example: c2777a9eca931f29fc2f
- maxLength: 20
- minLength: 20
pattern: "^([a-f0-9]{20})$"
identityProviderStatus:
type: string
@@ -47114,30 +48343,20 @@ components:
type: string
description: Unique 24-hexadecimal character string that identifies the
project.
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
readOnly: true
groupName:
type: string
description: Human-readable label that identifies the project.
- maxLength: 64
- minLength: 1
pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
orgId:
type: string
description: Unique 24-hexadecimal character string that identifies the
organization that contains the project.
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
readOnly: true
orgName:
type: string
description: Human-readable label that identifies the organization that
contains the project.
- maxLength: 64
- minLength: 1
pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
planType:
type: string
@@ -47405,10 +48624,6 @@ components:
the teams to which this MongoDB Cloud user belongs.
items:
type: string
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
uniqueItems: true
writeOnly: true
username:
@@ -47436,8 +48651,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the MongoDB
Cloud user.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
orgMembershipStatus:
@@ -47458,8 +48671,6 @@ components:
items:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
uniqueItems: true
@@ -47543,8 +48754,6 @@ components:
items:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
uniqueItems: true
writeOnly: true
@@ -47574,8 +48783,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this invitation.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
inviterUsername:
@@ -47599,8 +48806,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the organization.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
orgName:
@@ -47633,10 +48838,6 @@ components:
items:
type: string
description: Unique 24-hexadecimal digit string that identifies the team.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
readOnly: true
uniqueItems: true
username:
@@ -47654,8 +48855,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
to which these roles belong.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
roles:
type: array
@@ -47700,10 +48899,6 @@ components:
items:
type: string
description: Unique 24-hexadecimal digit string that identifies the team.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
uniqueItems: true
username:
type: string
@@ -47738,10 +48933,6 @@ components:
items:
type: string
description: Unique 24-hexadecimal digit string that identifies the team.
- example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
uniqueItems: true
OrganizationSettings:
type: object
@@ -49888,6 +51079,9 @@ components:
- string
- uuid
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
order:
type: integer
format: int32
@@ -49936,8 +51130,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this index.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
impact:
@@ -49949,9 +51141,6 @@ components:
type: string
description: One unique 24-hexadecimal character string that identifies
one query shape.
- maxLength: 24
- minLength: 24
- pattern: "^([a-f0-9]{24})$"
readOnly: true
index:
type: array
@@ -50072,8 +51261,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this shape.
This string exists only for the duration of this API request.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
inefficiencyScore:
@@ -50140,8 +51327,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
policyItemId:
@@ -50149,8 +51334,6 @@ components:
description: Unique 24-hexadecimal character string that identifies a
policy item.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
description: Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.
title: Periodic Cloud Provider Snapshot Source
@@ -50346,8 +51529,6 @@ components:
description: Atlas Data Lake supports Amazon Web Services private endpoints
using the AWS PrivateLink feature.
url: https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc
- maxLength: 22
- minLength: 22
pattern: "^vpce-[0-9a-f]{17}$"
errorMessage:
type: string
@@ -50425,6 +51606,9 @@ components:
enum:
- http
- file
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
type:
type: string
description: Human-readable label that identifies the service to which you
@@ -50576,11 +51760,14 @@ components:
type: string
format: date-time
description: |-
- Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
+ Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
- To acknowledge this alert forever, set the parameter value to 100 years in the future.
- To unacknowledge a previously acknowledged alert, do not set this parameter value.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
acknowledgementComment:
type: string
description: Comment that a MongoDB Cloud user submitted when acknowledging
@@ -50599,8 +51786,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration that sets this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
clusterName:
@@ -50609,17 +51794,16 @@ components:
\ this alert applies. This resource returns this parameter for alerts\
\ of events impacting backups, replica sets, or sharded clusters."
example: cluster1
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when MongoDB Cloud created this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
currentValue:
$ref: "#/components/schemas/RawMetricValueView"
@@ -50630,8 +51814,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
hostnameAndPort:
@@ -50645,18 +51827,18 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lastNotified:
type: string
format: date-time
description: Date and time that any notifications were last sent for this
- alert. This parameter expresses its value in the ISO 8601 timestamp format
+ alert. This parameter expresses its value in the ISO 8601 timestamp format
in UTC. The resource returns this parameter if MongoDB Cloud has sent
notifications for this alert.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
links:
type: array
@@ -50684,8 +51866,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization that owns the project to which this alert applies.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
replicaSetName:
@@ -50699,10 +51879,12 @@ components:
type: string
format: date-time
description: "Date and time that this alert changed to `\"status\" : \"\
- CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
+ CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
\ format in UTC. The resource returns this parameter once `\"status\"\
\ : \"CLOSED\"`."
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
status:
type: string
@@ -50718,9 +51900,10 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- alertConfigId
@@ -50734,21 +51917,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
currentValue:
$ref: "#/components/schemas/RawMetricValueView"
@@ -50767,16 +51949,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -50806,8 +51984,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
port:
@@ -50819,10 +51995,11 @@ components:
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -50849,8 +52026,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -50962,9 +52137,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -50978,8 +52155,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -50987,8 +52162,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -51021,9 +52194,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -51038,11 +52213,14 @@ components:
type: string
format: date-time
description: |-
- Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
+ Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
- To acknowledge this alert forever, set the parameter value to 100 years in the future.
- To unacknowledge a previously acknowledged alert, do not set this parameter value.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
acknowledgementComment:
type: string
description: Comment that a MongoDB Cloud user submitted when acknowledging
@@ -51061,8 +52239,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration that sets this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
clusterName:
@@ -51071,17 +52247,16 @@ components:
\ this alert applies. This resource returns this parameter for alerts\
\ of events impacting backups, replica sets, or sharded clusters."
example: cluster1
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when MongoDB Cloud created this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable"
@@ -51090,8 +52265,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
hostnameAndPort:
@@ -51105,18 +52278,18 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lastNotified:
type: string
format: date-time
description: Date and time that any notifications were last sent for this
- alert. This parameter expresses its value in the ISO 8601 timestamp format
+ alert. This parameter expresses its value in the ISO 8601 timestamp format
in UTC. The resource returns this parameter if MongoDB Cloud has sent
notifications for this alert.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
links:
type: array
@@ -51136,8 +52309,6 @@ components:
items:
type: string
example: 32b6e34b3d91647abb20e7b8
- maxLength: 32
- minLength: 8
pattern: "^([a-f0-9]{8,32})$"
readOnly: true
readOnly: true
@@ -51146,8 +52317,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization that owns the project to which this alert applies.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
parentClusterId:
@@ -51157,8 +52326,6 @@ components:
the sharded nodes. MongoDB Cloud returns this parameter only for alerts
of events impacting sharded clusters.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 64
- minLength: 1
pattern: "^([a-f0-9]{24})$"
readOnly: true
replicaSetName:
@@ -51172,10 +52339,12 @@ components:
type: string
format: date-time
description: "Date and time that this alert changed to `\"status\" : \"\
- CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
+ CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
\ format in UTC. The resource returns this parameter once `\"status\"\
\ : \"CLOSED\"`."
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
status:
type: string
@@ -51191,9 +52360,10 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- alertConfigId
@@ -51213,6 +52383,8 @@ components:
- ONE_PRIMARY
- NO_PRIMARY
- TOO_MANY_ELECTIONS
+ - TOO_FEW_HEALTHY_MEMBERS
+ - TOO_MANY_UNHEALTHY_MEMBERS
example: PRIMARY_ELECTED
title: ReplicaSet Event Types
ReplicaSetEventTypeViewForNdsGroupAlertable:
@@ -51223,6 +52395,8 @@ components:
- NO_PRIMARY
- PRIMARY_ELECTED
- TOO_MANY_ELECTIONS
+ - TOO_FEW_HEALTHY_MEMBERS
+ - TOO_MANY_UNHEALTHY_MEMBERS
example: NO_PRIMARY
readOnly: true
title: ReplicaSet Event Types
@@ -51240,6 +52414,8 @@ components:
enum:
- TOO_MANY_ELECTIONS
- REPLICATION_OPLOG_WINDOW_RUNNING_OUT
+ - TOO_FEW_HEALTHY_MEMBERS
+ - TOO_MANY_UNHEALTHY_MEMBERS
example: TOO_MANY_ELECTIONS
title: ReplicaSet Event Types
ReplicaSetMatcher:
@@ -51295,9 +52471,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -51311,8 +52489,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -51320,8 +52496,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -51354,9 +52528,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -51376,8 +52552,6 @@ components:
\ The request deletes any existing zones in the Multi-Cloud Cluster that\
\ you exclude from the request."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
numShards:
@@ -51418,8 +52592,6 @@ components:
\ The request deletes any existing shards in the Cluster that you exclude\
\ from the request. This corresponds to Shard ID displayed in the UI."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
regionConfigs:
@@ -51438,8 +52610,6 @@ components:
in a Global Cluster. This value can be used to configure Global Cluster
backup policies.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
zoneName:
@@ -51472,21 +52642,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/ResourceEventTypeView"
@@ -51495,16 +52664,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -51529,17 +52694,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -51554,8 +52718,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the resource
associated with the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
resourceType:
@@ -51568,8 +52730,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -51592,21 +52752,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/ResourceEventTypeViewForOrg"
@@ -51615,16 +52774,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -51649,17 +52804,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -51674,8 +52828,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the resource
associated with the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
resourceType:
@@ -51688,8 +52840,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -51768,8 +52918,6 @@ components:
\ to which this role belongs. Each element within **roleAssignments**\
\ can have a value for **groupId** or **orgId**, but not both."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
orgId:
type: string
@@ -51777,8 +52925,6 @@ components:
\ to which this role belongs. Each element within **roleAssignments**\
\ can have a value for **orgId** or **groupId**, but not both."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
role:
type: string
@@ -51865,16 +53011,12 @@ components:
description: Unique 24-hexadecimal character string that identifies this
sample dataset.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
clusterName:
type: string
description: Human-readable label that identifies the cluster into which
you loaded the sample dataset.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
completeDate:
@@ -51903,6 +53045,77 @@ components:
- FAILED
- COMPLETED
readOnly: true
+ SchemaAdvisorItemRecommendation:
+ type: object
+ properties:
+ affectedNamespaces:
+ type: array
+ description: List that contains the namespaces and information on why those
+ namespaces triggered the recommendation.
+ items:
+ $ref: "#/components/schemas/SchemaAdvisorNamespaceTriggers"
+ readOnly: true
+ description:
+ type: string
+ description: Description of the specified recommendation.
+ readOnly: true
+ recommendation:
+ type: string
+ description: Type of recommendation.
+ enum:
+ - REDUCE_LOOKUP_OPS
+ - AVOID_UNBOUNDED_ARRAY
+ - REDUCE_DOCUMENT_SIZE
+ - REMOVE_UNNECESSARY_INDEXES
+ - REDUCE_NUMBER_OF_NAMESPACES
+ - OPTIMIZE_CASE_INSENSITIVE_REGEX_QUERIES
+ - OPTIMIZE_TEXT_QUERIES
+ readOnly: true
+ SchemaAdvisorNamespaceTriggers:
+ type: object
+ properties:
+ namespace:
+ type: string
+ description: Namespace of the affected collection. Will be null for REDUCE_NUMBER_OF_NAMESPACE
+ recommendation.
+ nullable: true
+ readOnly: true
+ triggers:
+ type: array
+ description: List of triggers that specify why the collection activated
+ the recommendation.
+ items:
+ $ref: "#/components/schemas/SchemaAdvisorTriggerDetails"
+ readOnly: true
+ SchemaAdvisorResponse:
+ type: object
+ properties:
+ recommendations:
+ type: array
+ description: List that contains the documents with information about the
+ schema advice that Performance Advisor suggests.
+ items:
+ $ref: "#/components/schemas/SchemaAdvisorItemRecommendation"
+ readOnly: true
+ SchemaAdvisorTriggerDetails:
+ type: object
+ properties:
+ description:
+ type: string
+ description: Description of the trigger type.
+ readOnly: true
+ triggerType:
+ type: string
+ description: Type of trigger.
+ enum:
+ - PERCENT_QUERIES_USE_LOOKUP
+ - NUMBER_OF_QUERIES_USE_LOOKUP
+ - DOCS_CONTAIN_UNBOUNDED_ARRAY
+ - NUMBER_OF_NAMESPACES
+ - DOC_SIZE_TOO_LARGE
+ - NUM_INDEXES
+ - QUERIES_CONTAIN_CASE_INSENSITIVE_REGEX
+ readOnly: true
SearchDeploymentAuditTypeView:
type: string
description: Unique identifier of event type.
@@ -51918,21 +53131,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/SearchDeploymentAuditTypeView"
@@ -51941,16 +53153,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -51975,16 +53183,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
+ description: "Public part of the API Key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -52000,8 +53208,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -52010,7 +53216,6 @@ components:
description: "Email address for the user who triggered this event. If this\
\ resource returns this parameter, it doesn't return the **publicApiKey**\
\ parameter."
- example: test.user@mongodb.com
readOnly: true
required:
- created
@@ -52122,6 +53327,9 @@ components:
externalDocs:
description: Atlas Search Analyzers
url: https://dochub.mongodb.org/core/analyzers--fts
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
analyzers:
type: array
description: List of user-defined methods to convert database field text
@@ -52184,6 +53392,9 @@ components:
- lucene.thai
- lucene.turkish
- lucene.ukrainian
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
storedSource:
type: object
description: "Flag that indicates whether to store all fields (true) on\
@@ -52236,6 +53447,9 @@ components:
enum:
- search
- vectorSearch
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- collectionName
- database
@@ -52287,8 +53501,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this Atlas
Search index.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
latestDefinition:
$ref: "#/components/schemas/SearchIndexDefinition"
@@ -52333,6 +53545,9 @@ components:
enum:
- search
- vectorSearch
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
title: Search Index Response
SearchIndexUpdateRequest:
type: object
@@ -52503,6 +53718,9 @@ components:
- lucene.thai
- lucene.turkish
- lucene.ukrainian
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
name:
type: string
description: Label that identifies the synonym definition. Each **synonym.name**
@@ -52523,8 +53741,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the private
endpoint.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
cloudProviderEndpointId:
@@ -52594,8 +53810,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the private
endpoint.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
cloudProviderEndpointId:
@@ -52689,6 +53903,9 @@ components:
- automated
- download
- pointInTime
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
deliveryUrl:
type: array
description: "One or more Uniform Resource Locators (URLs) that point to\
@@ -52726,8 +53943,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
restore job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -52773,24 +53988,18 @@ components:
description: Unique 24-hexadecimal character string that identifies the
snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
targetClusterName:
type: string
description: Human-readable label that identifies the target cluster to
which the restore job restores the snapshot. The resource returns this
parameter when `"deliveryType":` `"automated"`.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
targetGroupId:
type: string
description: Unique 24-hexadecimal digit string that identifies the target
project for the specified **targetClusterName**.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
timestamp:
type: string
@@ -52828,12 +54037,13 @@ components:
- weekly
- monthly
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -52856,8 +54066,6 @@ components:
type: string
description: Human-readable label given to the serverless instance from
which MongoDB Cloud took this snapshot.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
snapshotType:
@@ -52867,6 +54075,9 @@ components:
- onDemand
- scheduled
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
status:
type: string
description: Human-readable label that indicates the stage of the backup
@@ -52877,6 +54088,9 @@ components:
- completed
- failed
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
storageSizeBytes:
type: integer
format: int64
@@ -52956,8 +54170,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -52965,8 +54177,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the serverless
instance.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -52988,8 +54198,6 @@ components:
name:
type: string
description: Human-readable label that identifies the serverless instance.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
providerSettings:
$ref: "#/components/schemas/ServerlessProviderSettings"
@@ -53057,8 +54265,6 @@ components:
name:
type: string
description: Human-readable label that identifies the serverless instance.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
writeOnly: true
providerSettings:
@@ -53123,9 +54329,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -53139,8 +54347,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -53148,8 +54354,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -53179,9 +54383,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -53270,6 +54476,9 @@ components:
- thousand
- million
- billion
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- metricName
title: Serverless Metric Threshold
@@ -53299,6 +54508,19 @@ components:
- AWS
- AZURE
- GCP
+ effectiveDiskSizeGBLimit:
+ type: integer
+ format: int32
+ description: Storage capacity of instance data volumes expressed in gigabytes.
+ This value is not configurable for Serverless or effectively Flex clusters.
+ readOnly: true
+ effectiveInstanceSizeName:
+ $ref: "#/components/schemas/BaseCloudProviderInstanceSize"
+ effectiveProviderName:
+ type: string
+ description: Cloud service provider on which MongoDB Cloud effectively provisioned
+ the serverless instance.
+ readOnly: true
providerName:
type: string
default: SERVERLESS
@@ -53335,8 +54557,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the private
endpoint.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
cloudProviderEndpointId:
@@ -53441,8 +54661,6 @@ components:
\ id remains the same. The resource and corresponding endpoints use the\
\ term groups."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
ServiceAccountGroupEvents:
@@ -53452,21 +54670,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup"
@@ -53475,16 +54692,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -53509,17 +54722,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -53535,8 +54747,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -53608,21 +54818,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/ServiceAccountEventTypeViewForOrg"
@@ -53631,16 +54840,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -53665,17 +54870,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -53691,8 +54895,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -53935,9 +55137,7 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the source
project.
- example: 9b43a5b329223c3a1591a678
- maxLength: 24
- minLength: 24
+ example: 32b6e34b3d91647abb20e7b8
pattern: "^([a-f0-9]{24})$"
managedAuthentication:
type: boolean
@@ -54027,9 +55227,11 @@ components:
type: string
format: date-time
description: Date and time when MongoDB Cloud created the alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
enabled:
type: boolean
@@ -54043,8 +55245,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
@@ -54052,8 +55252,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies this alert
configuration.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -54082,9 +55280,11 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert configuration.
- This parameter expresses its value in the ISO 8601 timestamp format
- in UTC.
+ This parameter expresses its value in the ISO 8601 timestamp format in
+ UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- eventTypeName
@@ -54099,11 +55299,14 @@ components:
type: string
format: date-time
description: |-
- Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
+ Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
- To acknowledge this alert forever, set the parameter value to 100 years in the future.
- To unacknowledge a previously acknowledged alert, do not set this parameter value.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
acknowledgementComment:
type: string
description: Comment that a MongoDB Cloud user submitted when acknowledging
@@ -54122,17 +55325,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration that sets this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when MongoDB Cloud created this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/HostEventTypeViewForNdsGroupAlertable"
@@ -54141,16 +55343,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
instanceName:
@@ -54164,10 +55362,12 @@ components:
type: string
format: date-time
description: Date and time that any notifications were last sent for this
- alert. This parameter expresses its value in the ISO 8601 timestamp format
+ alert. This parameter expresses its value in the ISO 8601 timestamp format
in UTC. The resource returns this parameter if MongoDB Cloud has sent
notifications for this alert.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
links:
type: array
@@ -54185,8 +55385,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization that owns the project to which this alert applies.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
processorErrorMsg:
@@ -54215,10 +55413,12 @@ components:
type: string
format: date-time
description: "Date and time that this alert changed to `\"status\" : \"\
- CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
+ CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
\ format in UTC. The resource returns this parameter once `\"status\"\
\ : \"CLOSED\"`."
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
status:
type: string
@@ -54234,9 +55434,10 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- alertConfigId
@@ -54269,8 +55470,10 @@ components:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup"
@@ -54279,16 +55482,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
instanceName:
@@ -54313,8 +55512,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
processorErrorMsg:
@@ -54340,6 +55537,35 @@ components:
- eventTypeName
- id
title: Stream Processor Events
+ StreamsAWSConnectionBaseConfig:
+ type: object
+ description: The base configuration of AWS connection used in stream processors.
+ properties:
+ links:
+ type: array
+ 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."
+ externalDocs:
+ description: Web Linking Specification (RFC 5988)
+ url: https://datatracker.ietf.org/doc/html/rfc5988
+ items:
+ $ref: "#/components/schemas/Link"
+ readOnly: true
+ roleArn:
+ type: string
+ description: Amazon Resource Name (ARN) that identifies the Amazon Web Services
+ (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes
+ when it accesses resources in your AWS account.
+ StreamsAWSLambdaConnection:
+ type: object
+ allOf:
+ - $ref: "#/components/schemas/StreamsConnection"
+ - type: object
+ properties:
+ aws:
+ $ref: "#/components/schemas/StreamsAWSConnectionBaseConfig"
+ description: The configuration for AWS Lambda connections.
StreamsClusterConnection:
type: object
allOf:
@@ -54390,6 +55616,9 @@ components:
- Cluster
- Sample
- Https
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
readOnly: true
StreamsDLQ:
type: object
@@ -54426,8 +55655,8 @@ components:
cloudProvider:
type: string
description: "Label that identifies the cloud service provider where MongoDB\
- \ Cloud performs stream processing. Currently, this parameter supports\
- \ AWS only."
+ \ Cloud performs stream processing. Currently, this parameter only supports\
+ \ AWS and AZURE."
enum:
- AWS
- GCP
@@ -54465,8 +55694,10 @@ components:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/StreamsEventTypeViewForNdsGroup"
@@ -54475,16 +55706,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
instanceName:
@@ -54509,8 +55736,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
raw:
@@ -54621,8 +55846,6 @@ components:
type: string
description: Reserved. Will be used by PRIVATE_LINK connection type.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
links:
type: array
@@ -54785,6 +56008,10 @@ components:
description: The ID of the Private Link connection.
example: 32b6e34b3d91647abb20e7b8
pattern: "^([a-f0-9]{24})$"
+ readOnly: true
+ arn:
+ type: string
+ description: Amazon Resource Name (ARN).
dnsDomain:
type: string
description: Domain name of Privatelink connected cluster.
@@ -54794,10 +56021,15 @@ components:
availability zones.
items:
type: string
+ errorMessage:
+ type: string
+ description: Error message if the state is FAILED.
+ readOnly: true
interfaceEndpointId:
type: string
description: Interface endpoint ID that is created from the service endpoint
ID provided.
+ readOnly: true
links:
type: array
description: "List of one or more Uniform Resource Locators (URLs) that\
@@ -54812,6 +56044,10 @@ components:
provider:
type: string
description: Provider where the Kafka cluster is deployed.
+ providerAccountId:
+ type: string
+ description: Account ID from the cloud provider.
+ readOnly: true
region:
type: string
description: Domain name of Confluent cluster.
@@ -54821,6 +56057,7 @@ components:
state:
type: string
description: State the connection is in.
+ readOnly: true
vendor:
type: string
description: Vendor who manages the Kafka cluster.
@@ -54833,8 +56070,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
stream processor.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -54871,8 +56106,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
stream processor.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -54957,8 +56190,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
connections:
@@ -54974,8 +56205,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
hostnames:
@@ -55098,6 +56327,9 @@ components:
enum:
- MongoDB Atlas
readOnly: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
build:
type: string
description: Unique 40-hexadecimal digit hash that identifies the latest
@@ -55151,8 +56383,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this team.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -55186,21 +56416,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/TeamEventTypeView"
@@ -55209,16 +56438,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -55243,17 +56468,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -55268,8 +56492,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
team associated with this event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
userId:
@@ -55278,8 +56500,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -55324,21 +56544,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/TeamEventTypeViewForNdsGroup"
@@ -55347,16 +56566,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -55381,17 +56596,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -55406,8 +56620,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
team associated with this event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
userId:
@@ -55416,8 +56628,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -55480,8 +56690,6 @@ components:
\ Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\"\
\ : \"TEAM\"`."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
teamName:
type: string
@@ -55504,8 +56712,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this team.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -55555,8 +56761,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
team.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
TeamUpdate:
type: object
@@ -55648,11 +56852,17 @@ components:
description: "Cloud service provider on which MongoDB Cloud provisioned\
\ the multi-tenant cluster. The resource returns this parameter when\
\ **providerName** is `TENANT` and **electableSpecs.instanceSize** is\
- \ `M0`, `M2` or `M5`."
+ \ `M0`, `M2` or `M5`. \n\nPlease note that using an instanceSize of\
+ \ M2 or M5 will create a Flex cluster instead. Support for the instanceSize\
+ \ of M2 or M5 will be discontinued in January 2026. We recommend using\
+ \ the createFlexCluster API for such configurations moving forward."
enum:
- AWS
- GCP
- AZURE
+ externalDocs:
+ description: createFlexCluster API
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster
description: Details that explain how MongoDB Cloud replicates data in one region
on the specified MongoDB database.
title: Tenant Regional Replication Specifications
@@ -55667,11 +56877,17 @@ components:
description: "Cloud service provider on which MongoDB Cloud provisioned\
\ the multi-tenant cluster. The resource returns this parameter when\
\ **providerName** is `TENANT` and **electableSpecs.instanceSize** is\
- \ `M0`, `M2` or `M5`."
+ \ `M0`, `M2` or `M5`. \n\nPlease note that using an instanceSize of\
+ \ M2 or M5 will create a Flex cluster instead. Support for the instanceSize\
+ \ of M2 or M5 will be discontinued in January 2026. We recommend using\
+ \ the createFlexCluster API for such configurations moving forward."
enum:
- AWS
- GCP
- AZURE
+ externalDocs:
+ description: createFlexCluster API
+ url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster
description: Details that explain how MongoDB Cloud replicates data in one region
on the specified MongoDB database.
title: Tenant Regional Replication Specifications
@@ -55681,8 +56897,6 @@ components:
clusterName:
type: string
description: Human-readable label that identifies the source cluster.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
deliveryType:
@@ -55704,8 +56918,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the restore
job.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -55724,8 +56936,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
from which the restore job originated.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
restoreFinishedDate:
@@ -55754,8 +56964,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the snapshot
to restore.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
snapshotUrl:
type: string
@@ -55779,16 +56987,12 @@ components:
description: Human-readable label that identifies the cluster on the target
project to which you want to restore the snapshot. You can restore the
snapshot to a cluster tier *M2* or greater.
- maxLength: 64
- minLength: 1
pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
targetProjectId:
type: string
description: Unique 24-hexadecimal digit string that identifies the project
that contains the cluster to which you want to restore the snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
required:
- snapshotId
@@ -55912,6 +57116,9 @@ components:
externalDocs:
description: Atlas Search Analyzers
url: https://dochub.mongodb.org/core/analyzers--fts
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
analyzers:
type: array
description: List of user-defined methods to convert database field text
@@ -55980,6 +57187,9 @@ components:
- lucene.thai
- lucene.turkish
- lucene.ukrainian
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
storedSource:
type: object
description: "Flag that indicates whether to store all fields (true) on\
@@ -56129,11 +57339,14 @@ components:
type: string
format: date-time
description: |-
- Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
+ Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
- To acknowledge this alert forever, set the parameter value to 100 years in the future.
- To unacknowledge a previously acknowledged alert, do not set this parameter value.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
acknowledgementComment:
type: string
description: Comment that a MongoDB Cloud user submitted when acknowledging
@@ -56152,8 +57365,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration that sets this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
clusterName:
@@ -56162,17 +57373,16 @@ components:
\ this alert applies. This resource returns this parameter for alerts\
\ of events impacting backups, replica sets, or sharded clusters."
example: cluster1
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when MongoDB Cloud created this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
currentValue:
$ref: "#/components/schemas/TimeMetricValueView"
@@ -56183,8 +57393,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
that owns this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
hostnameAndPort:
@@ -56198,18 +57406,18 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies this alert.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
lastNotified:
type: string
format: date-time
description: Date and time that any notifications were last sent for this
- alert. This parameter expresses its value in the ISO 8601 timestamp format
+ alert. This parameter expresses its value in the ISO 8601 timestamp format
in UTC. The resource returns this parameter if MongoDB Cloud has sent
notifications for this alert.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
links:
type: array
@@ -56237,8 +57445,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
organization that owns the project to which this alert applies.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
replicaSetName:
@@ -56252,10 +57458,12 @@ components:
type: string
format: date-time
description: "Date and time that this alert changed to `\"status\" : \"\
- CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
+ CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\
\ format in UTC. The resource returns this parameter once `\"status\"\
\ : \"CLOSED\"`."
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
status:
type: string
@@ -56271,9 +57479,10 @@ components:
type: string
format: date-time
description: Date and time when someone last updated this alert. This parameter
- expresses its value in the ISO 8601 timestamp format
- in UTC.
+ expresses its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
required:
- alertConfigId
@@ -56287,21 +57496,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
currentValue:
$ref: "#/components/schemas/TimeMetricValueView"
@@ -56320,16 +57528,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -56359,8 +57563,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
port:
@@ -56372,10 +57574,11 @@ components:
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -56402,8 +57605,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -56482,6 +57683,9 @@ components:
description: Human-readable label that identifies this token filter type.
enum:
- englishPossessive
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: englishPossessive
@@ -56496,6 +57700,9 @@ components:
description: Human-readable label that identifies this token filter type.
enum:
- flattenGraph
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: flattenGraph
@@ -56510,6 +57717,9 @@ components:
description: Human-readable label that identifies this token filter type.
enum:
- porterStemming
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: porterStemming
@@ -56522,6 +57732,9 @@ components:
description: Human-readable label that identifies this token filter type.
enum:
- spanishPluralStemming
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: spanishPluralStemming
@@ -56538,6 +57751,9 @@ components:
description: Human-readable label that identifies this token filter type.
enum:
- stempel
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: stempel
@@ -56618,6 +57834,9 @@ components:
description: Human-readable label that identifies this token filter type.
enum:
- wordDelimiterGraph
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: wordDelimiterGraph
@@ -56631,6 +57850,9 @@ components:
description: Human-readable label that identifies this token filter type.
enum:
- kStemming
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: kStemming
@@ -56644,8 +57866,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
snapshot.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
writeOnly: true
required:
@@ -56850,6 +58070,9 @@ components:
- Support
- Credits
uniqueItems: true
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
usageEndDate:
type: string
format: date
@@ -56955,13 +58178,13 @@ components:
- GROUP_STREAM_PROCESSING_OWNER
- GROUP_OWNER
- GROUP_READ_ONLY
+ - GROUP_BACKUP_MANAGER
+ - GROUP_OBSERVABILITY_VIEWER
userId:
type: string
description: Unique 24-hexadecimal digit string that identifies the organization
API key.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
UserCert:
@@ -56985,8 +58208,6 @@ components:
description: Unique 24-hexadecimal character string that identifies the
project.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
links:
@@ -57078,21 +58299,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/UserEventTypeViewForNdsGroup"
@@ -57101,16 +58321,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -57135,17 +58351,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -57169,8 +58384,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -57192,21 +58405,20 @@ components:
properties:
apiKeyId:
type: string
- description: "Unique 24-hexadecimal digit string that identifies the [API\
- \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
- \ triggered the event. If this resource returns this parameter, it doesn't\
- \ return the **userId** parameter."
+ description: "Unique 24-hexadecimal digit string that identifies the API\
+ \ Key that triggered the event. If this resource returns this parameter,\
+ \ it doesn't return the **userId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
created:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
eventTypeName:
$ref: "#/components/schemas/UserEventTypeViewForOrg"
@@ -57215,16 +58427,12 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred. The **eventId** identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
id:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
isGlobalAdmin:
@@ -57249,17 +58457,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
publicKey:
type: string
format: email
- description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
- \ that triggered the event. If this resource returns this parameter, it\
- \ doesn't return the **username** parameter."
- example: test.user@mongodb.com
+ description: "Public part of the API key that triggered the event. If this\
+ \ resource returns this parameter, it doesn't return the **username**\
+ \ parameter."
+ externalDocs:
+ url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
raw:
$ref: "#/components/schemas/raw"
@@ -57283,8 +58490,6 @@ components:
\ user who triggered the event. If this resource returns this parameter,\
\ it doesn't return the **apiKeyId** parameter."
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
username:
@@ -57364,8 +58569,6 @@ components:
type: string
description: Human-readable label that identifies the cluster or MongoDB
Atlas Data Lake that this database user can access.
- maxLength: 64
- minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
type:
type: string
@@ -57689,11 +58892,11 @@ components:
nullable: true
secret:
type: string
+ format: password
description: |-
An optional field returned if your webhook is configured with a secret.
**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
- example: '******'
type:
type: string
description: Human-readable label that identifies the service to which you
@@ -57748,15 +58951,18 @@ components:
- WEBHOOK
webhookSecret:
type: string
+ format: password
description: |-
Authentication secret for a webhook-based alert.
Atlas returns this value if you set `"notifications.[n].typeName" :"WEBHOOK"` and either:
* You set `notification.[n].webhookSecret` to a non-empty string
- * You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)
+ * You set a default webhookSecret either on the Integrations page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)
**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
- example: '******'
+ externalDocs:
+ description: Integrations page
+ url: https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations
webhookUrl:
type: string
description: |-
@@ -57885,6 +59091,9 @@ components:
type.
enum:
- htmlStrip
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: htmlStrip
@@ -57902,6 +59111,9 @@ components:
type.
enum:
- icuNormalize
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: icuNormalize
@@ -57925,6 +59137,9 @@ components:
type.
enum:
- mapping
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- mappings
- type
@@ -57943,6 +59158,9 @@ components:
type.
enum:
- persian
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: persian
@@ -57962,8 +59180,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the alert
configuration related to the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
cid:
@@ -57971,16 +59187,16 @@ components:
description: Unique 24-hexadecimal digit string that identifies the project
in which the event occurred.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
cre:
type: string
format: date-time
description: Date and time when this event occurred. This parameter expresses
- its value in the ISO 8601 timestamp format in UTC.
+ its value in the ISO 8601 timestamp format in UTC.
+ externalDocs:
+ description: ISO 8601
+ url: https://en.wikipedia.org/wiki/ISO_8601
readOnly: true
description:
type: string
@@ -57996,8 +59212,6 @@ components:
type: string
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
orgId:
@@ -58005,8 +59219,6 @@ components:
description: Unique 24-hexadecimal digit string that identifies the organization
to which these events apply.
example: 32b6e34b3d91647abb20e7b8
- maxLength: 24
- minLength: 24
pattern: "^([a-f0-9]{24})$"
readOnly: true
orgName:
@@ -58046,11 +59258,17 @@ components:
enum:
- omit
- include
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
type:
type: string
description: Human-readable label that identifies this token filter type.
enum:
- asciiFolding
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: asciiFolding
@@ -58079,11 +59297,17 @@ components:
enum:
- omit
- include
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
type:
type: string
description: Human-readable label that identifies this token filter type.
enum:
- daitchMokotoffSoundex
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: daitchMokotoffSoundex
@@ -58109,11 +59333,17 @@ components:
enum:
- omit
- include
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
type:
type: string
description: Human-readable label that identifies this token filter type.
enum:
- edgeGram
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- maxGram
- minGram
@@ -58132,6 +59362,9 @@ components:
description: Human-readable label that identifies this token filter type.
enum:
- icuFolding
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: icuFolding
@@ -58152,11 +59385,17 @@ components:
- nfc
- nfkd
- nfkc
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
type:
type: string
description: Human-readable label that identifies this token filter type.
enum:
- icuNormalizer
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: icuNormalizer
@@ -58179,6 +59418,9 @@ components:
description: Human-readable label that identifies this token filter type.
enum:
- length
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: length
@@ -58191,6 +59433,9 @@ components:
description: Human-readable label that identifies this token filter type.
enum:
- lowercase
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: lowercase
@@ -58215,11 +59460,17 @@ components:
enum:
- omit
- include
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
type:
type: string
description: Human-readable label that identifies this token filter type.
enum:
- nGram
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- maxGram
- minGram
@@ -58237,6 +59488,9 @@ components:
enum:
- all
- first
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
pattern:
type: string
description: Regular expression pattern to apply to each token.
@@ -58249,6 +59503,9 @@ components:
description: Human-readable label that identifies this token filter type.
enum:
- regex
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- matches
- pattern
@@ -58264,6 +59521,9 @@ components:
description: Human-readable label that identifies this token filter type.
enum:
- reverse
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: reverse
@@ -58286,6 +59546,9 @@ components:
description: Human-readable label that identifies this token filter type.
enum:
- shingle
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- maxShingleSize
- minShingleSize
@@ -58327,11 +59590,17 @@ components:
- spanish
- swedish
- turkish
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
type:
type: string
description: Human-readable label that identifies this token filter type.
enum:
- snowballStemming
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- stemmerName
- type
@@ -58357,6 +59626,9 @@ components:
description: Human-readable label that identifies this token filter type.
enum:
- stopword
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- tokens
- type
@@ -58370,6 +59642,9 @@ components:
description: Human-readable label that identifies this token filter type.
enum:
- trim
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: trim
@@ -58392,6 +59667,9 @@ components:
description: Human-readable label that identifies this tokenizer type.
enum:
- edgeGram
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- maxGram
- minGram
@@ -58406,6 +59684,9 @@ components:
description: Human-readable label that identifies this tokenizer type.
enum:
- keyword
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: keyword
@@ -58428,6 +59709,9 @@ components:
description: Human-readable label that identifies this tokenizer type.
enum:
- edgeGram
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- maxGram
- minGram
@@ -58449,6 +59733,9 @@ components:
description: Human-readable label that identifies this tokenizer type.
enum:
- regexCaptureGroup
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- group
- pattern
@@ -58466,6 +59753,9 @@ components:
description: Human-readable label that identifies this tokenizer type.
enum:
- regexSplit
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- pattern
- type
@@ -58488,6 +59778,9 @@ components:
description: Human-readable label that identifies this tokenizer type.
enum:
- standard
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: standard
@@ -58512,6 +59805,9 @@ components:
description: Human-readable label that identifies this tokenizer type.
enum:
- uaxUrlEmail
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: uaxUrlEmail
@@ -58530,6 +59826,9 @@ components:
description: Human-readable label that identifies this tokenizer type.
enum:
- whitespace
+ x-xgen-IPA-exception:
+ xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA
+ validation
required:
- type
title: whitespace
diff --git a/openapi/versions.json b/openapi/versions.json
index 791fa200c..2cd8cb25a 100644
--- a/openapi/versions.json
+++ b/openapi/versions.json
@@ -1 +1 @@
-{"versions":{"2.0":["2023-01-01","2023-02-01","2023-10-01","2023-11-15","2024-05-30","2024-08-05","2024-10-23","2024-11-13"],"major":["1.0","2.0"]}}
\ No newline at end of file
+{"versions":{"2.0":["2023-01-01","2023-02-01","2023-10-01","2023-11-15","2024-05-30","2024-08-05","2024-10-23","2024-11-13","2043-01-01"],"major":["1.0","2.0"]}}
\ No newline at end of file
diff --git a/test/example_client_test.go b/test/example_client_test.go
index ed83a6605..917271429 100644
--- a/test/example_client_test.go
+++ b/test/example_client_test.go
@@ -3,7 +3,7 @@ package test
import (
"fmt"
- "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ "github.com/mongodb/atlas-sdk-go/admin"
)
func ExampleNewClient() {
diff --git a/test/utils_test.go b/test/utils_test.go
index 1279a066c..b82641136 100644
--- a/test/utils_test.go
+++ b/test/utils_test.go
@@ -4,7 +4,7 @@ import (
"testing"
"time"
- "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ "github.com/mongodb/atlas-sdk-go/admin"
)
type testCase[T comparable] struct {
diff --git a/tools/config/go-templates/api_doc.mustache b/tools/config/go-templates/api_doc.mustache
index aec068e14..320722f45 100644
--- a/tools/config/go-templates/api_doc.mustache
+++ b/tools/config/go-templates/api_doc.mustache
@@ -29,7 +29,7 @@ import (
"fmt"
"os"
- "go.mongodb.org/atlas-sdk/v20241113004/admin"
+ "github.com/mongodb/atlas-sdk-go/admin"
)
func main() {
diff --git a/tools/config/go-templates/atlas_client.mustache b/tools/config/go-templates/atlas_client.mustache
index 99c4a2a9b..1c1b2af41 100644
--- a/tools/config/go-templates/atlas_client.mustache
+++ b/tools/config/go-templates/atlas_client.mustache
@@ -1,4 +1,4 @@
-{{! X-XGEN-CUSTOM }}package {{packageName}} // import "go.mongodb.org/atlas-sdk/v20241113004/admin"
+{{! X-XGEN-CUSTOM }}package {{packageName}} // import "github.com/mongodb/atlas-sdk-go/admin"
import (
"errors"
@@ -6,9 +6,9 @@ import (
"strings"
"github.com/mongodb-forks/digest"
- "go.mongodb.org/atlas-sdk/v20241113004/auth"
- "go.mongodb.org/atlas-sdk/v20241113004/auth/clientcredentials"
- "go.mongodb.org/atlas-sdk/v20241113004/internal/core"
+ "github.com/mongodb/atlas-sdk-go/auth"
+ "github.com/mongodb/atlas-sdk-go/auth/clientcredentials"
+ "github.com/mongodb/atlas-sdk-go/internal/core"
)
const (