Skip to main content
The Atlas Admin node adds Atlas Admin operations to your workflows. Add it on the canvas or ask the AI builder for it by name, then pick an operation and fill in its fields. Atlas Admin also includes 6 trigger operations (marked in the tables below) that can start a workflow when something happens in Atlas Admin.
You can wire the Atlas Admin node into an AI agent as a tool provider: the agent calls the operations you allow. See Agent tools.

​
Credentials

Connect Atlas Admin under Credentials in the node settings. See Connecting credentials for the general flow. Enter the values manually when creating the credential. Go to Atlas → Access Manager → Service Accounts, create a new service account, assign it the required org/project roles, then copy the Client ID and the Client Secret shown at creation time. Get your credentials here.

​
Operations

​
Atlas streams

OperationIDDescriptionTrigger
Create Stream Connectioncreate_stream_connectionCreate a new connection for an Atlas Stream Processing instance.
Create Stream Instancecreate_stream_instanceCreate a new Atlas Stream Processing instance.
Create Stream Processorcreate_stream_processorCreate a new stream processor.
Delete Stream Connectiondelete_stream_connectionDelete a stream connection.
Delete Stream Instancedelete_stream_instanceDelete an Atlas Stream Processing instance.
Delete Stream Processordelete_stream_processorDelete a stream processor.
Download Stream Audit Logsdownload_stream_audit_logsDownload audit logs for an Atlas Stream Processing instance.
Get Stream Connectionget_stream_connectionGet a single stream connection by name.
Get Stream Instanceget_stream_instanceGet a single Atlas Stream Processing instance by name.
Get Stream Processorget_stream_processorGet a single stream processor by name.
List Stream Connectionslist_stream_connectionsList all connections for an Atlas Stream Processing instance.
List Stream Instanceslist_stream_instancesList all Atlas Stream Processing instances in a project.
List Stream Processorslist_stream_processorsList all processors for an Atlas Stream Processing instance.
Start Stream Processorstart_stream_processorStart a stopped stream processor.
Stop Stream Processorstop_stream_processorStop a running stream processor.
Update Stream Connectionupdate_stream_connectionUpdate an existing stream connection.
Update Stream Instanceupdate_stream_instanceUpdate an existing Atlas Stream Processing instance.

​
Cloud backups

OperationIDDescriptionTrigger
Cancel Restore Jobcancel_restore_jobCancel an in-progress cloud backup restore job.
Create Export Jobcreate_export_jobCreate a cloud backup snapshot export job to an S3 bucket.
Create Restore Jobcreate_restore_jobCreate a cloud backup restore job.
Delete Snapshotdelete_snapshotDelete a cloud backup snapshot.
Get Backup Scheduleget_backup_scheduleGet the cloud backup schedule for a cluster.
Get Restore Jobget_restore_jobGet a single cloud backup restore job.
Get Snapshotget_snapshotGet a single cloud backup snapshot.
List Export Bucketslist_export_bucketsList export buckets associated with a project.
List Restore Jobslist_restore_jobsList cloud backup restore jobs for a cluster.
List Snapshotslist_snapshotsList cloud backup snapshots for a cluster.
Take On-Demand Snapshottake_snapshotTake an on-demand cloud backup snapshot.
Update Backup Scheduleupdate_backup_scheduleUpdate the cloud backup schedule for a cluster.

​
Clusters

OperationIDDescriptionTrigger
Create Clustercreate_clusterCreate a new dedicated cluster.
Delete Clusterdelete_clusterDelete a cluster (irreversible).
Get Clusterget_clusterGet a single cluster by name.
Get Cluster Advanced Configurationget_cluster_advanced_configGet the advanced configuration options for a cluster.
List Clusterslist_clustersList all clusters in a project.
Pause Clusterpause_clusterPause a running cluster (stops billing for compute).
Resume Clusterresume_clusterResume a paused cluster.
Test Failovertest_failoverTrigger a test failover for a replica-set cluster.
Update Clusterupdate_clusterUpdate an existing cluster’s configuration.
Update Cluster Advanced Configurationupdate_cluster_advanced_configUpdate advanced configuration options for a cluster.

​
Data federation

OperationIDDescriptionTrigger
Create Federated Database Instancecreate_data_federationCreate a new federated database instance.
Delete Data Federation Query Limitdelete_data_federation_query_limitDelete a query limit from a federated database instance.
Delete Federated Database Instancedelete_data_federationDelete a federated database instance.
Get Federated Database Instanceget_data_federationGet a single federated database instance by name.
List Data Federation Query Limitslist_data_federation_query_limitsList all query limits for a federated database instance.
List Federated Database Instanceslist_data_federationList all federated database instances in a project.
Set Data Federation Query Limitcreate_data_federation_query_limitCreate or update a query limit for a federated database instance.
Update Federated Database Instanceupdate_data_federationUpdate an existing federated database instance.

