Skip to content

Latest commit

 

History

History
873 lines (832 loc) · 113 KB

README.md

File metadata and controls

873 lines (832 loc) · 113 KB

Go API client for openapi

The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas. To learn more, review the Administration API overview. This OpenAPI specification covers all of the collections with the exception of Alerts, Alert Configurations, and Events. Refer to the legacy documentation for the specifications of these resources.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://cloud.mongodb.com

Class Method HTTP request Description
AccessTrackingApi ReturnDatabaseAccessHistoryForOneClusterUsingItsClusterName Get /api/atlas/v1.0/groups/{groupId}/dbAccessHistory/clusters/{clusterName} Return Database Access History for One Cluster using Its Cluster Name
AccessTrackingApi ReturnDatabaseAccessHistoryForOneClusterUsingItsHostname Get /api/atlas/v1.0/groups/{groupId}/dbAccessHistory/processes/{hostname} Return Database Access History for One Cluster using Its Hostname
AlertConfigurationsApi CreateOneAlertConfigurationInOneProject Post /api/atlas/v1.0/groups/{groupId}/alertConfigs Create One Alert Configuration in One Project
AlertConfigurationsApi RemoveOneAlertConfigurationFromOneProject Delete /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId} Remove One Alert Configuration from One Project
AlertConfigurationsApi ReturnAlertConfigMatchersFieldNames Get /api/atlas/v1.0/alertConfigs/matchers/fieldNames Get All Alert Configuration Matchers Field Names
AlertConfigurationsApi ReturnAllAlertConfigurationsForOneProject Get /api/atlas/v1.0/groups/{groupId}/alertConfigs Return All Alert Configurations for One Project
AlertConfigurationsApi ReturnAllOpenAlertsForAlertConfiguration Get /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId}/alerts Return All Open Alerts for Alert Configuration
AlertConfigurationsApi ReturnOneAlertConfigurationFromOneProject Get /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId} Return One Alert Configuration from One Project
AlertConfigurationsApi ToggleOneStateOfOneAlertConfigurationInOneProject Patch /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId} Toggle One State of One Alert Configuration in One Project
AlertConfigurationsApi UpdateOneAlertConfigurationForOneProject Put /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId} Update One Alert Configuration for One Project
AlertsApi AcknowledgeOneAlertFromOneProject Patch /api/atlas/v1.0/groups/{groupId}/alerts/{alertId} Acknowledge One Alert from One Project
AlertsApi ReturnAllAlertConfigurationsSetForOneAlert Get /api/atlas/v1.0/groups/{groupId}/alerts/{alertId}/alertConfigs Return All Alert Configurations Set for One Alert
AlertsApi ReturnAllAlertsFromOneProject Get /api/atlas/v1.0/groups/{groupId}/alerts Return All Alerts from One Project
AlertsApi ReturnOneAlertFromOneProject Get /api/atlas/v1.0/groups/{groupId}/alerts/{alertId} Return One Alert from One Project
AtlasSearchApi CreateOneAtlasSearchIndex Post /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/indexes Create One Atlas Search Index
AtlasSearchApi RemoveOneAtlasSearchIndex Delete /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId} Remove One Atlas Search Index
AtlasSearchApi ReturnAllAtlasSearchIndexesForOneCollection Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName} Return All Atlas Search Indexes for One Collection
AtlasSearchApi ReturnAllUserDefinedAnalyzersForOneCluster Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/analyzers Return All User-Defined Analyzers for One Cluster
AtlasSearchApi ReturnOneAtlasSearchIndex Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId} Return One Atlas Search Index
AtlasSearchApi UpdateAllUserDefinedAnalyzersForOneCluster Put /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/analyzers Update All User-Defined Analyzers for One Cluster
AtlasSearchApi UpdateOneAtlasSearchIndex Patch /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId} Update One Atlas Search Index
AuditingApi ReturnOneAuditingConfigurationForOneProject Get /api/atlas/v1.0/groups/{groupId}/auditLog Return the Auditing Configuration for One Project
AuditingApi UpdateAuditingConfigurationForOneProject Patch /api/atlas/v1.0/groups/{groupId}/auditLog Update Auditing Configuration for One Project
CloudBackupExportApi CreateOneCloudBackupSnapshotExportJob Post /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/exports Create One Cloud Backup Snapshot Export Job
CloudBackupExportApi GrantAccessToAwsS3BucketForCloudBackupSnapshotExports Post /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets Grant Access to AWS S3 Bucket for Cloud Backup Snapshot Exports
CloudBackupExportApi ReturnAllAwsS3BucketsUsedForCloudBackupSnapshotExports Get /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets Return All AWS S3 Buckets Used for Cloud Backup Snapshot Exports
CloudBackupExportApi ReturnAllCloudBackupSnapshotExportJobs Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/exports Return All Cloud Backup Snapshot Export Jobs
CloudBackupExportApi ReturnOneAwsS3BucketUsedForCloudBackupSnapshotExports Get /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets/{exportBucketId} Return One AWS S3 Bucket Used for Cloud Backup Snapshot Exports
CloudBackupExportApi ReturnOneCloudBackupSnapshotExportJob Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId} Return One Cloud Backup Snapshot Export Job
CloudBackupExportApi RevokeAccessToAwsS3BucketForCloudBackupSnapshotExports Delete /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets/{exportBucketId} Revoke Access to AWS S3 Bucket for Cloud Backup Snapshot Exports
CloudBackupRestoreJobsApi CancelOneRestoreJobOfOneCluster Delete /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId} Cancel One Restore Job of One Cluster
CloudBackupRestoreJobsApi RestoreOneSnapshotOfOneCluster Post /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs Restore One Snapshot of One Cluster
CloudBackupRestoreJobsApi RestoreOneSnapshotOfOneCluster1 Post /api/atlas/v1.0/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs Restore One Snapshot of One Serverless Instance
CloudBackupRestoreJobsApi ReturnAllRestoreJobsForOneCluster Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs Return All Restore Jobs for One Cluster
CloudBackupRestoreJobsApi ReturnAllRestoreJobsForOneServerlessInstance Get /api/atlas/v1.0/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs Return All Restore Jobs for One Serverless Instance
CloudBackupRestoreJobsApi ReturnOneRestoreJobForOneServerlessInstance Get /api/atlas/v1.0/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId} Return One Restore Job for One Serverless Instance
CloudBackupRestoreJobsApi ReturnOneRestoreJobOfOneCluster Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId} Return One Restore Job of One Cluster
CloudBackupScheduleApi RemoveAllCloudBackupSchedules Delete /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/schedule Remove All Cloud Backup Schedules
CloudBackupScheduleApi ReturnOneCloudBackupSchedule Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/schedule Return One Cloud Backup Schedule
CloudBackupScheduleApi UpdateCloudBackupBackupPolicyForOneCluster Patch /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/schedule Update Cloud Backup Schedule for One Cluster
CloudBackupsApi ChangeExpirationDateForOneCloudBackup Patch /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId} Change Expiration Date for One Cloud Backup
CloudBackupsApi RemoveOneReplicaSetCloudBackup Delete /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId} Remove One Replica Set Cloud Backup
CloudBackupsApi RemoveOneShardedClusterCloudBackup Delete /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId} Remove One Sharded Cluster Cloud Backup
CloudBackupsApi ReturnAllReplicaSetCloudBackups Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/snapshots Return All Replica Set Cloud Backups
CloudBackupsApi ReturnAllShardedClusterCloudBackups Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters Return All Sharded Cluster Cloud Backups
CloudBackupsApi ReturnAllSnapshotsOfOneServerlessInstance Get /api/atlas/v1.0/groups/{groupId}/serverless/{clusterName}/backup/snapshots Return All Snapshots of One Serverless Instance
CloudBackupsApi ReturnOneReplicaSetCloudBackup Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId} Return One Replica Set Cloud Backup
CloudBackupsApi ReturnOneShardedClusterCloudBackup Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId} Return One Sharded Cluster Cloud Backup
CloudBackupsApi ReturnOneSnapshotOfOneServerlessInstance Get /api/atlas/v1.0/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId} Return One Snapshot of One Serverless Instance
CloudBackupsApi TakeOneOnDemandSnapshot Post /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/snapshots Take One On-Demand Snapshot
CloudMigrationServiceApi AvailableProjects Get /api/atlas/v1.0/orgs/{orgId}/liveMigrations/availableProjects Return All Projects Available for Migration
CloudMigrationServiceApi CreateLinkToken Post /api/atlas/v1.0/orgs/{orgId}/liveMigrations/linkTokens Create One Link-Token
CloudMigrationServiceApi CreatePushMigration Post /api/atlas/v1.0/groups/{groupId}/liveMigrations Migrate One Local Managed Cluster to MongoDB Atlas
CloudMigrationServiceApi CutoverOneMigration Put /api/atlas/v1.0/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover Cut Over the Migrated Cluster
CloudMigrationServiceApi DeleteOrgLink Delete /api/public/v1.0/orgs/{orgId}/liveExport/migrationLink Remove One Link between Organizations
CloudMigrationServiceApi DeleteOrgLink1 Delete /api/atlas/v1.0/orgs/{orgId}/liveMigrations/linkTokens Remove One Link-Token
CloudMigrationServiceApi MigrationLink Post /api/public/v1.0/orgs/{orgId}/liveExport/migrationLink Link the Local Organization with MongoDB Atlas
CloudMigrationServiceApi MigrationLinkStatus Get /api/public/v1.0/orgs/{orgId}/liveExport/migrationLink/status Return Status of the Organization Link
CloudMigrationServiceApi ReturnOnePushMigration Get /api/atlas/v1.0/groups/{groupId}/liveMigrations/{liveMigrationId} Return One Migration Job
CloudMigrationServiceApi ReturnOneValidationJob Get /api/atlas/v1.0/groups/{groupId}/liveMigrations/validate/{validationId} Return One Migration Validation Job
CloudMigrationServiceApi ValidateOneMigration Post /api/atlas/v1.0/groups/{groupId}/liveMigrations/validate Validate One Migration Request
CloudProviderAccessApi AuthorizeOneCloudProviderAccessRole Patch /api/atlas/v1.0/groups/{groupId}/cloudProviderAccess/{roleId} Authorize One Cloud Provider Access Role
CloudProviderAccessApi CreateOneCloudProviderAccessRole Post /api/atlas/v1.0/groups/{groupId}/cloudProviderAccess Create One Cloud Provider Access Role
CloudProviderAccessApi DeauthorizeOneCloudProviderAccessRole Delete /api/atlas/v1.0/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId} Deauthorize One Cloud Provider Access Role
CloudProviderAccessApi ReturnAllCloudProviderAccessRoles Get /api/atlas/v1.0/groups/{groupId}/cloudProviderAccess Return All Cloud Provider Access Roles
CloudProviderAccessApi ReturnCloudProviderAccessRole Get /api/atlas/v1.0/groups/{groupId}/cloudProviderAccess/{roleId} Return specified Cloud Provider Access Role
ClusterOutageSimulationApi EndOutageSimulation Delete /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/outageSimulation End an Outage Simulation
ClusterOutageSimulationApi GetOutageSimulation Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/outageSimulation Return One Outage Simulation
ClusterOutageSimulationApi StartOutageSimulation Post /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/outageSimulation Start an Outage Simulation
ClustersApi CheckStatusOfClusterSampleDatasetRequest Get /api/atlas/v1.0/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId} Check Status of Cluster Sample Dataset Request
ClustersApi CreateOneCluster Post /api/atlas/v1.0/groups/{groupId}/clusters Create One Cluster
ClustersApi LoadSampleDatasetRequestIntoCluster Post /api/atlas/v1.0/groups/{groupId}/sampleDatasetLoad/{name} Load Sample Dataset Request into Cluster
ClustersApi RemoveOneCluster Delete /api/atlas/v1.0/groups/{groupId}/clusters/{name} Remove One Cluster
ClustersApi ReturnAllAuthorizedClustersInAllProjects Get /api/atlas/v1.0/clusters Return All Authorized Clusters in All Projects
ClustersApi ReturnAllCloudProviderRegions Get /api/atlas/v1.0/groups/{groupId}/clusters/provider/regions Return All Cloud Provider Regions
ClustersApi ReturnAllClusters Get /api/atlas/v1.0/groups/{groupId}/clusters Return All Clusters in One Project
ClustersApi ReturnOneAdvancedConfigurationOptionsForOneCluster Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/processArgs Return One Advanced Configuration Options for One Cluster
ClustersApi ReturnOneCluster Get /api/atlas/v1.0/groups/{groupId}/clusters/{name} Return One Cluster in One Project
ClustersApi ReturnOneStatusOfAllClusterOperations Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/status Return Status of All Cluster Operations
ClustersApi TestFailoverForOneCluster Post /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/restartPrimaries Test Failover for One Cluster
ClustersApi UpdateAdvancedConfigurationOptionsForOneCluster Patch /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/processArgs Update Advanced Configuration Options for One Cluster
ClustersApi UpdateConfigurationOfOneCluster Patch /api/atlas/v1.0/groups/{groupId}/clusters/{name} Update Configuration of One Cluster
ClustersApi UpgradeOneTenantCluster Post /api/atlas/v1.0/groups/{groupId}/clusters/tenantUpgrade Upgrade One Shared-tier Cluster
CustomDNSForAtlasClustersDeployedToAWSApi ReturnOneCustomDnsConfigurationForAtlasClustersOnAws Get /api/atlas/v1.0/groups/{groupId}/awsCustomDNS Return One Custom DNS Configuration for Atlas Clusters on AWS
CustomDNSForAtlasClustersDeployedToAWSApi ToggleOneStateOfOneCustomDnsConfigurationForAtlasClustersOnAws Patch /api/atlas/v1.0/groups/{groupId}/awsCustomDNS Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS
CustomDatabaseRolesApi CreateOneCustomRole Post /api/atlas/v1.0/groups/{groupId}/customDBRoles/roles Create One Custom Role
CustomDatabaseRolesApi RemoveOneCustomRoleFromOneProject Delete /api/atlas/v1.0/groups/{groupId}/customDBRoles/roles/{roleName} Remove One Custom Role from One Project
CustomDatabaseRolesApi ReturnAllCustomRolesInOneProject Get /api/atlas/v1.0/groups/{groupId}/customDBRoles/roles Return All Custom Roles in One Project
CustomDatabaseRolesApi ReturnOneCustomRoleInOneProject Get /api/atlas/v1.0/groups/{groupId}/customDBRoles/roles/{roleName} Return One Custom Role in One Project
CustomDatabaseRolesApi UpdateOneCustomRoleInOneProject Patch /api/atlas/v1.0/groups/{groupId}/customDBRoles/roles/{roleName} Update One Custom Role in One Project
DataFederationApi CreateOneFederatedDatabaseInOneProject Post /api/atlas/v1.0/groups/{groupId}/dataFederation Create One Federated Database in One Project
DataFederationApi DownloadQueryLogsForOneFederatedDatabase Get /api/atlas/v1.0/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz Download Query Logs for One Federated Database
DataFederationApi RemoveOneFederatedDatabaseFromOneProject Delete /api/atlas/v1.0/groups/{groupId}/dataFederation/{tenantName} Remove One Federated Database from One Project
DataFederationApi ReturnAllFederatedDatabasesInOneProject Get /api/atlas/v1.0/groups/{groupId}/dataFederation Return All Federated Databases in One Project
DataFederationApi ReturnOneFederatedDatabaseInOneProject Get /api/atlas/v1.0/groups/{groupId}/dataFederation/{tenantName} Return One Federated Database in One Project
DataFederationApi UpdateOneFederatedDatabaseInOneProject Patch /api/atlas/v1.0/groups/{groupId}/dataFederation/{tenantName} Update One Federated Database in One Project
DataFederationPrivateNetworksApi CreateOneDataFederationPrivateEndpointForOneProject Post /api/atlas/v1.0/groups/{groupId}/privateNetworkSettings/endpointIds Create One Federated Database Instance and Online Archive Private Endpoint for One Project
DataFederationPrivateNetworksApi RemoveOneDataFederationPrivateEndpointFromOneProject Delete /api/atlas/v1.0/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId} Remove One Federated Database Instance and Online Archive Private Endpoint from One Project
DataFederationPrivateNetworksApi ReturnAllDataFederationPrivateEndpointsInOneProject Get /api/atlas/v1.0/groups/{groupId}/privateNetworkSettings/endpointIds Return All Federated Database Instance and Online Archive Private Endpoints in One Project
DataFederationPrivateNetworksApi ReturnOneDataFederationPrivateEndpointInOneProject Get /api/atlas/v1.0/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId} Return One Federated Database Instance and Online Archive Private Endpoint in One Project
DataLakePipelinesApi CreateOneDataLakePipeline Post /api/atlas/v1.0/groups/{groupId}/pipelines Create One Data Lake Pipeline
DataLakePipelinesApi DeletePipelineRunDataset Delete /api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId} Delete Pipeline Run Dataset
DataLakePipelinesApi PauseOnePipelineInOneProject Post /api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/pause Pause One Data Lake Pipeline
DataLakePipelinesApi RemoveOneDataLakePipeline Delete /api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName} Remove One Data Lake Pipeline
DataLakePipelinesApi ResumeOnePipelineInOneProject Post /api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/resume Resume One Data Lake Pipeline
DataLakePipelinesApi ReturnAllDataLakePipelineRunsFromOneProject Get /api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/runs Return All Data Lake Pipeline Runs from One Project
DataLakePipelinesApi ReturnAllDataLakePipelinesFromOneProject Get /api/atlas/v1.0/groups/{groupId}/pipelines Return All Data Lake Pipelines from One Project
DataLakePipelinesApi ReturnAvailableSchedulesForPipeline Get /api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/availableSchedules Return Available Ingestion Schedules for One Data Lake Pipeline
DataLakePipelinesApi ReturnAvailableSnapshotsForPipeline Get /api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots Return Available Backup Snapshots for One Data Lake Pipeline
DataLakePipelinesApi ReturnOnePipelineInOneProject Get /api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName} Return One Data Lake Pipeline
DataLakePipelinesApi ReturnOnePipelineRunInOneProject Get /api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId} Return One Data Lake Pipeline Run
DataLakePipelinesApi TriggerOneOnDemandSnapshotIngestion Post /api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/trigger Trigger on demand snapshot ingestion
DataLakePipelinesApi UpdateOneDataLakePipeline Patch /api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName} Update One Data Lake Pipeline
DatabaseUsersApi CreateOneDatabaseUserInOneProject Post /api/atlas/v1.0/groups/{groupId}/databaseUsers Create One Database User in One Project
DatabaseUsersApi RemoveOneDatabaseUserFromOneProject Delete /api/atlas/v1.0/groups/{groupId}/databaseUsers/{databaseName}/{username} Remove One Database User from One Project
DatabaseUsersApi ReturnAllDatabaseUsersFromOneProject Get /api/atlas/v1.0/groups/{groupId}/databaseUsers Return All Database Users from One Project
DatabaseUsersApi ReturnOneDatabaseUserFromOneProject Get /api/atlas/v1.0/groups/{groupId}/databaseUsers/{databaseName}/{username} Return One Database User from One Project
DatabaseUsersApi UpdateOneDatabaseUserInOneProject Patch /api/atlas/v1.0/groups/{groupId}/databaseUsers/{databaseName}/{username} Update One Database User in One Project
EncryptionAtRestUsingCustomerKeyManagementApi ReturnOneConfigurationForEncryptionAtRestUsingCustomerManagedKeysForOneProject Get /api/atlas/v1.0/groups/{groupId}/encryptionAtRest Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project
EncryptionAtRestUsingCustomerKeyManagementApi UpdateConfigurationForEncryptionAtRestUsingCustomerManagedKeysForOneProject Patch /api/atlas/v1.0/groups/{groupId}/encryptionAtRest Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project
EventsApi ReturnAllEventsFromOneOrganization Get /api/atlas/v1.0/orgs/{orgId}/events Return All Events from One Organization
EventsApi ReturnAllEventsFromOneProject Get /api/atlas/v1.0/groups/{groupId}/events Return All Events from One Project
EventsApi ReturnOneEventFromOneOrganization Get /api/atlas/v1.0/orgs/{orgId}/events/{eventId} Return One Event from One Organization
EventsApi ReturnOneEventFromOneProject Get /api/atlas/v1.0/groups/{groupId}/events/{eventId} Return One Event from One Project
FederatedAuthenticationApi AddRoleMapping Post /api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings Add One Role Mapping to One Organization
FederatedAuthenticationApi DeleteFederationApp Delete /api/atlas/v1.0/federationSettings/{federationSettingsId} Delete the federation settings instance.
FederatedAuthenticationApi DeleteRoleMapping Delete /api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id} Remove One Role Mapping from One Organization
FederatedAuthenticationApi GetAllConnectedOrgConfigs Get /api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs Return All Connected Org Configs from the Federation
FederatedAuthenticationApi GetAllIdentityProviders Get /api/atlas/v1.0/federationSettings/{federationSettingsId}/identityProviders Return all identity providers from the specified federation.
FederatedAuthenticationApi GetAllRoleMappings Get /api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings Return All Role Mappings from One Organization
FederatedAuthenticationApi GetConnectedOrgConfig Get /api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId} Return One Org Config Connected to One Federation
FederatedAuthenticationApi GetFederationSettings Get /api/atlas/v1.0/orgs/{orgId}/federationSettings Return Federation Settings for One Organization
FederatedAuthenticationApi GetIdentityProvider Get /api/atlas/v1.0/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} Return one identity provider from the specified federation.
FederatedAuthenticationApi GetIdentityProviderMetadata Get /api/atlas/v1.0/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml Return the metadata of one identity provider in the specified federation.
FederatedAuthenticationApi GetRoleMapping Get /api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id} Return One Role Mapping from One Organization
FederatedAuthenticationApi RemoveConnectedOrgConfig Delete /api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId} Remove One Org Config Connected to One Federation
FederatedAuthenticationApi UpdateConnectedOrgConfig Patch /api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId} Update one connected organization configuration in the specified federation.
FederatedAuthenticationApi UpdateIdentityProvider Patch /api/atlas/v1.0/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} Update the identity provider.
FederatedAuthenticationApi UpdateRoleMapping Put /api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id} Update One Role Mapping in One Organization
GlobalClustersApi AddOneCustomZoneMappingToOneGlobalCluster Post /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping Add Custom Zone Mappings to One Global Cluster
GlobalClustersApi CreateOneManagedNamespaceInOneGlobalCluster Post /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces Create One Managed Namespace in One Global Cluster
GlobalClustersApi DeleteAllCustomZoneMappings Delete /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping Remove All Custom Zone Mappings from One Global Multi-Cloud Cluster
GlobalClustersApi DeleteManagedNamespace Delete /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces Remove One Managed Namespace from One Global Multi-Cloud Cluster
GlobalClustersApi RemoveAllCustomZoneMappingsFromOneGlobalCluster Delete /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping Remove All Custom Zone Mappings from One Global Cluster
GlobalClustersApi RemoveOneManagedNamespaceFromOneGlobalCluster Delete /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces Remove One Managed Namespace from One Global Cluster
GlobalClustersApi ReturnAllGlobalClustersData Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/globalWrites Return All Global Clusters Data
InvoicesApi ReturnAllInvoicesForOneOrganization Get /api/atlas/v1.0/orgs/{orgId}/invoices Return All Invoices for One Organization
InvoicesApi ReturnAllPendingInvoicesForOneOrganization Get /api/atlas/v1.0/orgs/{orgId}/invoices/pending Return All Pending Invoices for One Organization
InvoicesApi ReturnOneOrganizationInvoice Get /api/atlas/v1.0/orgs/{orgId}/invoices/{invoiceId} Return One Organization Invoice
InvoicesApi ReturnOneOrganizationInvoiceAsCsv Get /api/atlas/v1.0/orgs/{orgId}/invoices/{invoiceId}/csv Return One Organization Invoice as CSV
LDAPConfigurationApi RemoveOneCurrentLdapUserToDnMapping Delete /api/atlas/v1.0/groups/{groupId}/userSecurity/ldap/userToDNMapping Remove the Current LDAP User to DN Mapping
LDAPConfigurationApi ReturnOneCurrentLdapConfiguration Get /api/atlas/v1.0/groups/{groupId}/userSecurity Return the Current LDAP or X.509 Configuration
LDAPConfigurationApi ReturnOneStatusOfOneVerifyLdapConfigurationRequest Get /api/atlas/v1.0/groups/{groupId}/userSecurity/ldap/verify/{requestId} Return the Status of One Verify LDAP Configuration Request
LDAPConfigurationApi SaveOneLdapConfiguration Patch /api/atlas/v1.0/groups/{groupId}/userSecurity Edit the LDAP or X.509 Configuration
LDAPConfigurationApi VerifyOneLdapConfigurationInOneProject Post /api/atlas/v1.0/groups/{groupId}/userSecurity/ldap/verify Verify the LDAP Configuration in One Project
LegacyBackupCheckpointsApi ReturnAllLegacyBackupCheckpoints Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backupCheckpoints Return All Legacy Backup Checkpoints
LegacyBackupCheckpointsApi ReturnOneLegacyBackupCheckpoint Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId} Return One Legacy Backup Checkpoint
LegacyBackupRestoreJobsApi CreateOneLegacyBackupRestoreJob Post /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/restoreJobs Create One Legacy Backup Restore Job
LegacyBackupRestoreJobsApi ReturnAllLegacyBackupRestoreJobs Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/restoreJobs Return All Legacy Backup Restore Jobs
LegacyBackupRestoreJobsApi ReturnOneLegacyBackupRestoreJob Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId} Return One Legacy Backup Restore Job
LegacyBackupSnapshotScheduleApi ReturnOneSnapshotSchedule Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/snapshotSchedule Return One Snapshot Schedule
LegacyBackupSnapshotScheduleApi UpdateSnapshotScheduleForOneCluster Patch /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/snapshotSchedule Update Snapshot Schedule for One Cluster
LegacyBackupSnapshotsApi ChangeOneLegacyBackupSnapshotExpiration Patch /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId} Change One Legacy Backup Snapshot Expiration
LegacyBackupSnapshotsApi RemoveOneLegacyBackupSnapshot Delete /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId} Remove One Legacy Backup Snapshot
LegacyBackupSnapshotsApi ReturnAllLegacyBackupSnapshots Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/snapshots Return All Legacy Backup Snapshots
LegacyBackupSnapshotsApi ReturnOneLegacyBackupSnapshot Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId} Return One Legacy Backup Snapshot
MaintenanceWindowsApi AutomateDeferralOfMaintenanceForOneProject Post /api/atlas/v1.0/groups/{groupId}/maintenanceWindow/autoDefer Toggle Automatic Deferral of Maintenance for One Project
MaintenanceWindowsApi DeferOneMaintenanceWindowForOneProject Post /api/atlas/v1.0/groups/{groupId}/maintenanceWindow/defer Defer One Maintenance Window for One Project
MaintenanceWindowsApi ResetOneMaintenanceWindowForOneProject Delete /api/atlas/v1.0/groups/{groupId}/maintenanceWindow Reset One Maintenance Window for One Project
MaintenanceWindowsApi ReturnOneMaintenanceWindowForOneProject Get /api/atlas/v1.0/groups/{groupId}/maintenanceWindow Return One Maintenance Window for One Project
MaintenanceWindowsApi UpdateMaintenanceWindowForOneProject Patch /api/atlas/v1.0/groups/{groupId}/maintenanceWindow Update Maintenance Window for One Project
MongoDBCloudUsersApi CreateOneCloudUser Post /api/atlas/v1.0/users Create One MongoDB Cloud User
MongoDBCloudUsersApi ReturnOneCloudUserUsingItsId Get /api/atlas/v1.0/users/{userId} Return One MongoDB Cloud User using Its ID
MongoDBCloudUsersApi ReturnOneCloudUserUsingItsUsername Get /api/atlas/v1.0/users/byName/{userName} Return One MongoDB Cloud User using Their Username
MonitoringAndLogsApi DownloadLogsForOneClusterHostInOneProject Get /api/atlas/v1.0/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz Download Logs for One Cluster Host in One Project
MonitoringAndLogsApi GetFTSIndexMeasurementsForNamespaceAndIndexName Get /api/atlas/v1.0/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements Return Atlas Search Metrics for One Index in One Specified Namespace
MonitoringAndLogsApi GetFTSMetricTypes Get /api/atlas/v1.0/groups/{groupId}/hosts/{processId}/fts/metrics Return All Atlas Search Metric Types for One Process
MonitoringAndLogsApi GetFTSNamespaceIndexMeasurements Get /api/atlas/v1.0/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements Return All Atlas Search Index Metrics for One Namespace
MonitoringAndLogsApi GetFTSNonIndexMeasurements Get /api/atlas/v1.0/groups/{groupId}/hosts/{processId}/fts/metrics/measurements Return Atlas Search Hardware and Status Metrics
MonitoringAndLogsApi GetHostLogs Get /api/atlas/v1.5/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz Download Logs for One Multi-Cloud Cluster Host in One Project
MonitoringAndLogsApi ReturnAllMongodbProcessesInOneProject Get /api/atlas/v1.0/groups/{groupId}/processes Return All MongoDB Processes in One Project
MonitoringAndLogsApi ReturnAvailableDatabasesForOneMongodbProcess Get /api/atlas/v1.0/groups/{groupId}/processes/{processId}/databases Return Available Databases for One MongoDB Process
MonitoringAndLogsApi ReturnAvailableDisksForOneMongodbProcess Get /api/atlas/v1.0/groups/{groupId}/processes/{processId}/disks Return Available Disks for One MongoDB Process
MonitoringAndLogsApi ReturnDatabasesForOneMongodbProcess Get /api/atlas/v1.0/groups/{groupId}/processes/{processId}/databases/{databaseName} Return One Database for a MongoDB Process
MonitoringAndLogsApi ReturnMeasurementsForOneMongodbProcess Get /api/atlas/v1.0/groups/{groupId}/processes/{processId}/measurements Return Measurements for One MongoDB Process
MonitoringAndLogsApi ReturnMeasurementsOfOneDatabaseForOneMongodbProcess Get /api/atlas/v1.0/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements Return Measurements of One Database for One MongoDB Process
MonitoringAndLogsApi ReturnMeasurementsOfOneDisk Get /api/atlas/v1.0/groups/{groupId}/processes/{processId}/disks/{partitionName} Return Measurements of One Disk
MonitoringAndLogsApi ReturnMeasurementsOfOneDiskForOneMongodbProcess Get /api/atlas/v1.0/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements Return Measurements of One Disk for One MongoDB Process
MonitoringAndLogsApi ReturnOneMongodbProcessById Get /api/atlas/v1.0/groups/{groupId}/processes/{processId} Return One MongoDB Process by ID
MultiCloudClustersApi CreateCluster Post /api/atlas/v1.5/groups/{groupId}/clusters Create One Multi-Cloud Cluster from One Project
MultiCloudClustersApi DeleteCluster Delete /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} Remove One Multi-Cloud Cluster from One Project
MultiCloudClustersApi GetCluster Get /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} Return One Multi-Cloud Cluster from One Project
MultiCloudClustersApi ListClusters Get /api/atlas/v1.5/groups/{groupId}/clusters Return All Multi-Cloud Clusters from One Project
MultiCloudClustersApi TestFailover Post /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName}/restartPrimaries Test Failover for One Multi-Cloud Cluster
MultiCloudClustersApi UpdateCluster Patch /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} Modify One Multi-Cloud Cluster from One Project
NetworkPeeringApi DisableConnectViaPeeringOnlyModeForOneProject Patch /api/atlas/v1.0/groups/{groupId}/privateIpMode Disable Connect via Peering Only Mode for One Project
NetworkPeeringApi VerifyConnectViaPeeringOnlyModeForOneProject Get /api/atlas/v1.0/groups/{groupId}/privateIpMode Verify Connect via Peering Only Mode for One Project
NetworkPeeringConnectionsApi CreateOneNewNetworkPeeringConnection Post /api/atlas/v1.0/groups/{groupId}/peers Create One New Network Peering Connection
NetworkPeeringConnectionsApi RemoveOneExistingNetworkPeeringConnection Delete /api/atlas/v1.0/groups/{groupId}/peers/{peerId} Remove One Existing Network Peering Connection
NetworkPeeringConnectionsApi ReturnAllNetworkPeeringConnectionsInOneProject Get /api/atlas/v1.0/groups/{groupId}/peers Return All Network Peering Connections in One Project
NetworkPeeringConnectionsApi ReturnOneNetworkPeeringConnectionInOneProject Get /api/atlas/v1.0/groups/{groupId}/peers/{peerId} Return One Network Peering Connection in One Project
NetworkPeeringConnectionsApi UpdateOneNewNetworkPeeringConnection Patch /api/atlas/v1.0/groups/{groupId}/peers/{peerId} Update One New Network Peering Connection
NetworkPeeringContainersApi CreateOneNewNetworkPeeringContainer Post /api/atlas/v1.0/groups/{groupId}/containers Create One New Network Peering Container
NetworkPeeringContainersApi RemoveOneNetworkPeeringContainer Delete /api/atlas/v1.0/groups/{groupId}/containers/{containerId} Remove One Network Peering Container
NetworkPeeringContainersApi ReturnAllNetworkPeeringContainersInOneProject Get /api/atlas/v1.0/groups/{groupId}/containers/all Return All Network Peering Containers in One Project
NetworkPeeringContainersApi ReturnAllNetworkPeeringContainersInOneProjectForOneCloudProvider Get /api/atlas/v1.0/groups/{groupId}/containers Return All Network Peering Containers in One Project for One Cloud Provider
NetworkPeeringContainersApi ReturnOneNetworkPeeringContainer Get /api/atlas/v1.0/groups/{groupId}/containers/{containerId} Return One Network Peering Container
NetworkPeeringContainersApi UpdateOneNetworkPeeringContainer Patch /api/atlas/v1.0/groups/{groupId}/containers/{containerId} Update One Network Peering Container
OnlineArchiveApi CreateOneOnlineArchive Post /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/onlineArchives Create One Online Archive
OnlineArchiveApi DownloadOnlineArchiveQueryLogs Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz Download Online Archive Query Logs
OnlineArchiveApi RemoveOneOnlineArchive Delete /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId} Remove One Online Archive
OnlineArchiveApi ReturnAllOnlineArchivesForOneCluster Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/onlineArchives Return All Online Archives for One Cluster
OnlineArchiveApi ReturnOneOnlineArchive Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId} Return One Online Archive
OnlineArchiveApi UpdateOneOnlineArchive Patch /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId} Update One Online Archive
OrganizationsApi CancelOneOrganizationInvitation Delete /api/atlas/v1.0/orgs/{orgId}/invites/{invitationId} Cancel One Organization Invitation
OrganizationsApi InviteOneMongoDBUserToJoinOneAtlasOrganization Post /api/atlas/v1.0/orgs/{orgId}/invites Invite One MongoDB Cloud User to Join One Atlas Organization
OrganizationsApi RemoveOneOrganization Delete /api/atlas/v1.0/orgs/{orgId} Remove One Organization
OrganizationsApi RenameOneOrganization Patch /api/atlas/v1.0/orgs/{orgId} Rename One Organization
OrganizationsApi ReturnAllOrganizationAtlasUsers Get /api/atlas/v1.0/orgs/{orgId}/users Return All MongoDB Cloud Users in One Organization
OrganizationsApi ReturnAllOrganizationInvitations Get /api/atlas/v1.0/orgs/{orgId}/invites Return All Organization Invitations
OrganizationsApi ReturnAllOrganizations Get /api/atlas/v1.0/orgs Return All Organizations
OrganizationsApi ReturnOneOrMoreProjectsInOneOrganization Get /api/atlas/v1.0/orgs/{orgId}/groups Return One or More Projects in One Organization
OrganizationsApi ReturnOneOrganization Get /api/atlas/v1.0/orgs/{orgId} Return One Organization
OrganizationsApi ReturnOneOrganizationInvitation Get /api/atlas/v1.0/orgs/{orgId}/invites/{invitationId} Return One Organization Invitation
OrganizationsApi UpdateOneOrganizationInvitation Patch /api/atlas/v1.0/orgs/{orgId}/invites Update One Organization Invitation
OrganizationsApi UpdateOneOrganizationInvitationByInvitationId Patch /api/atlas/v1.0/orgs/{orgId}/invites/{invitationId} Update One Organization Invitation by Invitation ID
PerformanceAdvisorApi DisableManagedSlowOperationThreshold Delete /api/atlas/v1.0/groups/{groupId}/managedSlowMs/disable Disable Managed Slow Operation Threshold
PerformanceAdvisorApi EnableManagedSlowOperationThreshold Post /api/atlas/v1.0/groups/{groupId}/managedSlowMs/enable Enable Managed Slow Operation Threshold
PerformanceAdvisorApi ReturnAllNamespacesForOneHost Get /api/public/v1.0/groups/{groupId}/hosts/{hostId}/performanceAdvisor/namespaces Return All Namespaces for One Host
PerformanceAdvisorApi ReturnAllNamespacesForOneHost1 Get /api/atlas/v1.0/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces Return All Namespaces for One Host
PerformanceAdvisorApi ReturnSlowQueries Get /api/public/v1.0/groups/{groupId}/hosts/{hostId}/performanceAdvisor/slowQueryLogs Return Slow Queries
PerformanceAdvisorApi ReturnSlowQueries1 Get /api/atlas/v1.0/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs Return Slow Queries
PerformanceAdvisorApi ReturnSuggestedIndexes Get /api/public/v1.0/groups/{groupId}/hosts/{hostId}/performanceAdvisor/suggestedIndexes Return Suggested Indexes
PerformanceAdvisorApi ReturnSuggestedIndexes1 Get /api/atlas/v1.0/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes Return Suggested Indexes
PrivateEndpointServicesApi CreateOnePrivateEndpointForOneProvider Post /api/atlas/v1.0/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint Create One Private Endpoint for One Provider
PrivateEndpointServicesApi CreateOnePrivateEndpointServiceForOneProvider Post /api/atlas/v1.0/groups/{groupId}/privateEndpoint/endpointService Create One Private Endpoint Service for One Provider
PrivateEndpointServicesApi RemoveOnePrivateEndpointForOneProvider Delete /api/atlas/v1.0/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId} Remove One Private Endpoint for One Provider
PrivateEndpointServicesApi RemoveOnePrivateEndpointServiceForOneProvider Delete /api/atlas/v1.0/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId} Remove One Private Endpoint Service for One Provider
PrivateEndpointServicesApi ReturnAllPrivateEndpointServicesForOneProvider Get /api/atlas/v1.0/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService Return All Private Endpoint Services for One Provider
PrivateEndpointServicesApi ReturnOnePrivateEndpointForOneProvider Get /api/atlas/v1.0/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId} Return One Private Endpoint for One Provider
PrivateEndpointServicesApi ReturnOnePrivateEndpointServiceForOneProvider Get /api/atlas/v1.0/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId} Return One Private Endpoint Service for One Provider
PrivateEndpointServicesApi ReturnRegionalizedPrivateEndpointStatus Get /api/atlas/v1.0/groups/{groupId}/privateEndpoint/regionalMode Return Regionalized Private Endpoint Status
PrivateEndpointServicesApi ToggleRegionalizedPrivateEndpointStatus Patch /api/atlas/v1.0/groups/{groupId}/privateEndpoint/regionalMode Toggle Regionalized Private Endpoint Status
ProgrammaticAPIKeysApi AssignOneOrganizationApiKeyToOneProject Post /api/atlas/v1.0/groups/{groupId}/apiKeys/{apiUserId} Assign One Organization API Key to One Project
ProgrammaticAPIKeysApi CreateAccessListEntriesForOneOrganizationApiKey Post /api/atlas/v1.0/orgs/{orgId}/apiKeys/{apiUserId}/accessList Create Access List Entries for One Organization API Key
ProgrammaticAPIKeysApi CreateAndAssignOneOrganizationApiKeyToOneProject Post /api/atlas/v1.0/groups/{groupId}/apiKeys Create and Assign One Organization API Key to One Project
ProgrammaticAPIKeysApi CreateOneOrganizationApiKey Post /api/atlas/v1.0/orgs/{orgId}/apiKeys Create One Organization API Key
ProgrammaticAPIKeysApi RemoveOneAccessListEntryForOneOrganizationApiKey Delete /api/atlas/v1.0/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress} Remove One Access List Entry for One Organization API Key
ProgrammaticAPIKeysApi RemoveOneOrganizationApiKey Delete /api/atlas/v1.0/orgs/{orgId}/apiKeys/{apiUserId} Remove One Organization API Key
ProgrammaticAPIKeysApi ReturnAllAccessListEntriesForOneOrganizationApiKey Get /api/atlas/v1.0/orgs/{orgId}/apiKeys/{apiUserId}/accessList Return All Access List Entries for One Organization API Key
ProgrammaticAPIKeysApi ReturnAllOrganizationApiKeys Get /api/atlas/v1.0/orgs/{orgId}/apiKeys Return All Organization API Keys
ProgrammaticAPIKeysApi ReturnAllOrganizationApiKeysAssignedToOneProject Get /api/atlas/v1.0/groups/{groupId}/apiKeys Return All Organization API Keys Assigned to One Project
ProgrammaticAPIKeysApi ReturnOneAccessListEntryForOneOrganizationApiKey Get /api/atlas/v1.0/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress} Return One Access List Entry for One Organization API Key
ProgrammaticAPIKeysApi ReturnOneOrganizationApiKey Get /api/atlas/v1.0/orgs/{orgId}/apiKeys/{apiUserId} Return One Organization API Key
ProgrammaticAPIKeysApi SetApiUserGroupRoles Patch /api/atlas/v1.0/groups/{groupId}/apiKeys/{apiUserId} Update Roles of One Organization API Key to One Project
ProgrammaticAPIKeysApi UnassignOneOrganizationApiKeyFromOneProject Delete /api/atlas/v1.0/groups/{groupId}/apiKeys/{apiUserId} Unassign One Organization API Key from One Project
ProgrammaticAPIKeysApi UpdateOneOrganizationApiKey Patch /api/atlas/v1.0/orgs/{orgId}/apiKeys/{apiUserId} Update One Organization API Key
ProjectIPAccessListApi AddEntriesToProjectIpAccessList Post /api/atlas/v1.0/groups/{groupId}/accessList Add Entries to Project IP Access List
ProjectIPAccessListApi GetAtlasNetworkPermissionEntryStatus Get /api/atlas/v1.0/groups/{groupId}/accessList/{entryValue}/status Return Status of One Project IP Access List Entry
ProjectIPAccessListApi RemoveOneEntryFromOneProjectIpAccessList Delete /api/atlas/v1.0/groups/{groupId}/accessList/{entryValue} Remove One Entry from One Project IP Access List
ProjectIPAccessListApi ReturnOneProjectIpAccessListEntry Get /api/atlas/v1.0/groups/{groupId}/accessList/{entryValue} Return One Project IP Access List Entry
ProjectIPAccessListApi ReturnProjectIpAccessList Get /api/atlas/v1.0/groups/{groupId}/accessList Return Project IP Access List
ProjectsApi CancelOneProjectInvitation Delete /api/atlas/v1.0/groups/{groupId}/invites/{invitationId} Cancel One Project Invitation
ProjectsApi CreateOneProject Post /api/atlas/v1.0/groups Create One Project
ProjectsApi GetGroupSettings Get /api/atlas/v1.0/groups/{groupId}/settings Return One Project Settings
ProjectsApi InviteOneMongoDBCloudUserToJoinOneProject Post /api/atlas/v1.0/groups/{groupId}/invites Invite One MongoDB Cloud User to Join One Project
ProjectsApi PatchGroupSettings Patch /api/atlas/v1.0/groups/{groupId}/settings Update One Project Settings
ProjectsApi RemoveOneProject Delete /api/atlas/v1.0/groups/{groupId} Remove One Project
ProjectsApi RemoveOneUserFromOneProject Delete /api/atlas/v1.0/groups/{groupId}/users/{userId} Remove One User from One Project
ProjectsApi ReturnAllProjectInvitations Get /api/atlas/v1.0/groups/{groupId}/invites Return All Project Invitations
ProjectsApi ReturnAllProjects Get /api/atlas/v1.0/groups Return All Projects
ProjectsApi ReturnAllUsersInOneProject Get /api/atlas/v1.0/groups/{groupId}/users Return All Users in One Project
ProjectsApi ReturnOneProject Get /api/atlas/v1.0/groups/{groupId} Return One Project
ProjectsApi ReturnOneProjectInvitation Get /api/atlas/v1.0/groups/{groupId}/invites/{invitationId} Return One Project Invitation
ProjectsApi ReturnOneProjectUsingItsName Get /api/atlas/v1.0/groups/byName/{groupName} Return One Project using Its Name
ProjectsApi UpdateOneProjectInvitation Patch /api/atlas/v1.0/groups/{groupId}/invites Update One Project Invitation
ProjectsApi UpdateOneProjectInvitationByInvitationId Patch /api/atlas/v1.0/groups/{groupId}/invites/{invitationId} Update One Project Invitation by Invitation ID
RollingIndexApi CreateOneRollingIndex Post /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/index Create One Rolling Index
RootApi GetSystemStatus Get /api/atlas/v1.0 Return the status of this MongoDB application
ServerlessInstancesApi CreateOneServerlessInstanceInOneProject Post /api/atlas/v1.0/groups/{groupId}/serverless Create One Serverless Instance in One Project
ServerlessInstancesApi RemoveOneServerlessInstanceFromOneProject Delete /api/atlas/v1.0/groups/{groupId}/serverless/{name} Remove One Serverless Instance from One Project
ServerlessInstancesApi ReturnAllServerlessInstancesFromOneProject Get /api/atlas/v1.0/groups/{groupId}/serverless Return All Serverless Instances from One Project
ServerlessInstancesApi ReturnOneServerlessInstanceFromOneProject Get /api/atlas/v1.0/groups/{groupId}/serverless/{name} Return One Serverless Instance from One Project
ServerlessInstancesApi UpdateOneServerlessInstanceInOneProject Patch /api/atlas/v1.0/groups/{groupId}/serverless/{name} Update One Serverless Instance in One Project
ServerlessPrivateEndpointsApi CreateOnePrivateEndpointForOneServerlessInstance Post /api/atlas/v1.0/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint Create One Private Endpoint for One Serverless Instance
ServerlessPrivateEndpointsApi RemoveOnePrivateEndpointFromOneServerlessInstance Delete /api/atlas/v1.0/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId} Remove One Private Endpoint for One Serverless Instance
ServerlessPrivateEndpointsApi ReturnAllPrivateEndpointsForOneServerlessInstance Get /api/atlas/v1.0/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint Return All Private Endpoints for One Serverless Instance
ServerlessPrivateEndpointsApi ReturnOnePrivateEndpointForOneServerlessInstance Get /api/atlas/v1.0/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId} Return One Private Endpoint for One Serverless Instance
ServerlessPrivateEndpointsApi UpdateOnePrivateEndpointForOneServerlessInstance Patch /api/atlas/v1.0/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId} Update One Private Endpoint for One Serverless Instance
SharedTierRestoreJobsApi CreateOneRestoreJobFromOneM2OrM5Cluster Post /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore Create One Restore Job from One M2 or M5 Cluster
SharedTierRestoreJobsApi ReturnAllRestoreJobsForOneM2OrM5Cluster Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores Return All Restore Jobs for One M2 or M5 Cluster
SharedTierRestoreJobsApi ReturnOneRestoreJobForOneM2OrM5Cluster Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId} Return One Restore Job for One M2 or M5 Cluster
SharedTierSnapshotsApi DownloadOneM2OrM5ClusterSnapshot Post /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/tenant/download Download One M2 or M5 Cluster Snapshot
SharedTierSnapshotsApi ReturnAllSnapshotsForOneM2OrM5Cluster Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots Return All Snapshots for One M2 or M5 Cluster
SharedTierSnapshotsApi ReturnOneSnapshotForOneM2OrM5Cluster Get /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId} Return One Snapshot for One M2 or M5 Cluster
TeamsApi AddOneOrMoreTeamsToOneProject Post /api/atlas/v1.0/groups/{groupId}/teams Add One or More Teams to One Project
TeamsApi AssignOneOrganizationUserToOneTeam Post /api/atlas/v1.0/orgs/{orgId}/teams/{teamId}/users Assign MongoDB Cloud Users from One Organization to One Team
TeamsApi CreateOneTeamInOneOrganization Post /api/atlas/v1.0/orgs/{orgId}/teams Create One Team in One Organization
TeamsApi RemoveOneMongoDBCloudUserFromOneTeam Delete /api/atlas/v1.0/orgs/{orgId}/teams/{teamId}/users/{userId} Remove One MongoDB Cloud User from One Team
TeamsApi RemoveOneTeamFromOneOrganization Delete /api/atlas/v1.0/orgs/{orgId}/teams/{teamId} Remove One Team from One Organization
TeamsApi RemoveOneTeamFromOneProject Delete /api/atlas/v1.0/groups/{groupId}/teams/{teamId} Remove One Team from One Project
TeamsApi RenameOneTeam Patch /api/atlas/v1.0/orgs/{orgId}/teams/{teamId} Rename One Team
TeamsApi ReturnAllMongoDBCloudUsersAssignedToOneTeam Get /api/atlas/v1.0/orgs/{orgId}/teams/{teamId}/users Return All MongoDB Cloud Users Assigned to One Team
TeamsApi ReturnAllTeams Get /api/atlas/v1.0/groups/{groupId}/teams Return All Teams in One Project
TeamsApi ReturnAllTeamsInOneOrganization Get /api/atlas/v1.0/orgs/{orgId}/teams Return All Teams in One Organization
TeamsApi ReturnOneTeamUsingItsId Get /api/atlas/v1.0/orgs/{orgId}/teams/{teamId} Return One Team using its ID
TeamsApi ReturnOneTeamUsingItsName Get /api/atlas/v1.0/orgs/{orgId}/teams/byName/{teamName} Return One Team using its Name
TeamsApi UpdateTeamRolesInOneProject Patch /api/atlas/v1.0/groups/{groupId}/teams/{teamId} Update Team Roles in One Project
ThirdPartyServiceIntegrationsApi ConfigureOneThirdPartyServiceIntegration Post /api/atlas/v1.0/groups/{groupId}/integrations/{integrationType} Configure One Third-Party Service Integration
ThirdPartyServiceIntegrationsApi RemoveOneThirdPartyServiceIntegration Delete /api/atlas/v1.0/groups/{groupId}/integrations/{integrationType} Remove One Third-Party Service Integration
ThirdPartyServiceIntegrationsApi ReturnAllActiveThirdPartyServiceIntegrations Get /api/atlas/v1.0/groups/{groupId}/integrations Return All Active Third-Party Service Integrations
ThirdPartyServiceIntegrationsApi ReturnOneThirdPartyServiceIntegration Get /api/atlas/v1.0/groups/{groupId}/integrations/{integrationType} Return One Third-Party Service Integration
ThirdPartyServiceIntegrationsApi UpdateOneThirdPartyServiceIntegration Put /api/atlas/v1.0/groups/{groupId}/integrations/{integrationType} Update One Third-Party Service Integration
X509AuthenticationForDatabaseUsersApi CreateOneX509CertificateForOneMongodbUser Post /api/atlas/v1.0/groups/{groupId}/databaseUsers/{username}/certs Create One X.509 Certificate for One MongoDB User
X509AuthenticationForDatabaseUsersApi DisableCustomerManagedX509 Delete /api/atlas/v1.0/groups/{groupId}/userSecurity/customerX509 Disable Customer-Managed X.509
X509AuthenticationForDatabaseUsersApi ReturnAllX509CertificatesAssignedToOneMongodbUser Get /api/atlas/v1.0/groups/{groupId}/databaseUsers/{username}/certs Return All X.509 Certificates Assigned to One MongoDB User

Documentation For Models

Documentation For Authorization

DigestAuth

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author