​
Flex clusters

OperationIDDescriptionTrigger
Create Flex Clustercreate_flex_clusterCreate a new flex cluster.
Delete Flex Clusterdelete_flex_clusterDelete a flex cluster (irreversible).
Get Flex Clusterget_flex_clusterGet a single flex cluster by name.
List Flex Clusterslist_flex_clustersList all flex clusters in a project.
Update Flex Clusterupdate_flex_clusterUpdate a flex cluster’s configuration.

​
Online archive

OperationIDDescriptionTrigger
Create Online Archivecreate_online_archiveCreate an online archive rule for a collection.
Delete Online Archivedelete_online_archiveDelete an online archive rule.
Get Online Archiveget_online_archiveGet a single online archive by ID.
List Online Archiveslist_online_archivesList all online archives for a cluster.
Update Online Archiveupdate_online_archiveUpdate an existing online archive’s expiry setting.

​
Search indexes

OperationIDDescriptionTrigger
Create Search Deploymentcreate_search_deploymentCreate a dedicated Atlas Search deployment for a cluster.
Create Search Indexcreate_search_indexCreate a new Atlas Search or Vector Search index.
Delete Search Deploymentdelete_search_deploymentDelete the dedicated Atlas Search deployment for a cluster.
Delete Search Indexdelete_search_indexDelete an Atlas Search index by ID.
Get Search Deploymentget_search_deploymentGet the Atlas Search deployment configuration for a cluster.
Get Search Indexget_search_indexGet a single Atlas Search index by ID.
Get Search Index by Namelist_search_index_by_nameGet an Atlas Search index by collection and index name.
List Search Analyzerslist_search_analyzersList all custom Atlas Search analyzers for a cluster.
List Search Indexeslist_search_indexesList all Atlas Search indexes for a collection.
Update Search Deploymentupdate_search_deploymentUpdate the dedicated Atlas Search deployment for a cluster.
Update Search Indexupdate_search_indexUpdate an existing Atlas Search index.

​
Serverless instances

OperationIDDescriptionTrigger
Create Serverless Instancecreate_serverlessCreate a new serverless instance.
Delete Serverless Instancedelete_serverlessDelete a serverless instance (irreversible).
Get Serverless Instanceget_serverlessGet a single serverless instance by name.
List Serverless Instanceslist_serverlessList all serverless instances in a project.
Update Serverless Instanceupdate_serverlessUpdate a serverless instance.

​
Triggers

OperationIDDescriptionTrigger
On Alerton_alertWebhook push trigger: fires whenever Atlas sends an alert to the registered webhook.Yes
On Alert Eventon_alert_eventPoll trigger: fires when Atlas alerts are opened, closed, or acknowledged.Yes
On Backup Eventon_backup_eventPoll trigger: fires on backup and snapshot events.Yes
On Cluster Eventon_cluster_eventPoll trigger: fires on cluster lifecycle events (create, delete, pause, ready).Yes
On Database User Eventon_user_eventPoll trigger: fires when database users are created, updated, or deleted.Yes
On Maintenance Eventon_maintenance_eventPoll trigger: fires when Atlas starts or ends a maintenance window.Yes

​
Other

OperationIDDescriptionTrigger
Operationacknowledge_alert
Operationadd_access_list
Operationadd_api_key_access_list
Operationadd_custom_zone_mapping
Operationadd_managed_namespace
Operationadd_project_service_account
Operationadd_project_user
Operationadd_team_users
Operationadd_teams_to_project
Operationassign_api_key_to_project
Operationauthorize_cloud_provider_access
Operationauto_defer_maintenance_window
Operationcreate_alert_config
Operationcreate_atlas_user
Operationcreate_cloud_provider_access
Operationcreate_custom_role
Operationcreate_db_user
Operationcreate_db_user_cert
Operationcreate_identity_provider
Operationcreate_integration
Operationcreate_log_export
Operationcreate_org_api_key
Operationcreate_org_service_account
Operationcreate_org_team
Operationcreate_peering_connection
Operationcreate_peering_container
Operationcreate_private_endpoint
Operationcreate_private_endpoint_service
Operationcreate_project
Operationcreate_project_api_key
Operationcreate_resource_policy
Operationcreate_role_mapping
Operationcreate_service_account_secret
Operationdeauthorize_cloud_provider_access
Operationdefer_maintenance_window
Operationdelete_access_list_entry
Operationdelete_alert_config
Operationdelete_api_key_access_list_entry
Operationdelete_custom_role
Operationdelete_custom_zone_mapping
Operationdelete_db_user
Operationdelete_identity_provider
Operationdelete_integration
Operationdelete_log_export
Operationdelete_managed_namespace
Operationdelete_org
Operationdelete_org_api_key
Operationdelete_org_invitation
Operationdelete_org_service_account
Operationdelete_org_team
Operationdelete_peering_connection
Operationdelete_peering_container
Operationdelete_private_endpoint
Operationdelete_private_endpoint_service
Operationdelete_project
Operationdelete_project_invitation
Operationdelete_resource_policy
Operationdelete_role_mapping
Operationdelete_service_account_secret
Operationdisable_managed_slow_ms
Operationdisable_x509_config
Operationdownload_cluster_log
Operationenable_managed_slow_ms
Operationget_access_list_entry
Operationget_alert
Operationget_alert_config
Operationget_alert_config_matchers
Operationget_api_key_access_list
Operationget_atlas_user
Operationget_atlas_user_by_name
Operationget_auditing
Operationget_custom_role
Operationget_custom_zone_mapping
Operationget_database_measurements
Operationget_db_access_history
Operationget_db_user
Operationget_disk_measurements
Operationget_encryption_at_rest
Operationget_encryption_at_rest_private_endpoint
Operationget_federation_settings
Operationget_identity_provider
Operationget_integration
Operationget_invoice
Operationget_ldap_config
Operationget_log_export
Operationget_maintenance_window
Operationget_managed_namespaces
Operationget_managed_slow_ms
Operationget_org
Operationget_org_api_key
Operationget_org_auditing
Operationget_org_event
Operationget_org_service_account
Operationget_org_settings
Operationget_org_team
Operationget_peering_connection
Operationget_peering_container
Operationget_pending_invoices
Operationget_private_endpoint
Operationget_private_endpoint_service
Operationget_process
Operationget_process_measurements
Operationget_project
Operationget_project_api_key_detail
Operationget_project_by_name
Operationget_project_cluster_count
Operationget_project_event
Operationget_project_settings
Operationget_regionalized_private_endpoint
Operationget_resource_policy
Operationget_schema_advice
Operationget_team_by_name
Operationget_x509_config
Operationinvite_to_org
Operationinvite_to_project
Operationlist_access_list
Operationlist_alert_configs
Operationlist_alerts
Operationlist_alerts_for_config
Operationlist_cloud_provider_access
Operationlist_connected_org_configs
Operationlist_custom_roles
Operationlist_db_user_certs
Operationlist_db_users
Operationlist_identity_providers
Operationlist_integrations
Operationlist_invoices
Operationlist_noncompliant_resources
Operationlist_org_api_keys
Operationlist_org_events
Operationlist_org_invitations
Operationlist_org_service_accounts
Operationlist_org_teams
Operationlist_org_users
Operationlist_orgs
Operationlist_peering_connections
Operationlist_peering_containers
Operationlist_performance_namespaces
Operationlist_private_endpoint_services
Operationlist_private_endpoints
Operationlist_process_disks
Operationlist_processes
Operationlist_processes_databases
Operationlist_project_api_keys
Operationlist_project_events
Operationlist_project_invitations
Operationlist_project_service_accounts
Operationlist_project_teams
Operationlist_project_users
Operationlist_projects
Operationlist_resource_policies
Operationlist_role_mappings
Operationlist_slow_query_logs
Operationlist_suggested_indexes
Operationlist_team_users
Operationremove_project_api_key
Operationremove_project_service_account
Operationremove_project_team
Operationremove_project_user
Operationremove_team_user
Operationrename_org
Operationrename_org_team
Operationreset_maintenance_window
Operationsave_ldap_config
Operationsave_x509_config
Operationtoggle_alert_config
Operationtoggle_regionalized_private_endpoint
Operationupdate_alert_config
Operationupdate_auditing
Operationupdate_connected_org_config
Operationupdate_custom_role
Operationupdate_db_user
Operationupdate_encryption_at_rest
Operationupdate_identity_provider
Operationupdate_integration
Operationupdate_log_export
Operationupdate_maintenance_window
Operationupdate_org_api_key
Operationupdate_org_service_account
Operationupdate_org_settings
Operationupdate_peering_connection
Operationupdate_peering_container
Operationupdate_project_settings
Operationupdate_project_team
Operationupdate_resource_policy
Operationvalidate_resource_policy
Operationverify_ldap_config