---
canonical_url: "https://docs.composio.dev/toolkits/mongodb"
markdown_url: "https://docs.composio.dev/toolkits/mongodb.md"
product: "platform"
version: null
last_updated: null
---

# MongoDB

Administer MongoDB Atlas organizations, projects, clusters, users, networking, backups, and related cloud resources with an Atlas OAuth service account.

- **Category:** databases
- **Auth:** S2S_OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 496
- **Triggers:** 0
- **Slug:** `MONGODB`
- **Version:** 00000000_00

## Tools

### Accept Group Stream Vpc Peering Connection

**Slug:** `MONGODB_ACCEPT_GROUP_STREAM_VPC_PEERING_CONNECTION`

Accept One Incoming VPC Peering Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The VPC Peering Connection id. |
| `body` | object | Yes | Container for elements used to challenge the user before taking certain actions on VPC Peering connections. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Acknowledge Group Alert

**Slug:** `MONGODB_ACKNOWLEDGE_GROUP_ALERT`

Acknowledge One Alert from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Alerts Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Acknowledging an alert prevents successive notifications. Specify the `acknowledgeUntil` date and optional comment or `unacknowledgeAlert` boolean. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `alert_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the alert. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Group API Key

**Slug:** `MONGODB_ADD_GROUP_API_KEY`

Assign One Organization API Key to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | array | Yes | Explanatory text that describes this API key, the list of roles to grant this API key, or both. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `api_user_id` | string | Yes | Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Group Teams

**Slug:** `MONGODB_ADD_GROUP_TEAMS`

Add Multiple Teams to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | array | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Group User Role

**Slug:** `MONGODB_ADD_GROUP_USER_ROLE`

Add One Project Role to One MongoDB Cloud User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `user_id` | string | Yes | 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`. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Group Users

**Slug:** `MONGODB_ADD_GROUP_USERS`

Add One MongoDB Cloud User to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Org Team User

**Slug:** `MONGODB_ADD_ORG_TEAM_USER`

Add One MongoDB Cloud User to One Team. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `team_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the team to add the MongoDB Cloud user to. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Org User Role

**Slug:** `MONGODB_ADD_ORG_USER_ROLE`

Add One Organization Role to One MongoDB Cloud User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `user_id` | string | Yes | 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`. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Authorize Group Cloud Provider Access Role

**Slug:** `MONGODB_AUTHORIZE_GROUP_CLOUD_PROVIDER_ACCESS_ROLE`

Authorize One Cloud Provider Access Role. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Grants access to the specified project for the specified access role. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `role_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the role. Amazon Web Services (AWS) IAM roles and Google Service Accounts return this value as `roleId`. Azure Service Principals return it as `_id`. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Group Cluster Backup Restore Job

**Slug:** `MONGODB_CANCEL_GROUP_CLUSTER_BACKUP_RESTORE_JOB`

Cancel One Restore Job for One Cluster. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Export Operator, Project Backup Recovery Operator

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `restore_job_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the restore job to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Ephemeral Cluster

**Slug:** `MONGODB_CREATE_EPHEMERAL_CLUSTER`

Create One Ephemeral Atlas Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | No | Create an Atlas Ephemeral cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Federation Setting Connected Org Config Role Mapping

**Slug:** `MONGODB_CREATE_FEDERATION_SETTING_CONNECTED_ORG_CONFIG_ROLE_MAPPING`

Create One Role Mapping in One Organization Configuration. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The role mapping that you want to create. |
| `org_id` | string | Yes | 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. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Federation Setting Identity Provider

**Slug:** `MONGODB_CREATE_FEDERATION_SETTING_IDENTITY_PROVIDER`

Create One Identity Provider. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | The identity provider that you want to create. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group

**Slug:** `MONGODB_CREATE_GROUP`

Create One Project. Uses the MongoDB Atlas Administration API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Creates one project. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `project_owner_id` | string | No | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Access List Entry

**Slug:** `MONGODB_CREATE_GROUP_ACCESS_LIST_ENTRY`

Add Entries to Project IP Access List. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Network Access Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | array | Yes | One or more access list entries to add to the specified project. |
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Ai Model API Key

**Slug:** `MONGODB_CREATE_GROUP_AI_MODEL_API_KEY`

Create New AI Model API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Model Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Alert Config

**Slug:** `MONGODB_CREATE_GROUP_ALERT_CONFIG`

Create One Alert Configuration in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Alerts Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Documented request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group API Key

**Slug:** `MONGODB_CREATE_GROUP_API_KEY`

Create and Assign One Organization API Key to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Backup Export Bucket

**Slug:** `MONGODB_CREATE_GROUP_BACKUP_EXPORT_BUCKET`

Create One Snapshot Export Bucket. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Specifies the role and AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket that the Export Bucket should reference. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Backup Private Endpoint

**Slug:** `MONGODB_CREATE_GROUP_BACKUP_PRIVATE_ENDPOINT`

Create One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider in One Project. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Creates a private endpoint in the specified region for object storage backup operations. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cloud_provider` | string | Yes | Human-readable label that identifies the cloud provider for the private endpoint to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Cloud Provider Access

**Slug:** `MONGODB_CREATE_GROUP_CLOUD_PROVIDER_ACCESS`

Create One Cloud Provider Access Role. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Creates one role for the specified cloud provider. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Cluster

**Slug:** `MONGODB_CREATE_GROUP_CLUSTER`

Create One Cluster in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Creator.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `use_effective_instance_fields` | boolean | No | Controls how hardware specification fields are returned in the response after cluster creation. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Primarily used for autoscaling compatibility. |
| `use_effective_fields_replication_specs` | boolean | No | Controls how `replicationSpecs` fields are returned in the response. When set to `true`, stores the client's view of `replicationSpecs` and returns it in `replicationSpecs`, while the actual cluster state (including auto-scaled hardware and auto-added shards) is returned in `effectiveReplicationSpecs`. When `false` (default), `replicationSpecs` contains the actual cluster state. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Cluster Backup Export

**Slug:** `MONGODB_CREATE_GROUP_CLUSTER_BACKUP_EXPORT`

Create One Snapshot Export Job. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Export Operator

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Information about the Cloud Backup Snapshot Export Job to create. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Cluster Backup Restore Job

**Slug:** `MONGODB_CREATE_GROUP_CLUSTER_BACKUP_RESTORE_JOB`

Create One Restore Job of One Cluster. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Export Operator, Project Backup Recovery Operator

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Restores one snapshot of one cluster from the specified project. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Cluster Collection Restore Job

**Slug:** `MONGODB_CREATE_GROUP_CLUSTER_COLLECTION_RESTORE_JOB`

Create One Collection Restore Job. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Recovery Operator

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Creates one collection-level restore job for one cluster from the specified project. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the source cluster for the restore. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Cluster Global Write Custom Zone Mapping

**Slug:** `MONGODB_CREATE_GROUP_CLUSTER_GLOBAL_WRITE_CUSTOM_ZONE_MAPPING`

Add One Custom Zone Mapping to One Global Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies this cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Cluster Global Write Managed Namespace

**Slug:** `MONGODB_CREATE_GROUP_CLUSTER_GLOBAL_WRITE_MANAGED_NAMESPACE`

Create One Managed Namespace in One Global Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies this cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Cluster Index Rolling Index

**Slug:** `MONGODB_CREATE_GROUP_CLUSTER_INDEX_ROLLING_INDEX`

Create One Rolling Index. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin, Project Index Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster on which MongoDB Cloud creates an index. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Cluster Online Archive

**Slug:** `MONGODB_CREATE_GROUP_CLUSTER_ONLINE_ARCHIVE`

Create One Online Archive. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Cluster Overload Simulation

**Slug:** `MONGODB_CREATE_GROUP_CLUSTER_OVERLOAD_SIMULATION`

Create One Overload Protection Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request to start an overload protection simulation for a cluster. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster on which to start the overload protection simulation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Cluster Search Deployment

**Slug:** `MONGODB_CREATE_GROUP_CLUSTER_SEARCH_DEPLOYMENT`

Create Search Nodes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Label that identifies the cluster to create Search Nodes for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Cluster Search Index

**Slug:** `MONGODB_CREATE_GROUP_CLUSTER_SEARCH_INDEX`

Create One Atlas Search Index. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Search Index Editor

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Name of the cluster that contains the collection on which to create an Atlas Search index. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Container

**Slug:** `MONGODB_CREATE_GROUP_CONTAINER`

Create One Network Peering Container. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Custom Db Role Role

**Slug:** `MONGODB_CREATE_GROUP_CUSTOM_DB_ROLE_ROLE`

Create One Custom Role. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Database Access Admin, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Database User

**Slug:** `MONGODB_CREATE_GROUP_DATABASE_USER`

Create One Database User in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Database Access Admin, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Database User Cert

**Slug:** `MONGODB_CREATE_GROUP_DATABASE_USER_CERT`

Create One X.509 Certificate for One Database User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `username` | string | Yes | Human-readable label that represents the MongoDB database user account for whom to create a certificate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Data Federation

**Slug:** `MONGODB_CREATE_GROUP_DATA_FEDERATION`

Create One Federated Database Instance in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `skip_role_validation` | boolean | No | Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Encryption At Rest Private Endpoint

**Slug:** `MONGODB_CREATE_GROUP_ENCRYPTION_AT_REST_PRIVATE_ENDPOINT`

Create One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Encryption At Rest Private Endpoint. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cloud_provider` | string ("AZURE" | "AWS") | Yes | Human-readable label that identifies the cloud provider for the private endpoint to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Flex Cluster

**Slug:** `MONGODB_CREATE_GROUP_FLEX_CLUSTER`

Create One Flex Cluster in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Settings that you can specify when you create a flex cluster. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Flex Cluster Backup Restore Job

**Slug:** `MONGODB_CREATE_GROUP_FLEX_CLUSTER_BACKUP_RESTORE_JOB`

Create One Restore Job for One Flex Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Backup Recovery Operator

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Details to create one restore job of a flex cluster. |
| `name` | string | Yes | Human-readable label that identifies the flex cluster whose snapshot you want to restore. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Integration

**Slug:** `MONGODB_CREATE_GROUP_INTEGRATION`

Create One Third-Party Service Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Collection of settings that describe third-party integrations. |
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `integration_type` | string ("PAGER_DUTY" | "SLACK" | "DATADOG" | "NEW_RELIC" | "OPS_GENIE" | "VICTOR_OPS" | "WEBHOOK" | "HIP_CHAT" | "PROMETHEUS" | "MICROSOFT_TEAMS") | Yes | Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Live Migration

**Slug:** `MONGODB_CREATE_GROUP_LIVE_MIGRATION`

Create One Migration for One Local Managed Cluster to MongoDB Atlas. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Log Integration

**Slug:** `MONGODB_CREATE_GROUP_LOG_INTEGRATION`

Create One Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group MCP Config

**Slug:** `MONGODB_CREATE_GROUP_MCP_CONFIG`

Create One MCP Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group MCP Config Secret

**Slug:** `MONGODB_CREATE_GROUP_MCP_CONFIG_SECRET`

Create One Secret for One Project MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `group_id` | string | Yes | 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. |
| `mcp_config_id` | string | Yes | Unique identifier of the MCP configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Metric Integration

**Slug:** `MONGODB_CREATE_GROUP_METRIC_INTEGRATION`

Create One Metric Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Metric integration configuration to create. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Peer

**Slug:** `MONGODB_CREATE_GROUP_PEER`

Create One Network Peering Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Network Access Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Private Endpoint Endpoint Service

**Slug:** `MONGODB_CREATE_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICE`

Create One Private Endpoint Service for One Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Creates one private endpoint for the specified cloud service provider. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Private Endpoint Endpoint Service Endpoint

**Slug:** `MONGODB_CREATE_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICE_ENDPOINT`

Create One Private Endpoint for One Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Creates one private endpoint for the specified cloud service provider. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cloud_provider` | string ("AWS" | "AZURE" | "GCP") | Yes | Cloud service provider that manages this private endpoint. |
| `endpoint_service_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Private Network Setting Endpoint Id

**Slug:** `MONGODB_CREATE_GROUP_PRIVATE_NETWORK_SETTING_ENDPOINT_ID`

Create One Federated Database Instance and Online Archive Private Endpoint for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Service Account

**Slug:** `MONGODB_CREATE_GROUP_SERVICE_ACCOUNT`

Create One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Details of the new Service Account. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Service Account Access List

**Slug:** `MONGODB_CREATE_GROUP_SERVICE_ACCOUNT_ACCESS_LIST`

Add Access List Entries for One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | array | Yes | A list of access list entries to add to the access list of the specified Service Account for the project. |
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `client_id` | string | Yes | The Client ID of the Service Account. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Service Account Secret

**Slug:** `MONGODB_CREATE_GROUP_SERVICE_ACCOUNT_SECRET`

Create One Project Service Account Secret. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Details for the new secret. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `client_id` | string | Yes | The Client ID of the Service Account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Standby Link

**Slug:** `MONGODB_CREATE_GROUP_STANDBY_LINK`

Create Standby Link. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body for creating a standby link between clusters. |
| `envelope` | boolean | No | Flag that indicates whether to wrap the response in an envelope. |
| `group_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the project containing the clusters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Standby Link Failover

**Slug:** `MONGODB_CREATE_GROUP_STANDBY_LINK_FAILOVER`

Create Standby Link Failover. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request to initiate a failover operation. |
| `envelope` | boolean | No | Flag that indicates whether to wrap the response in an envelope. |
| `group_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the project. |
| `standby_link_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the standby link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Stream Connection

**Slug:** `MONGODB_CREATE_GROUP_STREAM_CONNECTION`

Create One Stream Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Settings that define a connection to an external data store. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Stream Connection Failover Connection

**Slug:** `MONGODB_CREATE_GROUP_STREAM_CONNECTION_FAILOVER_CONNECTION`

Create One Failover Stream Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |
| `connection_name` | string | Yes | Label that identifies the stream connection name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Stream Private Link Connection

**Slug:** `MONGODB_CREATE_GROUP_STREAM_PRIVATE_LINK_CONNECTION`

Create One Private Link Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Container for metadata needed to create a Private Link connection. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Stream Processor

**Slug:** `MONGODB_CREATE_GROUP_STREAM_PROCESSOR`

Create One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | An Atlas stream processor request. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Streams Workspace Private Endpoint

**Slug:** `MONGODB_CREATE_GROUP_STREAMS_WORKSPACE_PRIVATE_ENDPOINT`

Create One Workspace Private Endpoint for Atlas Stream Processing. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Customer VPC endpoint to register for inbound private connectivity to Atlas Stream Processing. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Stream Workspace

**Slug:** `MONGODB_CREATE_GROUP_STREAM_WORKSPACE`

Create One Stream Workspace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org

**Slug:** `MONGODB_CREATE_ORG`

Create One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org API Key

**Slug:** `MONGODB_CREATE_ORG_API_KEY`

Create One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Organization Service Account that Atlas creates for this organization. If omitted, Atlas doesn't create an organization Service Account for this organization. If specified, this object requires all body parameters. Note that API Keys cannot be specified in the same request. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org API Key Access List Entry

**Slug:** `MONGODB_CREATE_ORG_API_KEY_ACCESS_LIST_ENTRY`

Create One Access List Entry for One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | array | Yes | Operation-specific request body. |
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `api_user_id` | string | Yes | Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org Billing Cost Explorer Usage Process

**Slug:** `MONGODB_CREATE_ORG_BILLING_COST_EXPLORER_USAGE_PROCESS`

Create One Cost Explorer Query Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body for a cost explorer query. |
| `org_id` | string | Yes | 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. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org Invoice Report

**Slug:** `MONGODB_CREATE_ORG_INVOICE_REPORT`

Create One Invoice Report. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `invoice_id` | string | Yes | Unique string that identifies the invoice for which to generate the report. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org Live Migration Link Token

**Slug:** `MONGODB_CREATE_ORG_LIVE_MIGRATION_LINK_TOKEN`

Create One Link-Token. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org Log Integration

**Slug:** `MONGODB_CREATE_ORG_LOG_INTEGRATION`

Create One Organization Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org MCP Config

**Slug:** `MONGODB_CREATE_ORG_MCP_CONFIG`

Create One MCP Configuration for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org MCP Config Secret

**Slug:** `MONGODB_CREATE_ORG_MCP_CONFIG_SECRET`

Create One Secret for One Organization MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `mcp_config_id` | string | Yes | Unique identifier of the MCP configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org Resource Policy

**Slug:** `MONGODB_CREATE_ORG_RESOURCE_POLICY`

Create One Atlas Resource Policy. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org Sandbox Config

**Slug:** `MONGODB_CREATE_ORG_SANDBOX_CONFIG`

Create One Sandbox Configuration for an Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Settings to configure the sandbox feature for an organization. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org Service Account

**Slug:** `MONGODB_CREATE_ORG_SERVICE_ACCOUNT`

Create One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Details of the new Service Account. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org Service Account Access List

**Slug:** `MONGODB_CREATE_ORG_SERVICE_ACCOUNT_ACCESS_LIST`

Add Access List Entries for One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | array | Yes | A list of access list entries to add to the access list of the specified Service Account for the organization. |
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `client_id` | string | Yes | The Client ID of the Service Account. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org Service Account Secret

**Slug:** `MONGODB_CREATE_ORG_SERVICE_ACCOUNT_SECRET`

Create One Organization Service Account Secret. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Details for the new secret. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `client_id` | string | Yes | The Client ID of the Service Account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org Team

**Slug:** `MONGODB_CREATE_ORG_TEAM`

Create One Team in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Org User

**Slug:** `MONGODB_CREATE_ORG_USER`

Add One MongoDB Cloud User to One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cutover Group Live Migration

**Slug:** `MONGODB_CUTOVER_GROUP_LIVE_MIGRATION`

Cut Over One Migrated Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `live_migration_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the migration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deauthorize Group Cloud Provider Access Role

**Slug:** `MONGODB_DEAUTHORIZE_GROUP_CLOUD_PROVIDER_ACCESS_ROLE`

Deauthorize One Cloud Provider Access Role. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `role_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the role. Amazon Web Services (AWS) IAM roles and Google Service Accounts return this value as `roleId`. Azure Service Principals return it as `_id`. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cloud_provider` | string ("AWS" | "AZURE" | "GCP") | Yes | Human-readable label that identifies the cloud provider of the role to deauthorize. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Defer Group Maintenance Window

**Slug:** `MONGODB_DEFER_GROUP_MAINTENANCE_WINDOW`

Defer One Maintenance Window for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Federation Setting

**Slug:** `MONGODB_DELETE_FEDERATION_SETTING`

Delete One Federation Settings Instance. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Federation Setting Connected Org Config Role Mapping

**Slug:** `MONGODB_DELETE_FEDERATION_SETTING_CONNECTED_ORG_CONFIG_ROLE_MAPPING`

Remove One Role Mapping from One Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove. |
| `org_id` | string | Yes | 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. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Federation Setting Identity Provider

**Slug:** `MONGODB_DELETE_FEDERATION_SETTING_IDENTITY_PROVIDER`

Delete One Identity Provider. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `identity_provider_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the identity provider to connect. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group

**Slug:** `MONGODB_DELETE_GROUP`

Remove One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Access List Entry

**Slug:** `MONGODB_DELETE_GROUP_ACCESS_LIST_ENTRY`

Remove One Entry from One Project IP Access List. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Network Access Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `entry_value` | string | Yes | Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including: - how your application established the connection, - how MongoDB Cloud or the driver using the address behaves, and - which protocol (like TCP or UDP) the connection uses. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Ai Model API Key

**Slug:** `MONGODB_DELETE_GROUP_AI_MODEL_API_KEY`

Delete Existing AI Model API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Model Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `api_key_id` | string | Yes | The id of the API key to be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Alert Config

**Slug:** `MONGODB_DELETE_GROUP_ALERT_CONFIG`

Remove One Alert Configuration from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Alerts Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `alert_config_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the alert configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Backup Export Bucket

**Slug:** `MONGODB_DELETE_GROUP_BACKUP_EXPORT_BUCKET`

Delete One Snapshot Export Bucket. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `export_bucket_id` | string | Yes | Unique 24-hexadecimal character string that identifies the Export Bucket. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Backup Private Endpoint

**Slug:** `MONGODB_DELETE_GROUP_BACKUP_PRIVATE_ENDPOINT`

Delete One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider from One Project. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `endpoint_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the private endpoint to delete. |
| `cloud_provider` | string | Yes | Human-readable label that identifies the cloud provider of the private endpoint to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Cluster

**Slug:** `MONGODB_DELETE_GROUP_CLUSTER`

Remove One Cluster from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `retain_backups` | boolean | No | Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Cluster Backup Schedule

**Slug:** `MONGODB_DELETE_GROUP_CLUSTER_BACKUP_SCHEDULE`

Remove All Cloud Backup Schedules. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Cluster Backup Snapshot

**Slug:** `MONGODB_DELETE_GROUP_CLUSTER_BACKUP_SNAPSHOT`

Remove One Replica Set Cloud Backup. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `snapshot_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Cluster Backup Snapshot Sharded Cluster

**Slug:** `MONGODB_DELETE_GROUP_CLUSTER_BACKUP_SNAPSHOT_SHARDED_CLUSTER`

Remove One Sharded Cluster Cloud Backup. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `snapshot_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Cluster Global Write Custom Zone Mapping

**Slug:** `MONGODB_DELETE_GROUP_CLUSTER_GLOBAL_WRITE_CUSTOM_ZONE_MAPPING`

Remove All Custom Zone Mappings from One Global Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies this cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Cluster Global Write Managed Namespaces

**Slug:** `MONGODB_DELETE_GROUP_CLUSTER_GLOBAL_WRITE_MANAGED_NAMESPACES`

Remove One Managed Namespace from One Global Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `db` | string | Yes | Human-readable label that identifies the database that contains the collection. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `collection` | string | Yes | Human-readable label that identifies the collection associated with the managed namespace. |
| `cluster_name` | string | Yes | Human-readable label that identifies this cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Cluster Online Archive

**Slug:** `MONGODB_DELETE_GROUP_CLUSTER_ONLINE_ARCHIVE`

Remove One Online Archive. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `archive_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the online archive to delete. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Cluster Overload Simulation

**Slug:** `MONGODB_DELETE_GROUP_CLUSTER_OVERLOAD_SIMULATION`

Delete One Overload Protection Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster on which the overload protection simulation is running. |
| `simulation_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the overload protection simulation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Cluster Private Endpoint Connection String

**Slug:** `MONGODB_DELETE_GROUP_CLUSTER_PRIVATE_ENDPOINT_CONNECTION_STRING`

Delete One Private Endpoint Connection String from One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `connection_string_id` | string | Yes | Unique 24-hexadecimal digit string that identifies this private endpoint connection string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Cluster Search Deployment

**Slug:** `MONGODB_DELETE_GROUP_CLUSTER_SEARCH_DEPLOYMENT`

Delete Search Nodes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Label that identifies the cluster to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Cluster Search Index

**Slug:** `MONGODB_DELETE_GROUP_CLUSTER_SEARCH_INDEX`

Remove One Atlas Search Index by ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Search Index Editor

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `index_id` | string | Yes | 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/) endpoint to find the IDs of all Atlas Search indexes. |
| `cluster_name` | string | Yes | Name of the cluster that contains the database and collection with one or more Application Search indexes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Cluster Search Index By Name

**Slug:** `MONGODB_DELETE_GROUP_CLUSTER_SEARCH_INDEX_BY_NAME`

Remove One Atlas Search Index by Name. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Search Index Editor

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `index_name` | string | Yes | Name of the Atlas Search index to delete. |
| `cluster_name` | string | Yes | Name of the cluster that contains the database and collection with one or more Application Search indexes. |
| `database_name` | string | Yes | Label that identifies the database that contains the collection with one or more Atlas Search indexes. |
| `collection_name` | string | Yes | Name of the collection that contains one or more Atlas Search indexes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Container

**Slug:** `MONGODB_DELETE_GROUP_CONTAINER`

Remove One Network Peering Container. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `container_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Custom Db Role Role

**Slug:** `MONGODB_DELETE_GROUP_CUSTOM_DB_ROLE_ROLE`

Remove One Custom Role from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Database Access Admin, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `role_name` | string | Yes | Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Database User

**Slug:** `MONGODB_DELETE_GROUP_DATABASE_USER`

Remove One Database User from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Database Access Admin, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `username` | string | Yes | Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: &#124; Authentication Method &#124; Parameter Needed &#124; Parameter Value &#124; username Format &#124; &#124;---&#124;---&#124;---&#124;---&#124; &#124; AWS IAM &#124; `awsIAMType` &#124; `ROLE` &#124; <abbr title="Amazon Resource Name">ARN</abbr> &#124; &#124; AWS IAM &#124; `awsIAMType` &#124; `USER` &#124; <abbr title="Amazon Resource Name">ARN</abbr> &#124; &#124; x.509 &#124; `x509Type` &#124; `CUSTOMER` &#124; [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name &#124; &#124; x.509 &#124; `x509Type` &#124; `MANAGED` &#124; [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name &#124; &#124; LDAP &#124; `ldapAuthType` &#124; `USER` &#124; [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name &#124; &#124; LDAP &#124; `ldapAuthType` &#124; `GROUP` &#124; [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name &#124; &#124; OIDC Workforce &#124; `oidcAuthType` &#124; `IDP_GROUP` &#124; Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name &#124; &#124; OIDC Workload &#124; `oidcAuthType` &#124; `USER` &#124; Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name &#124; &#124; SCRAM-SHA &#124; `awsIAMType`, `x509Type`, `ldapAuthType`, `oidcAuthType` &#124; `NONE` &#124; Alphanumeric string &#124;. |
| `database_name` | string | Yes | The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS 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`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Data Federation

**Slug:** `MONGODB_DELETE_GROUP_DATA_FEDERATION`

Remove One Federated Database Instance from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Human-readable label that identifies the federated database instance to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Data Federation Limit

**Slug:** `MONGODB_DELETE_GROUP_DATA_FEDERATION_LIMIT`

Delete One Query Limit for One Federated Database Instance. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `limit_name` | string ("bytesProcessed.query" | "bytesProcessed.daily" | "bytesProcessed.weekly" | "bytesProcessed.monthly") | Yes | Human-readable label that identifies this data federation instance limit. &#124; Limit Name &#124; Description &#124; Default &#124; &#124; --- &#124; --- &#124; --- &#124; &#124; `bytesProcessed.query` &#124; Limit on the number of bytes processed during a single data federation query &#124; N/A &#124; &#124; `bytesProcessed.daily` &#124; Limit on the number of bytes processed for the data federation instance for the current day &#124; N/A &#124; &#124; `bytesProcessed.weekly` &#124; Limit on the number of bytes processed for the data federation instance for the current week &#124; N/A &#124; &#124; `bytesProcessed.monthly` &#124; Limit on the number of bytes processed for the data federation instance for the current month &#124; N/A &#124;. |
| `tenant_name` | string | Yes | Human-readable label that identifies the federated database instance to which the query limit applies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Flex Cluster

**Slug:** `MONGODB_DELETE_GROUP_FLEX_CLUSTER`

Remove One Flex Cluster from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable label that identifies the flex cluster. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Integration

**Slug:** `MONGODB_DELETE_GROUP_INTEGRATION`

Remove One Third-Party Service Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `integration_type` | string ("PAGER_DUTY" | "SLACK" | "DATADOG" | "NEW_RELIC" | "OPS_GENIE" | "VICTOR_OPS" | "WEBHOOK" | "HIP_CHAT" | "PROMETHEUS" | "MICROSOFT_TEAMS") | Yes | Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Limit

**Slug:** `MONGODB_DELETE_GROUP_LIMIT`

Remove One Project Limit. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `limit_name` | string ("atlas.project.security.databaseAccess.users" | "atlas.project.deployment.clusters" | "atlas.project.deployment.serverlessMTMs" | "atlas.project.security.databaseAccess.customRoles" | "atlas.project.security.networkAccess.entries" | "atlas.project.security.networkAccess.crossRegionEntries" | "atlas.project.deployment.nodesPerPrivateLinkRegion" | "dataFederation.bytesProcessed.query" | "dataFederation.bytesProcessed.daily" | "dataFederation.bytesProcessed.weekly" | "dataFederation.bytesProcessed.monthly" | "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" | "atlas.project.deployment.privateServiceConnectionsSubnetMask") | Yes | Human-readable label that identifies this project limit. &#124; Limit Name &#124; Description &#124; Default &#124; API Override Limit &#124; &#124; --- &#124; --- &#124; --- &#124; --- &#124; &#124; `atlas.project.deployment.clusters` &#124; Limit on the number of clusters in this project &#124; 25 &#124; 100 &#124; &#124; `atlas.project.deployment.nodesPerPrivateLinkRegion` &#124; Limit on AWS PrivateLink addressable target nodes per region in this project. For sharded clusters using optimized (load-balanced) connection strings, `currentUsage` doesn't grow with the number of `mongos` — the load balancer is counted as a single addressable target regardless of how many `mongos` sit behind it. &#124; 50 &#124; 90 &#124; &#124; `atlas.project.security.databaseAccess.customRoles` &#124; Limit on the number of custom roles in this project &#124; 100 &#124; 1400 &#124; &#124; `atlas.project.security.databaseAccess.users` &#124; Limit on the number of database users in this project &#124; 100 &#124; 900 &#124; &#124; `atlas.project.security.networkAccess.crossRegionEntries` &#124; Limit on the number of cross-region network access entries in this project &#124; 40 &#124; 220 &#124; &#124; `atlas.project.security.networkAccess.entries` &#124; Limit on the number of network access entries in this project &#124; 200 &#124; 20 &#124; &#124; `dataFederation.bytesProcessed.query` &#124; Limit on the number of bytes processed during a single Data Federation query &#124; N/A &#124; N/A &#124; &#124; `dataFederation.bytesProcessed.daily` &#124; Limit on the number of bytes processed across all Data Federation tenants for the current day &#124; N/A &#124; N/A &#124; &#124; `dataFederation.bytesProcessed.weekly` &#124; Limit on the number of bytes processed across all Data Federation tenants for the current week &#124; N/A &#124; N/A &#124; &#124; `dataFederation.bytesProcessed.monthly` &#124; Limit on the number of bytes processed across all Data Federation tenants for the current month &#124; N/A &#124; N/A &#124; &#124; `atlas.project.deployment.privateServiceConnectionsPerRegionGroup` &#124; Number of Private Service Connections per Region Group &#124; 50 &#124; 100&#124; &#124; `atlas.project.deployment.privateServiceConnectionsSubnetMask` &#124; Subnet mask for GCP PSC Networks. Has lower limit of 20. &#124; 27 &#124; 27&#124;. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Log Integration

**Slug:** `MONGODB_DELETE_GROUP_LOG_INTEGRATION`

Remove One Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the log integration configuration. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group MCP Config

**Slug:** `MONGODB_DELETE_GROUP_MCP_CONFIG`

Delete One MCP Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | 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. |
| `cascading` | boolean | No | Flag that indicates whether to delete the MCP configuration even if it has active secrets. If false and active secrets exist, the request returns an error. Defaults to false. |
| `mcp_config_id` | string | Yes | Unique identifier of the MCP configuration to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group MCP Config Secret

**Slug:** `MONGODB_DELETE_GROUP_MCP_CONFIG_SECRET`

Delete One Secret for One Project MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | 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. |
| `secret_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the secret. |
| `mcp_config_id` | string | Yes | Unique identifier of the MCP configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Metric Integration

**Slug:** `MONGODB_DELETE_GROUP_METRIC_INTEGRATION`

Remove One Metric Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `metric_integration_id` | string | Yes | Unique identifier of the metric integration configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Peer

**Slug:** `MONGODB_DELETE_GROUP_PEER`

Remove One Network Peering Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Network Access Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `peer_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Private Endpoint Endpoint Service

**Slug:** `MONGODB_DELETE_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICE`

Remove One Private Endpoint Service for One Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cloud_provider` | string ("AWS" | "AZURE" | "GCP") | Yes | Cloud service provider that manages this private endpoint service. |
| `endpoint_service_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Private Endpoint Endpoint Service Endpoint

**Slug:** `MONGODB_DELETE_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICE_ENDPOINT`

Remove One Private Endpoint for One Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `endpoint_id` | string | Yes | Unique string that identifies the private endpoint you want to delete. The format of the `endpointId` parameter differs for AWS and Azure. You must URL encode the `endpointId` for Azure private endpoints. |
| `cloud_provider` | string ("AWS" | "AZURE" | "GCP") | Yes | Cloud service provider that manages this private endpoint. |
| `endpoint_service_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Private Network Setting Endpoint Id

**Slug:** `MONGODB_DELETE_GROUP_PRIVATE_NETWORK_SETTING_ENDPOINT_ID`

Remove One Federated Database Instance and Online Archive Private Endpoint from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `endpoint_id` | string | Yes | Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Service Account

**Slug:** `MONGODB_DELETE_GROUP_SERVICE_ACCOUNT`

Remove One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `client_id` | string | Yes | The Client ID of the Service Account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Service Account Access List Entry

**Slug:** `MONGODB_DELETE_GROUP_SERVICE_ACCOUNT_ACCESS_LIST_ENTRY`

Remove One Access List Entry from One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `client_id` | string | Yes | The Client ID of the Service Account. |
| `ip_address` | string | Yes | One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Service Account Secret

**Slug:** `MONGODB_DELETE_GROUP_SERVICE_ACCOUNT_SECRET`

Delete One Project Service Account Secret. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `client_id` | string | Yes | The Client ID of the Service Account. |
| `secret_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the secret. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Standby Link

**Slug:** `MONGODB_DELETE_GROUP_STANDBY_LINK`

Delete Standby Link. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether to wrap the response in an envelope. |
| `group_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the project. |
| `standby_link_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the standby link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Stream Connection

**Slug:** `MONGODB_DELETE_GROUP_STREAM_CONNECTION`

Delete One Stream Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |
| `connection_name` | string | Yes | Label that identifies the stream connection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Stream Connection Failover Connection

**Slug:** `MONGODB_DELETE_GROUP_STREAM_CONNECTION_FAILOVER_CONNECTION`

Delete One Stream Failover Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |
| `connection_name` | string | Yes | Label that identifies the stream connection. |
| `failover_connection_id` | string | Yes | Label that identifies the stream failover connection id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Stream Private Link Connection

**Slug:** `MONGODB_DELETE_GROUP_STREAM_PRIVATE_LINK_CONNECTION`

Delete One Private Link Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `connection_id` | string | Yes | Unique ID that identifies the Private Link connection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Stream Processor

**Slug:** `MONGODB_DELETE_GROUP_STREAM_PROCESSOR`

Delete One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |
| `processor_name` | string | Yes | Label that identifies the stream processor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Stream Vpc Peering Connection

**Slug:** `MONGODB_DELETE_GROUP_STREAM_VPC_PEERING_CONNECTION`

Delete One VPC Peering Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The VPC Peering Connection id. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Stream Workspace

**Slug:** `MONGODB_DELETE_GROUP_STREAM_WORKSPACE`

Delete One Stream Workspace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group User Security LDAP User To Dn Mapping

**Slug:** `MONGODB_DELETE_GROUP_USER_SECURITY_LDAP_USER_TO_DN_MAPPING`

Remove LDAP User to DN Mapping. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Org

**Slug:** `MONGODB_DELETE_ORG`

Remove One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Org API Key

**Slug:** `MONGODB_DELETE_ORG_API_KEY`

Remove One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `api_user_id` | string | Yes | Unique 24-hexadecimal digit string that identifies this organization API key. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Org API Key Access List Entry

**Slug:** `MONGODB_DELETE_ORG_API_KEY_ACCESS_LIST_ENTRY`

Remove One Access List Entry for One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `ip_address` | string | Yes | One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. |
| `api_user_id` | string | Yes | Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Org Live Migration Link Tokens

**Slug:** `MONGODB_DELETE_ORG_LIVE_MIGRATION_LINK_TOKENS`

Remove One Link-Token. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Org Log Integration

**Slug:** `MONGODB_DELETE_ORG_LOG_INTEGRATION`

Remove One Organization Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `log_integration_id` | string | Yes | Unique identifier of the log integration configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Org MCP Config

**Slug:** `MONGODB_DELETE_ORG_MCP_CONFIG`

Delete One MCP Configuration for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `cascading` | boolean | No | Flag that indicates whether to delete the MCP configuration even if it has active secrets. If false and active secrets exist, the request returns an error. Defaults to false. |
| `mcp_config_id` | string | Yes | Unique identifier of the MCP configuration to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Org MCP Config Secret

**Slug:** `MONGODB_DELETE_ORG_MCP_CONFIG_SECRET`

Delete One Secret for One Organization MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `secret_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the secret. |
| `mcp_config_id` | string | Yes | Unique identifier of the MCP configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Org Resource Policy

**Slug:** `MONGODB_DELETE_ORG_RESOURCE_POLICY`

Delete One Atlas Resource Policy. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `resource_policy_id` | string | Yes | Unique 24-hexadecimal digit string that identifies an atlas resource policy. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Org Sandbox Config

**Slug:** `MONGODB_DELETE_ORG_SANDBOX_CONFIG`

Delete the Default Sandbox Configuration and Disable Sandbox. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `sandbox_config_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the sandbox configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Org Service Account

**Slug:** `MONGODB_DELETE_ORG_SERVICE_ACCOUNT`

Delete One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `client_id` | string | Yes | The Client ID of the Service Account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Org Service Account Access List Entry

**Slug:** `MONGODB_DELETE_ORG_SERVICE_ACCOUNT_ACCESS_LIST_ENTRY`

Remove One Access List Entry from One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `client_id` | string | Yes | The Client ID of the Service Account. |
| `ip_address` | string | Yes | One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Org Service Account Secret

**Slug:** `MONGODB_DELETE_ORG_SERVICE_ACCOUNT_SECRET`

Delete One Organization Service Account Secret. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `client_id` | string | Yes | The Client ID of the Service Account. |
| `secret_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the secret. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Org Team

**Slug:** `MONGODB_DELETE_ORG_TEAM`

Remove One Team from One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `team_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the team that you want to delete. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disable Group Backup Compliance Policy

**Slug:** `MONGODB_DISABLE_GROUP_BACKUP_COMPLIANCE_POLICY`

Disable Backup Compliance Policy Settings. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disable Group Managed Slow Ms

**Slug:** `MONGODB_DISABLE_GROUP_MANAGED_SLOW_MS`

Disable Managed Slow Operation Threshold. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disable Group User Security Customer X.509

**Slug:** `MONGODB_DISABLE_GROUP_USER_SECURITY_CUSTOMER_X509`

Disable Customer-Managed X.509. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Group Cluster Log

**Slug:** `MONGODB_DOWNLOAD_GROUP_CLUSTER_LOG`

Download Logs for One Cluster Host in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Log Viewer, Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | integer | No | 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 date. If the start date is also unspecified, the value will default to the time of the request. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `log_name` | string ("mongodb" | "mongos" | "mongodb-audit-log" | "mongos-audit-log") | Yes | Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project. |
| `host_name` | string | Yes | Human-readable label that identifies the host that stores the log files that you want to download. |
| `start_date` | integer | No | Specifies the date and time for the starting 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 prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Group Cluster Online Archive Query Logs

**Slug:** `MONGODB_DOWNLOAD_GROUP_CLUSTER_ONLINE_ARCHIVE_QUERY_LOGS`

Download Online Archive Query Logs. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | integer | No | Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `start_date` | integer | No | Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). |
| `archive_only` | boolean | No | Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Group Data Federation Query Logs

**Slug:** `MONGODB_DOWNLOAD_GROUP_DATA_FEDERATION_QUERY_LOGS`

Download Query Logs for One Federated Database Instance. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | integer | No | Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. |
| `group_id` | string | Yes | 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. |
| `start_date` | integer | No | Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. |
| `tenant_name` | string | Yes | Human-readable label that identifies the federated database instance for which you want to download query logs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Group Flex Cluster Backup

**Slug:** `MONGODB_DOWNLOAD_GROUP_FLEX_CLUSTER_BACKUP`

Download One Flex Cluster Snapshot. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Backup Export Operator

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Details for one backup snapshot download of a flex cluster. |
| `name` | string | Yes | Human-readable label that identifies the flex cluster. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Group Stream Audit Logs

**Slug:** `MONGODB_DOWNLOAD_GROUP_STREAM_AUDIT_LOGS`

Download Audit Logs for One Atlas Stream Processing Workspace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sp_name` | string | No | Name of the stream processor to download logs for. An empty string will download logs for all stream processors in the workspace. |
| `end_date` | integer | No | Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `start_date` | integer | No | Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Group Stream Operational Logs

**Slug:** `MONGODB_DOWNLOAD_GROUP_STREAM_OPERATIONAL_LOGS`

Download Operational Logs for One Atlas Stream Processing Workspace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sp_name` | string | No | Name of the stream processor to download logs for. An empty string will download logs for all stream processors in the workspace. |
| `end_date` | integer | No | Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `start_date` | integer | No | Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable Group Managed Slow Ms

**Slug:** `MONGODB_ENABLE_GROUP_MANAGED_SLOW_MS`

Enable Managed Slow Operation Threshold. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### End Group Cluster Outage Simulation

**Slug:** `MONGODB_END_GROUP_CLUSTER_OUTAGE_SIMULATION`

End One Outage Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager, Project Cluster Resilience Tester, Project Replica Set Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster that is undergoing outage simulation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Group Sandbox Cluster Description

**Slug:** `MONGODB_GENERATE_GROUP_SANDBOX_CLUSTER_DESCRIPTION`

Return Cluster Description from Sandbox Template Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Project Creator.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `sandbox_config_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the sandbox configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Org Invoice And Download Report

**Slug:** `MONGODB_GENERATE_ORG_INVOICE_AND_DOWNLOAD_REPORT`

Generate and Download Invoice Report. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `invoice_id` | string | Yes | Unique string that identifies the invoice for which to generate the report. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Default Group Limit

**Slug:** `MONGODB_GET_DEFAULT_GROUP_LIMIT`

Return One User-Configurable Project Limit and Description. Uses the MongoDB Atlas Administration API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `limit_name` | string ("MONGODB_USERS" | "NUM_CLUSTERS" | "NUM_SERVERLESS_MTMS" | "NUM_USER_CUSTOM_ROLES" | "MAX_NETWORK_PERMISSION_ENTRIES" | "MAX_CROSS_REGION_NETWORK_PERMISSION_ENTRIES" | "MAX_NODES_PER_PRIVATELINK_REGION" | "BYTES_PROCESSED_QUERY" | "BYTES_PROCESSED_DAILY" | "BYTES_PROCESSED_WEEKLY" | "BYTES_PROCESSED_MONTHLY" | "NUM_PRIVATE_SERVICE_CONNECTIONS_PER_REGION_GROUP" | "GCP_PSC_NAT_SUBNET_MASK") | Yes | Atlas endpoint identifier for the user-managed limit. These finite identifiers are not the dotted names returned by unrelated limit-list operations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ephemeral Cluster

**Slug:** `MONGODB_GET_EPHEMERAL_CLUSTER`

Return One Ephemeral Atlas Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cluster_id` | string | Yes | Unique ID of the ephemeral cluster to look up. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Federation Setting Connected Org Config

**Slug:** `MONGODB_GET_FEDERATION_SETTING_CONNECTED_ORG_CONFIG`

Return One Organization Configuration from One Federation. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the connected organization configuration to return. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Federation Setting Connected Org Config Role Mapping

**Slug:** `MONGODB_GET_FEDERATION_SETTING_CONNECTED_ORG_CONFIG_ROLE_MAPPING`

Return One Role Mapping from One Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique 24-hexadecimal digit string that identifies the role mapping that you want to return. |
| `org_id` | string | Yes | 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. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Federation Setting Identity Provider

**Slug:** `MONGODB_GET_FEDERATION_SETTING_IDENTITY_PROVIDER`

Return One Identity Provider by ID. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `identity_provider_id` | string | Yes | Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. 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. For all other versions, use the 24-hexadecimal digit id. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Federation Setting Identity Provider Metadata

**Slug:** `MONGODB_GET_FEDERATION_SETTING_IDENTITY_PROVIDER_METADATA`

Return Metadata of One Identity Provider. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `identity_provider_id` | string | Yes | Legacy 20-hexadecimal digit string that identifies the identity provider. 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. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group

**Slug:** `MONGODB_GET_GROUP`

Return One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Access List Entry

**Slug:** `MONGODB_GET_GROUP_ACCESS_LIST_ENTRY`

Return One Project IP Access List Entry. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `entry_value` | string | Yes | Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Access List Status

**Slug:** `MONGODB_GET_GROUP_ACCESS_LIST_STATUS`

Return Status of One Project IP Access List Entry. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `entry_value` | string | Yes | Network address or cloud provider security construct that identifies which project access list entry to be verified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Activity Feed

**Slug:** `MONGODB_GET_GROUP_ACTIVITY_FEED`

Return Pre-Filtered Activity Feed Link for One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `group_id` | string | Yes | 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. |
| `max_date` | string | No | End date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC. |
| `min_date` | string | No | Start date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC. |
| `event_type` | array | No | Category of incident recorded at this moment in time. **IMPORTANT**: The complete list of event type values changes frequently. |
| `cluster_name` | array | No | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Ai Model API Cloud Geography Model Group Name Rate Limits

**Slug:** `MONGODB_GET_GROUP_AI_MODEL_API_CLOUD_GEOGRAPHY_MODEL_GROUP_NAME_RATE_LIMITS`

Return Single AI Model Rate Limit for One Group. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cloud` | string | Yes | Cloud provider scope. Must be "ANY". Additional values will be supported in future API versions. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `geography` | string | Yes | Geography scope. Must be "ANY". Additional values will be supported in future API versions. |
| `model_group_name` | string | Yes | The name of the model group to be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Ai Model API Key

**Slug:** `MONGODB_GET_GROUP_AI_MODEL_API_KEY`

Return Single AI Model API Key for One Group. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `api_key_id` | string | Yes | The id of the API key to be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Ai Model API Rate Limits

**Slug:** `MONGODB_GET_GROUP_AI_MODEL_API_RATE_LIMITS`

Return AI Model Rate Limits for One Group. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Alert

**Slug:** `MONGODB_GET_GROUP_ALERT`

Return One Alert from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `alert_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the alert. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Alert Alert Configs

**Slug:** `MONGODB_GET_GROUP_ALERT_ALERT_CONFIGS`

Return a Page of Alert Configurations Set for One Alert. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor returned by the previous page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `alert_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the alert. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Alert Config

**Slug:** `MONGODB_GET_GROUP_ALERT_CONFIG`

Return One Alert Configuration from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `alert_config_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the alert configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Alert Config Alerts

**Slug:** `MONGODB_GET_GROUP_ALERT_CONFIG_ALERTS`

Return a Page of Open Alerts for One Alert Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `alert_config_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the alert configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Audit Log

**Slug:** `MONGODB_GET_GROUP_AUDIT_LOG`

Return Auditing Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group AWS Custom DNS

**Slug:** `MONGODB_GET_GROUP_AWS_CUSTOM_DNS`

Return One Custom DNS Configuration for Atlas Clusters on AWS. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Backup Compliance Policy

**Slug:** `MONGODB_GET_GROUP_BACKUP_COMPLIANCE_POLICY`

Return Backup Compliance Policy Settings. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Backup Export Bucket

**Slug:** `MONGODB_GET_GROUP_BACKUP_EXPORT_BUCKET`

Return One Snapshot Export Bucket. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `export_bucket_id` | string | Yes | Unique 24-hexadecimal character string that identifies the Export Bucket. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Backup Private Endpoint

**Slug:** `MONGODB_GET_GROUP_BACKUP_PRIVATE_ENDPOINT`

Return One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider in One Project. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `endpoint_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the private endpoint. |
| `cloud_provider` | string | Yes | Human-readable label that identifies the cloud provider of the private endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group By Name

**Slug:** `MONGODB_GET_GROUP_BY_NAME`

Return One Project by Name. Uses the MongoDB Atlas Administration API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_name` | string | Yes | Human-readable label that identifies this project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cloud Provider Access

**Slug:** `MONGODB_GET_GROUP_CLOUD_PROVIDER_ACCESS`

Return One Cloud Provider Access Role. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `role_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the role. Amazon Web Services (AWS) IAM roles and Google Service Accounts return this value as `roleId`. Azure Service Principals return it as `_id`. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster

**Slug:** `MONGODB_GET_GROUP_CLUSTER`

Return One Cluster from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies this cluster. |
| `use_effective_instance_fields` | boolean | No | Controls how hardware specification fields are returned in the response. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Primarily used for autoscaling compatibility. |
| `use_effective_fields_replication_specs` | boolean | No | Controls how `replicationSpecs` are returned in the response. When set to `true`, returns the client-specified view in `replicationSpecs` and the actual cluster state in `effectiveReplicationSpecs`. When `false` (default), `replicationSpecs` contains the actual cluster state. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Adaptive Settings

**Slug:** `MONGODB_GET_GROUP_CLUSTER_ADAPTIVE_SETTINGS`

Return Adaptive Settings for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Backup Export

**Slug:** `MONGODB_GET_GROUP_CLUSTER_BACKUP_EXPORT`

Return One Snapshot Export Job. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `export_id` | string | Yes | Unique 24-hexadecimal character string that identifies the Export Job. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Backup Restore Job

**Slug:** `MONGODB_GET_GROUP_CLUSTER_BACKUP_RESTORE_JOB`

Return One Restore Job for One Cluster. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster with the restore jobs you want to return. |
| `restore_job_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the restore job to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Backup Schedule

**Slug:** `MONGODB_GET_GROUP_CLUSTER_BACKUP_SCHEDULE`

Return One Cloud Backup Schedule. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Backup Snapshot

**Slug:** `MONGODB_GET_GROUP_CLUSTER_BACKUP_SNAPSHOT`

Return One Replica Set Cloud Backup. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `snapshot_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Backup Snapshot Database

**Slug:** `MONGODB_GET_GROUP_CLUSTER_BACKUP_SNAPSHOT_DATABASE`

Return One Database in One Snapshot. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `snapshot_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `database_name` | string | Yes | Human-readable label that identifies the database. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Backup Snapshot Database Collection

**Slug:** `MONGODB_GET_GROUP_CLUSTER_BACKUP_SNAPSHOT_DATABASE_COLLECTION`

Return One Collection in One Database in One Snapshot. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `snapshot_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `database_name` | string | Yes | Human-readable label that identifies the database. |
| `collection_name` | string | Yes | Human-readable label that identifies the collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Backup Snapshot Sharded Cluster

**Slug:** `MONGODB_GET_GROUP_CLUSTER_BACKUP_SNAPSHOT_SHARDED_CLUSTER`

Return One Sharded Cluster Cloud Backup. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `snapshot_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Collection Restore Job

**Slug:** `MONGODB_GET_GROUP_CLUSTER_COLLECTION_RESTORE_JOB`

Return One Collection Restore Job for One Cluster. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the collection restore job to return. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster with the collection restore jobs you want to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Collection Restore Job Collection

**Slug:** `MONGODB_GET_GROUP_CLUSTER_COLLECTION_RESTORE_JOB_COLLECTION`

Return One Collection State for One Collection Restore Job. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the collection restore job. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster with the collection restore job you want to return. |
| `source_namespace` | string | Yes | Source namespace that identifies the collection to return (e.g. `db.collection`). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Coll Stat Namespaces

**Slug:** `MONGODB_GET_GROUP_CLUSTER_COLL_STAT_NAMESPACES`

Return Ranked Namespaces from One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `start` | string | No | Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `period` | string | No | Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster to pin namespaces to. |
| `cluster_view` | string ("PRIMARY" | "SECONDARY" | "INDIVIDUAL_PROCESS") | Yes | Human-readable label that identifies the cluster topology to retrieve metrics for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Global Writes

**Slug:** `MONGODB_GET_GROUP_CLUSTER_GLOBAL_WRITES`

Return One Managed Namespace in One Global Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies this cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Online Archive

**Slug:** `MONGODB_GET_GROUP_CLUSTER_ONLINE_ARCHIVE`

Return One Online Archive. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `archive_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the online archive to return. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Outage Simulation

**Slug:** `MONGODB_GET_GROUP_CLUSTER_OUTAGE_SIMULATION`

Return One Outage Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager, Project Cluster Resilience Tester

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster that is undergoing outage simulation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Overload Simulation

**Slug:** `MONGODB_GET_GROUP_CLUSTER_OVERLOAD_SIMULATION`

Return One Overload Protection Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster on which the overload protection simulation is running. |
| `simulation_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the overload protection simulation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Private Endpoint Connection String

**Slug:** `MONGODB_GET_GROUP_CLUSTER_PRIVATE_ENDPOINT_CONNECTION_STRING`

Return One Private Endpoint Connection String for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `connection_string_id` | string | Yes | Unique 24-hexadecimal digit string that identifies this private endpoint connection string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Process Args

**Slug:** `MONGODB_GET_GROUP_CLUSTER_PROCESS_ARGS`

Return Advanced Configuration Options for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Query Shape

**Slug:** `MONGODB_GET_GROUP_CLUSTER_QUERY_SHAPE`

Return One Query Shape. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `query_shape_hash` | string | Yes | A SHA256 hash of a query shape, output by MongoDB commands like `$queryStats` and `$explain` or slow query logs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Query Shape Insight Details

**Slug:** `MONGODB_GET_GROUP_CLUSTER_QUERY_SHAPE_INSIGHT_DETAILS`

Return Query Shape Details. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since` | integer | No | Date and time from which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). - If you don't specify the **until** parameter, the endpoint returns data covering from the **since** value and the current time. - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours. |
| `until` | integer | No | Date and time up until which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). - If you specify the **until** parameter, you must specify the **since** parameter. - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `process_ids` | array | No | Process IDs from which to retrieve query shape statistics. A `processId` is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple `processIds`, pass the parameter multiple times delimited with an ampersand (`&`) between each `processId`. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `query_shape_hash` | string | Yes | A SHA256 hash of a query shape, output by MongoDB commands like `$queryStats` and `$explain` or slow query logs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Search Deployment

**Slug:** `MONGODB_GET_GROUP_CLUSTER_SEARCH_DEPLOYMENT`

Return All Search Nodes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Label that identifies the cluster to return the Search Nodes for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Search Index

**Slug:** `MONGODB_GET_GROUP_CLUSTER_SEARCH_INDEX`

Return One Atlas Search Index by ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Read Only, Project Data Access Read Write, Project Search Index Editor, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `index_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes. |
| `cluster_name` | string | Yes | Name of the cluster that contains the collection with one or more Atlas Search indexes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Search Index By Name

**Slug:** `MONGODB_GET_GROUP_CLUSTER_SEARCH_INDEX_BY_NAME`

Return One Atlas Search Index by Name. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Read Only, Project Data Access Read Write, Project Search Index Editor, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `index_name` | string | Yes | Name of the Atlas Search index to return. |
| `cluster_name` | string | Yes | Name of the cluster that contains the collection with one or more Atlas Search indexes. |
| `database_name` | string | Yes | Label that identifies the database that contains the collection with one or more Atlas Search indexes. |
| `collection_name` | string | Yes | Name of the collection that contains one or more Atlas Search indexes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster SQL Interface

**Slug:** `MONGODB_GET_GROUP_CLUSTER_SQL_INTERFACE`

Return SQL Interface Status. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Cluster Status

**Slug:** `MONGODB_GET_GROUP_CLUSTER_STATUS`

Return Status of All Cluster Operations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Container

**Slug:** `MONGODB_GET_GROUP_CONTAINER`

Return One Network Peering Container. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `container_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Custom Db Role Role

**Slug:** `MONGODB_GET_GROUP_CUSTOM_DB_ROLE_ROLE`

Return One Custom Role in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `role_name` | string | Yes | Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Database User

**Slug:** `MONGODB_GET_GROUP_DATABASE_USER`

Return One Database User from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `username` | string | Yes | Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: &#124; Authentication Method &#124; Parameter Needed &#124; Parameter Value &#124; username Format &#124; &#124;---&#124;---&#124;---&#124;---&#124; &#124; AWS IAM &#124; `awsIAMType` &#124; `ROLE` &#124; <abbr title="Amazon Resource Name">ARN</abbr> &#124; &#124; AWS IAM &#124; `awsIAMType` &#124; `USER` &#124; <abbr title="Amazon Resource Name">ARN</abbr> &#124; &#124; x.509 &#124; `x509Type` &#124; `CUSTOMER` &#124; [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name &#124; &#124; x.509 &#124; `x509Type` &#124; `MANAGED` &#124; [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name &#124; &#124; LDAP &#124; `ldapAuthType` &#124; `USER` &#124; [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name &#124; &#124; LDAP &#124; `ldapAuthType` &#124; `GROUP` &#124; [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name &#124; &#124; OIDC Workforce &#124; `oidcAuthType` &#124; `IDP_GROUP` &#124; Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name &#124; &#124; OIDC Workload &#124; `oidcAuthType` &#124; `USER` &#124; Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name &#124; &#124; SCRAM-SHA &#124; `awsIAMType`, `x509Type`, `ldapAuthType`, `oidcAuthType` &#124; `NONE` &#124; Alphanumeric string &#124;. |
| `database_name` | string | Yes | The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS 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`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Data Federation

**Slug:** `MONGODB_GET_GROUP_DATA_FEDERATION`

Return One Federated Database Instance in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Human-readable label that identifies the Federated Database to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Data Federation Limit

**Slug:** `MONGODB_GET_GROUP_DATA_FEDERATION_LIMIT`

Return One Federated Database Instance Query Limit for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `limit_name` | string ("bytesProcessed.query" | "bytesProcessed.daily" | "bytesProcessed.weekly" | "bytesProcessed.monthly") | Yes | Human-readable label that identifies this data federation instance limit. &#124; Limit Name &#124; Description &#124; Default &#124; &#124; --- &#124; --- &#124; --- &#124; &#124; `bytesProcessed.query` &#124; Limit on the number of bytes processed during a single data federation query &#124; N/A &#124; &#124; `bytesProcessed.daily` &#124; Limit on the number of bytes processed for the data federation instance for the current day &#124; N/A &#124; &#124; `bytesProcessed.weekly` &#124; Limit on the number of bytes processed for the data federation instance for the current week &#124; N/A &#124; &#124; `bytesProcessed.monthly` &#124; Limit on the number of bytes processed for the data federation instance for the current month &#124; N/A &#124;. |
| `tenant_name` | string | Yes | Human-readable label that identifies the federated database instance to which the query limit applies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Db Access History Cluster

**Slug:** `MONGODB_GET_GROUP_DB_ACCESS_HISTORY_CLUSTER`

Return Database Access History for One Cluster by Cluster Name. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Log Viewer, Project Database Access Admin

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | integer | No | Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds. |
| `start` | integer | No | Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds. |
| `n_logs` | integer | No | Maximum number of lines from the log to return. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `ip_address` | string | No | One Internet Protocol address that attempted to authenticate with the database. |
| `auth_result` | boolean | No | Flag that indicates whether the response returns the successful authentication attempts only. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Db Access History Process

**Slug:** `MONGODB_GET_GROUP_DB_ACCESS_HISTORY_PROCESS`

Return Database Access History for One Cluster by Hostname. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Log Viewer, Project Database Access Admin

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | integer | No | Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds. |
| `start` | integer | No | Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds. |
| `n_logs` | integer | No | Maximum number of lines from the log to return. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `hostname` | string | Yes | Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download. |
| `ip_address` | string | No | One Internet Protocol address that attempted to authenticate with the database. |
| `auth_result` | boolean | No | Flag that indicates whether the response returns the successful authentication attempts only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Encryption At Rest

**Slug:** `MONGODB_GET_GROUP_ENCRYPTION_AT_REST`

Return One Configuration for Encryption at Rest Using Customer-Managed Keys for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Encryption At Rest Private Endpoint

**Slug:** `MONGODB_GET_GROUP_ENCRYPTION_AT_REST_PRIVATE_ENDPOINT`

Return One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `endpoint_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the private endpoint. |
| `cloud_provider` | string ("AZURE" | "AWS") | Yes | Human-readable label that identifies the cloud provider of the private endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Event

**Slug:** `MONGODB_GET_GROUP_EVENT`

Return One Event from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `event_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the event that you want to return. |
| `group_id` | string | Yes | 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. |
| `include_raw` | boolean | No | Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Flex Cluster

**Slug:** `MONGODB_GET_GROUP_FLEX_CLUSTER`

Return One Flex Cluster from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable label that identifies the flex cluster. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Flex Cluster Backup Restore Job

**Slug:** `MONGODB_GET_GROUP_FLEX_CLUSTER_BACKUP_RESTORE_JOB`

Return One Restore Job for One Flex Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable label that identifies the flex cluster. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `restore_job_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the restore job to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Flex Cluster Backup Snapshot

**Slug:** `MONGODB_GET_GROUP_FLEX_CLUSTER_BACKUP_SNAPSHOT`

Return One Snapshot for One Flex Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable label that identifies the flex cluster. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `snapshot_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Host Fts Metric Index Measurements

**Slug:** `MONGODB_GET_GROUP_HOST_FTS_METRIC_INDEX_MEASUREMENTS`

Return Atlas Search Metrics for One Index in One Namespace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `start` | string | No | Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `period` | string | No | Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. |
| `metrics` | array | Yes | List that contains the measurements that MongoDB Atlas reports for the associated data series. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `index_name` | string | Yes | Human-readable label that identifies the index. |
| `process_id` | string | Yes | Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. |
| `granularity` | string | Yes | Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. |
| `database_name` | string | Yes | Human-readable label that identifies the database. |
| `collection_name` | string | Yes | Human-readable label that identifies the collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Integration

**Slug:** `MONGODB_GET_GROUP_INTEGRATION`

Return One Third-Party Service Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `integration_type` | string ("PAGER_DUTY" | "SLACK" | "DATADOG" | "NEW_RELIC" | "OPS_GENIE" | "VICTOR_OPS" | "WEBHOOK" | "HIP_CHAT" | "PROMETHEUS" | "MICROSOFT_TEAMS") | Yes | Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group IP Addresses

**Slug:** `MONGODB_GET_GROUP_IP_ADDRESSES`

Return All IP Addresses for One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Limit

**Slug:** `MONGODB_GET_GROUP_LIMIT`

Return One Limit for One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `limit_name` | string ("atlas.project.security.databaseAccess.users" | "atlas.project.deployment.clusters" | "atlas.project.deployment.serverlessMTMs" | "atlas.project.security.databaseAccess.customRoles" | "atlas.project.security.networkAccess.entries" | "atlas.project.security.networkAccess.crossRegionEntries" | "atlas.project.deployment.nodesPerPrivateLinkRegion" | "dataFederation.bytesProcessed.query" | "dataFederation.bytesProcessed.daily" | "dataFederation.bytesProcessed.weekly" | "dataFederation.bytesProcessed.monthly" | "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" | "atlas.project.deployment.privateServiceConnectionsSubnetMask") | Yes | Human-readable label that identifies this project limit. &#124; Limit Name &#124; Description &#124; Default &#124; API Override Limit &#124; &#124; --- &#124; --- &#124; --- &#124; --- &#124; &#124; `atlas.project.deployment.clusters` &#124; Limit on the number of clusters in this project &#124; 25 &#124; 100 &#124; &#124; `atlas.project.deployment.nodesPerPrivateLinkRegion` &#124; Limit on AWS PrivateLink addressable target nodes per region in this project. For sharded clusters using optimized (load-balanced) connection strings, `currentUsage` doesn't grow with the number of `mongos` — the load balancer is counted as a single addressable target regardless of how many `mongos` sit behind it. &#124; 50 &#124; 90 &#124; &#124; `atlas.project.security.databaseAccess.customRoles` &#124; Limit on the number of custom roles in this project &#124; 100 &#124; 1400 &#124; &#124; `atlas.project.security.databaseAccess.users` &#124; Limit on the number of database users in this project &#124; 100 &#124; 900 &#124; &#124; `atlas.project.security.networkAccess.crossRegionEntries` &#124; Limit on the number of cross-region network access entries in this project &#124; 40 &#124; 220 &#124; &#124; `atlas.project.security.networkAccess.entries` &#124; Limit on the number of network access entries in this project &#124; 200 &#124; 20 &#124; &#124; `dataFederation.bytesProcessed.query` &#124; Limit on the number of bytes processed during a single Data Federation query &#124; N/A &#124; N/A &#124; &#124; `dataFederation.bytesProcessed.daily` &#124; Limit on the number of bytes processed across all Data Federation tenants for the current day &#124; N/A &#124; N/A &#124; &#124; `dataFederation.bytesProcessed.weekly` &#124; Limit on the number of bytes processed across all Data Federation tenants for the current week &#124; N/A &#124; N/A &#124; &#124; `dataFederation.bytesProcessed.monthly` &#124; Limit on the number of bytes processed across all Data Federation tenants for the current month &#124; N/A &#124; N/A &#124; &#124; `atlas.project.deployment.privateServiceConnectionsPerRegionGroup` &#124; Number of Private Service Connections per Region Group &#124; 50 &#124; 100&#124; &#124; `atlas.project.deployment.privateServiceConnectionsSubnetMask` &#124; Subnet mask for GCP PSC Networks. Has lower limit of 20. &#124; 27 &#124; 27&#124;. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Live Migration

**Slug:** `MONGODB_GET_GROUP_LIVE_MIGRATION`

Return One Migration Job. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `live_migration_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the migration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Live Migration Validate Status

**Slug:** `MONGODB_GET_GROUP_LIVE_MIGRATION_VALIDATE_STATUS`

Return One Migration Validation Job. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `validation_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the validation job. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Log Integration

**Slug:** `MONGODB_GET_GROUP_LOG_INTEGRATION`

Return One Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the log integration configuration. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Maintenance Window

**Slug:** `MONGODB_GET_GROUP_MAINTENANCE_WINDOW`

Return One Maintenance Window for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Managed Slow Ms

**Slug:** `MONGODB_GET_GROUP_MANAGED_SLOW_MS`

Return Managed Slow Operation Threshold Status. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group MCP Config

**Slug:** `MONGODB_GET_GROUP_MCP_CONFIG`

Return One MCP Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `mcp_config_id` | string | Yes | Unique identifier of the MCP configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group MCP Config Secret

**Slug:** `MONGODB_GET_GROUP_MCP_CONFIG_SECRET`

Return One Secret for One Project MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `secret_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the secret. |
| `mcp_config_id` | string | Yes | Unique identifier of the MCP configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Metric Integration

**Slug:** `MONGODB_GET_GROUP_METRIC_INTEGRATION`

Return One Metric Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `metric_integration_id` | string | Yes | Unique identifier of the metric integration configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Mongo Db Versions

**Slug:** `MONGODB_GET_GROUP_MONGO_DB_VERSIONS`

Return a Page of Available MongoDB LTS Versions for Clusters in One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `instance_size` | string | No | Filter results to only one instance size. |
| `cloud_provider` | string ("AWS" | "AZURE" | "GCP" | "TENANT") | No | Filter results to only one cloud provider. |
| `default_status` | string | No | Filter results to only the default values per tier. This value must be DEFAULT. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Peer

**Slug:** `MONGODB_GET_GROUP_PEER`

Return One Network Peering Connection in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `peer_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Private Endpoint Endpoint Service

**Slug:** `MONGODB_GET_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICE`

Return One Private Endpoint Service for One Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cloud_provider` | string ("AWS" | "AZURE" | "GCP") | Yes | Cloud service provider that manages this private endpoint service. |
| `endpoint_service_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Private Endpoint Endpoint Service Endpoint

**Slug:** `MONGODB_GET_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICE_ENDPOINT`

Return One Private Endpoint for One Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `endpoint_id` | string | Yes | Unique string that identifies the private endpoint you want to return. The format of the `endpointId` parameter differs for AWS and Azure. You must URL encode the `endpointId` for Azure private endpoints. |
| `cloud_provider` | string ("AWS" | "AZURE" | "GCP") | Yes | Cloud service provider that manages this private endpoint. |
| `endpoint_service_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Private Endpoint Regional Mode

**Slug:** `MONGODB_GET_GROUP_PRIVATE_ENDPOINT_REGIONAL_MODE`

Return Regionalized Private Endpoint Status. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Private Network Setting Endpoint Id

**Slug:** `MONGODB_GET_GROUP_PRIVATE_NETWORK_SETTING_ENDPOINT_ID`

Return One Federated Database Instance and Online Archive Private Endpoint in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `endpoint_id` | string | Yes | Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Process

**Slug:** `MONGODB_GET_GROUP_PROCESS`

Return One MongoDB Process by ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `process_id` | string | Yes | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Process Coll Stat Namespaces

**Slug:** `MONGODB_GET_GROUP_PROCESS_COLL_STAT_NAMESPACES`

Return Ranked Namespaces from One Host. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `start` | string | No | Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `period` | string | No | Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `process_id` | string | Yes | Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Process Database

**Slug:** `MONGODB_GET_GROUP_PROCESS_DATABASE`

Return One Database for One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `process_id` | string | Yes | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. |
| `database_name` | string | Yes | Human-readable label that identifies the database that the specified MongoDB process serves. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Process Database Measurements

**Slug:** `MONGODB_GET_GROUP_PROCESS_DATABASE_MEASUREMENTS`

Return Measurements for One Database in One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `start` | string | No | Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `period` | string | No | Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `process_id` | string | Yes | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. |
| `granularity` | string | Yes | Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. |
| `database_name` | string | Yes | Human-readable label that identifies the database that the specified MongoDB process serves. |
| `measurement_types` | array | No | Measurement types to return. If omitted, Atlas returns all measurements that apply to the specified database. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Process Disk

**Slug:** `MONGODB_GET_GROUP_PROCESS_DISK`

Return Measurements for One Disk. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `process_id` | string | Yes | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. |
| `partition_name` | string | Yes | Human-readable label of the disk or partition to which the measurements apply. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Process Disk Measurements

**Slug:** `MONGODB_GET_GROUP_PROCESS_DISK_MEASUREMENTS`

Return Measurements of One Disk for One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `start` | string | No | Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `period` | string | No | Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `process_id` | string | Yes | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. |
| `granularity` | string | Yes | Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. |
| `partition_name` | string | Yes | Human-readable label of the disk or partition to which the measurements apply. |
| `measurement_types` | array | No | Measurement types to return. If omitted, Atlas returns all measurements that apply to the specified disk or partition. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Process Measurements

**Slug:** `MONGODB_GET_GROUP_PROCESS_MEASUREMENTS`

Return Measurements for One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `start` | string | No | Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `period` | string | No | Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `process_id` | string | Yes | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. |
| `granularity` | string | Yes | Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. |
| `measurement_types` | array | No | Measurement types to return. If omitted, Atlas returns all measurements that apply to the specified MongoDB process. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Sample Dataset Load

**Slug:** `MONGODB_GET_GROUP_SAMPLE_DATASET_LOAD`

Return Status of Sample Dataset Load for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `sample_dataset_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the loaded sample dataset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Service Account

**Slug:** `MONGODB_GET_GROUP_SERVICE_ACCOUNT`

Return One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `client_id` | string | Yes | The Client ID of the Service Account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Settings

**Slug:** `MONGODB_GET_GROUP_SETTINGS`

Return Project Settings. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Standby Link

**Slug:** `MONGODB_GET_GROUP_STANDBY_LINK`

Return One Standby Link. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether to wrap the response in an envelope. |
| `group_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the project. |
| `standby_link_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the standby link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Standby Link Failover

**Slug:** `MONGODB_GET_GROUP_STANDBY_LINK_FAILOVER`

Return One Standby Link Failover. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether to wrap the response in an envelope. |
| `group_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the project. |
| `failover_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the failover operation. |
| `standby_link_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the standby link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Stream Account Details

**Slug:** `MONGODB_GET_GROUP_STREAM_ACCOUNT_DETAILS`

Return Account ID and VPC ID for One Project and Region. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `region_name` | string | Yes | The cloud provider specific region name, i.e. "US_EAST_1" for cloud provider "aws". |
| `cloud_provider` | string | Yes | One of "aws", "azure" or "gcp". |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Stream Connection

**Slug:** `MONGODB_GET_GROUP_STREAM_CONNECTION`

Return One Stream Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace to return. |
| `connection_name` | string | Yes | Label that identifies the stream connection to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Stream Connection Failover Connection

**Slug:** `MONGODB_GET_GROUP_STREAM_CONNECTION_FAILOVER_CONNECTION`

Return One Stream Failover Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |
| `connection_name` | string | Yes | Label that identifies the stream connection. |
| `failover_connection_id` | string | Yes | Label that identifies the stream failover connection id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Stream Private Link Connection

**Slug:** `MONGODB_GET_GROUP_STREAM_PRIVATE_LINK_CONNECTION`

Return One Private Link Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `connection_id` | string | Yes | Unique ID that identifies the Private Link connection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Stream Processor

**Slug:** `MONGODB_GET_GROUP_STREAM_PROCESSOR`

Return One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |
| `processor_name` | string | Yes | Label that identifies the stream processor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Stream Processors

**Slug:** `MONGODB_GET_GROUP_STREAM_PROCESSORS`

Return a Page of Stream Processors in One Stream Workspace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Streams Workspace Private Endpoint

**Slug:** `MONGODB_GET_GROUP_STREAMS_WORKSPACE_PRIVATE_ENDPOINT`

Return One Workspace Private Endpoint for Atlas Stream Processing. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `endpoint_id` | string | Yes | Unique identifier of the customer's VPC endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Stream Workspace

**Slug:** `MONGODB_GET_GROUP_STREAM_WORKSPACE`

Return One Stream Workspace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace to return. |
| `include_connections` | boolean | No | Flag to indicate whether connections information should be included in the stream workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Team

**Slug:** `MONGODB_GET_GROUP_TEAM`

Return One Team in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `team_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the team for which you want to get. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group User

**Slug:** `MONGODB_GET_GROUP_USER`

Return One MongoDB Cloud User in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `user_id` | string | Yes | 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`. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `org_membership_statuses` | array | No | Organization membership status to filter users by. You can supply this parameter multiple times. Allowed values: `ACTIVE`, `PENDING`, `INVITATION_EXPIRED`, `INVITATION_REJECTED`. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Not supported in deprecated versions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group User Security

**Slug:** `MONGODB_GET_GROUP_USER_SECURITY`

Return LDAP or X.509 Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group User Security LDAP Verify

**Slug:** `MONGODB_GET_GROUP_USER_SECURITY_LDAP_VERIFY`

Return Status of LDAP Configuration Verification in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `request_id` | string | Yes | Unique string that identifies the request to verify an Lightweight Directory Access Protocol (LDAP) configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org

**Slug:** `MONGODB_GET_ORG`

Return One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Activity Feed

**Slug:** `MONGODB_GET_ORG_ACTIVITY_FEED`

Return Pre-Filtered Activity Feed Link for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Member.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `max_date` | string | No | End date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC. |
| `min_date` | string | No | Start date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC. |
| `event_type` | array | No | Category of incident recorded at this moment in time. **IMPORTANT**: The complete list of event type values changes frequently. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Ai Model API Cloud Geography Model Group Name Rate Limits

**Slug:** `MONGODB_GET_ORG_AI_MODEL_API_CLOUD_GEOGRAPHY_MODEL_GROUP_NAME_RATE_LIMITS`

Return Single AI Model Rate Limit for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cloud` | string | Yes | Cloud provider scope. Must be "ANY". Additional values will be supported in future API versions. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `geography` | string | Yes | Geography scope. Must be "ANY". Additional values will be supported in future API versions. |
| `model_group_name` | string | Yes | The name of the model group to be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Ai Model API Key

**Slug:** `MONGODB_GET_ORG_AI_MODEL_API_KEY`

Return Single AI Model API Key for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `api_key_id` | string | Yes | The id of the API key to be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Ai Model API Rate Limits

**Slug:** `MONGODB_GET_ORG_AI_MODEL_API_RATE_LIMITS`

Return AI Model Rate Limits for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org API Key

**Slug:** `MONGODB_GET_ORG_API_KEY`

Return One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `api_user_id` | string | Yes | Unique 24-hexadecimal digit string that identifies this organization API key that you want to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org API Key Access List Entry

**Slug:** `MONGODB_GET_ORG_API_KEY_ACCESS_LIST_ENTRY`

Return One Access List Entry for One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `ip_address` | string | Yes | One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. |
| `api_user_id` | string | Yes | Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Associated Invoices

**Slug:** `MONGODB_GET_ORG_ASSOCIATED_INVOICES`

Return Associated Invoices. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | No | The year for which to retrieve invoices. Defaults to current year. |
| `month` | integer | No | The month for which to retrieve invoices (1-12). Defaults to current month. |
| `org_id` | string | Yes | 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. |
| `include_linked_orgs` | boolean | No | Whether to include invoices from linked organizations. Defaults to false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Billing Cost Explorer Usage

**Slug:** `MONGODB_GET_ORG_BILLING_COST_EXPLORER_USAGE`

Return Usage Details for One Cost Explorer Query. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | Unique 64 digit string that identifies the Cost Explorer query. |
| `org_id` | string | Yes | 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. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Delegation Settings

**Slug:** `MONGODB_GET_ORG_DELEGATION_SETTINGS`

Return Delegation Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Event

**Slug:** `MONGODB_GET_ORG_EVENT`

Return One Event from One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `event_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the event that you want to return. |
| `include_raw` | boolean | No | Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Federation Settings

**Slug:** `MONGODB_GET_ORG_FEDERATION_SETTINGS`

Return Federation Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Groups

**Slug:** `MONGODB_GET_ORG_GROUPS`

Return a Page of Projects in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name. |
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Invoice

**Slug:** `MONGODB_GET_ORG_INVOICE`

Return One Invoice for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `invoice_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Invoice Csv

**Slug:** `MONGODB_GET_ORG_INVOICE_CSV`

Return One Invoice as CSV for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `invoice_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Invoice Report

**Slug:** `MONGODB_GET_ORG_INVOICE_REPORT`

Return One Invoice Report. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `report_id` | string | Yes | Unique string that identifies the report to retrieve. |
| `invoice_id` | string | Yes | Unique string that identifies the invoice the report was generated for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Log Integration

**Slug:** `MONGODB_GET_ORG_LOG_INTEGRATION`

Return One Organization Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `log_integration_id` | string | Yes | Unique identifier of the log integration configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Maintenance Settings

**Slug:** `MONGODB_GET_ORG_MAINTENANCE_SETTINGS`

Return Maintenance Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org MCP Config

**Slug:** `MONGODB_GET_ORG_MCP_CONFIG`

Return One MCP Configuration for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `mcp_config_id` | string | Yes | Unique identifier of the MCP configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org MCP Config Secret

**Slug:** `MONGODB_GET_ORG_MCP_CONFIG_SECRET`

Return One Secret for One Organization MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `secret_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the secret. |
| `mcp_config_id` | string | Yes | Unique identifier of the MCP configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Non Compliant Resources

**Slug:** `MONGODB_GET_ORG_NON_COMPLIANT_RESOURCES`

Return All Non-Compliant Resources. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Resource Policy

**Slug:** `MONGODB_GET_ORG_RESOURCE_POLICY`

Return One Atlas Resource Policy. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `resource_policy_id` | string | Yes | Unique 24-hexadecimal digit string that identifies an atlas resource policy. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Sandbox Config

**Slug:** `MONGODB_GET_ORG_SANDBOX_CONFIG`

Return Default Sandbox Configuration for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Project Creator.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `sandbox_config_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the sandbox configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Service Account

**Slug:** `MONGODB_GET_ORG_SERVICE_ACCOUNT`

Return One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `client_id` | string | Yes | The Client ID of the Service Account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Service Account Groups

**Slug:** `MONGODB_GET_ORG_SERVICE_ACCOUNT_GROUPS`

Return a Page of Service Account Project Assignments. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `client_id` | string | Yes | The Client ID of the Service Account. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Settings

**Slug:** `MONGODB_GET_ORG_SETTINGS`

Return Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Team

**Slug:** `MONGODB_GET_ORG_TEAM`

Return One Team by ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `team_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the team whose information you want to return. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org Team By Name

**Slug:** `MONGODB_GET_ORG_TEAM_BY_NAME`

Return One Team by Name. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `team_name` | string | Yes | Name of the team whose information you want to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Org User

**Slug:** `MONGODB_GET_ORG_USER`

Return One MongoDB Cloud User in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `user_id` | string | Yes | 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`. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `org_membership_statuses` | array | No | Organization membership status to filter users by. You can supply this parameter multiple times. Allowed values: `ACTIVE`, `PENDING`, `INVITATION_EXPIRED`, `INVITATION_REJECTED`. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Not supported in deprecated versions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rate Limit

**Slug:** `MONGODB_GET_RATE_LIMIT`

Return One Rate Limit. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | No | Unique 24-hexadecimal digit string that identifies the Atlas Organization to request rate limits for. When this parameter is provided, the limits returned are applicable to the specified organization. The requesting user must have the Organization Read Only role for the specified organization. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `user_id` | string | No | A string that identifies the Atlas user to request rate limits for. The ID can for example be the Service Account Client ID or the API Public Key. When this parameter is provided, the limits returned are applicable to the specified user. The requesting user must be the same as the specified user. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | No | Unique 24-hexadecimal digit string that identifies the Atlas Project to request rate limits for. When this parameter is provided, the limits returned are applicable to the specified project. The requesting user must have the Project Read Only role for the specified project. |
| `ip_address` | string | No | An IP address to request rate limits for. When this parameter is provided, the limits returned are applicable to the specified IP address. The requesting user must have the same IP address as the one provided in the request. |
| `endpoint_set_id` | string | Yes | The ID of the rate limit endpoint set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sku

**Slug:** `MONGODB_GET_SKU`

Return One Stock Keeping Unit. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member, Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `sku_id` | string | Yes | Unique identifier of the SKU to retrieve. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get System Status

**Slug:** `MONGODB_GET_SYSTEM_STATUS`

Return the Status of This MongoDB Application. Uses the MongoDB Atlas Administration API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Grant Group Cluster Mongo Db Employee Access

**Slug:** `MONGODB_GRANT_GROUP_CLUSTER_MONGO_DB_EMPLOYEE_ACCESS`

Grant MongoDB Employee Cluster Access for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Support Access Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies this cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Inspect Group Standby Link Failover Readiness

**Slug:** `MONGODB_INSPECT_GROUP_STANDBY_LINK_FAILOVER_READINESS`

Inspect Failover Readiness for One Standby Link. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether to wrap the response in an envelope. |
| `group_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the project. |
| `standby_link_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the standby link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Invite Group Service Account

**Slug:** `MONGODB_INVITE_GROUP_SERVICE_ACCOUNT`

Assign One Service Account to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The Project permissions for the Service Account in the specified Project. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `client_id` | string | Yes | The Client ID of the Service Account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Alert Config Matcher Field Names

**Slug:** `MONGODB_LIST_ALERT_CONFIG_MATCHER_FIELD_NAMES`

Return All Alert Configuration Matchers Field Names. Uses the MongoDB Atlas Administration API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Cluster Details

**Slug:** `MONGODB_LIST_CLUSTER_DETAILS`

Return a Page of Authorized Clusters in All Projects. Uses the MongoDB Atlas Administration API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor returned by the previous page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Control Plane IP Addresses

**Slug:** `MONGODB_LIST_CONTROL_PLANE_IP_ADDRESSES`

Return All Control Plane IP Addresses. Uses the MongoDB Atlas Administration API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Default Group Limits

**Slug:** `MONGODB_LIST_DEFAULT_GROUP_LIMITS`

Return Descriptions of User-Configurable Project Limits. Uses the MongoDB Atlas Administration API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor returned by the previous page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Event Types

**Slug:** `MONGODB_LIST_EVENT_TYPES`

Return a Page of Event Types. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member, Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor returned by the previous page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Federation Setting Connected Org Config Role Mappings

**Slug:** `MONGODB_LIST_FEDERATION_SETTING_CONNECTED_ORG_CONFIG_ROLE_MAPPINGS`

Return All Role Mappings from One Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Federation Setting Connected Org Configs

**Slug:** `MONGODB_LIST_FEDERATION_SETTING_CONNECTED_ORG_CONFIGS`

Return a Page of Organization Configurations from One Federation. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Federation Setting Identity Providers

**Slug:** `MONGODB_LIST_FEDERATION_SETTING_IDENTITY_PROVIDERS`

Return a Page of Identity Providers in One Federation. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `idp_type` | array | No | The types of the target identity providers. |
| `protocol` | array | No | The protocols of the target identity providers. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Access List Entries

**Slug:** `MONGODB_LIST_GROUP_ACCESS_LIST_ENTRIES`

Return a Page of Project IP Access List Entries. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Ai Model API Keys

**Slug:** `MONGODB_LIST_GROUP_AI_MODEL_API_KEYS`

Return AI Model API Keys for One Group. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Alert Configs

**Slug:** `MONGODB_LIST_GROUP_ALERT_CONFIGS`

Return a Page of Alert Configurations in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor returned by the previous page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Alerts

**Slug:** `MONGODB_LIST_GROUP_ALERTS`

Return a Page of Alerts from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `status` | string ("OPEN" | "TRACKING" | "CLOSED") | No | Status of the alerts to return. Omit this parameter to return all alerts in all statuses. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group API Keys

**Slug:** `MONGODB_LIST_GROUP_API_KEYS`

Return a Page of Organization API Keys Assigned to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Backup Export Buckets

**Slug:** `MONGODB_LIST_GROUP_BACKUP_EXPORT_BUCKETS`

Return a Page of Snapshot Export Buckets. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Backup Private Endpoints

**Slug:** `MONGODB_LIST_GROUP_BACKUP_PRIVATE_ENDPOINTS`

Return Object Storage Private Endpoints for Cloud Backups for One Cloud Provider in One Project. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `cloud_provider` | string | Yes | Human-readable label that identifies the cloud provider for the private endpoints to return. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cloud Provider Access

**Slug:** `MONGODB_LIST_GROUP_CLOUD_PROVIDER_ACCESS`

Return All Cloud Provider Access Roles. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Backup Exports

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_BACKUP_EXPORTS`

Return a Page of Snapshot Export Jobs. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Backup Restore Jobs

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_BACKUP_RESTORE_JOBS`

Return a Page of Restore Jobs for One Cluster. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster with the restore jobs you want to return. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Backup Snapshot Database Collections

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_BACKUP_SNAPSHOT_DATABASE_COLLECTIONS`

Return Collections in One Database in One Snapshot. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `snapshot_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `database_name` | string | Yes | Human-readable label that identifies the database. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Backup Snapshot Databases

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_BACKUP_SNAPSHOT_DATABASES`

Return Databases in One Snapshot. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `snapshot_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Backup Snapshots

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_BACKUP_SNAPSHOTS`

Return a Page of Replica Set Cloud Backups. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `oplog_ts` | integer | No | Oplog timestamp that represents the desired point in time. This is the first part of an Oplog timestamp. Must be used with `oplogInc`. Mutually exclusive with `pointInTimeUtcSeconds`. |
| `oplog_inc` | integer | No | Oplog operation number that represents the desired point in time. This is the second part of an Oplog timestamp. Must be used with `oplogTs`. Mutually exclusive with `pointInTimeUtcSeconds`. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `point_in_time_utc_seconds` | integer | No | Desired point in time, expressed as the number of seconds that have elapsed since the UNIX epoch. If specified, returns the closest snapshot created before that point in time. Mutually exclusive with `oplogTs` and `oplogInc`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Backup Snapshot Sharded Clusters

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_BACKUP_SNAPSHOT_SHARDED_CLUSTERS`

Return All Sharded Cluster Cloud Backups. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Collection Restore Job Collections

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_COLLECTION_RESTORE_JOB_COLLECTIONS`

Return a Page of Collection States for One Collection Restore Job. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `state` | string ("NOT_STARTED" | "IN_PROGRESS" | "FINALIZING" | "NOT_FOUND" | "UNSUPPORTED" | "SUCCESSFUL" | "ROLLBACK" | "NOT_RESTORED" | "FAILED") | No | Collection-level state to filter by. |
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `job_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the collection restore job. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster with the collection restore job you want to return. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `source_namespace` | string | No | Source namespace to filter by (e.g. `db.collection`). |
| `target_namespace` | string | No | Target namespace to filter by (e.g. `db.collection`). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Collection Restore Jobs

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_COLLECTION_RESTORE_JOBS`

Return a Page of Collection Restore Jobs for One Cluster. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster with the collection restore jobs you want to return. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Coll Stat Measurements

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_COLL_STAT_MEASUREMENTS`

Return Cluster-Level Query Latency. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `start` | string | No | Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `period` | string | No | Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. |
| `metrics` | array | No | List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster to retrieve metrics for. |
| `cluster_view` | string ("PRIMARY" | "SECONDARY" | "INDIVIDUAL_PROCESS") | Yes | Human-readable label that identifies the cluster topology to retrieve metrics for. |
| `database_name` | string | Yes | Human-readable label that identifies the database. |
| `collection_name` | string | Yes | Human-readable label that identifies the collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Coll Stat Pinned Namespaces

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_COLL_STAT_PINNED_NAMESPACES`

Return Pinned Namespaces. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster to retrieve pinned namespaces for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Online Archives

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_ONLINE_ARCHIVES`

Return a Page of Online Archives for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Overload Simulations

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_OVERLOAD_SIMULATIONS`

Return a Page of Overload Protection Simulations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster on which the overload protection simulations are running. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Performance Advisor Drop Index Suggestions

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_PERFORMANCE_ADVISOR_DROP_INDEX_SUGGESTIONS`

Return All Suggested Indexes to Drop. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Performance Advisor Schema Advice

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_PERFORMANCE_ADVISOR_SCHEMA_ADVICE`

Return Schema Advice. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Performance Advisor Suggested Indexes

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_PERFORMANCE_ADVISOR_SUGGESTED_INDEXES`

Return All Suggested Indexes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since` | integer | No | Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). - If you don't specify the **until** parameter, the endpoint returns data covering from the **since** value and the current time. - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours. |
| `until` | integer | No | Date and time up until which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). - If you specify the **until** parameter, you must specify the **since** parameter. - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `namespaces` | array | No | Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `<database>.<collection>`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. |
| `process_ids` | array | No | Process IDs from which to retrieve suggested indexes. A `processId` is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple `processIds`, pass the parameter multiple times delimited with an ampersand (`&`) between each `processId`. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Private Endpoint Connection Strings

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_PRIVATE_ENDPOINT_CONNECTION_STRINGS`

Return a Page of Private Endpoint Connection Strings for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor returned by the previous page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `status` | string ("PENDING" | "AVAILABLE" | "FAILED") | No | Filter records by lifecycle status. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `management_type` | string ("SELF_MANAGED" | "IMPORTED") | No | Filter records by management type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Provider Regions

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_PROVIDER_REGIONS`

Return a Page of Cloud Provider Regions. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tier` | string | No | Cluster tier for which to retrieve the regions. |
| `cursor` | string | No | Cursor returned by the previous page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `providers` | array | No | Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Query Shape Insight Summaries

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_QUERY_SHAPE_INSIGHT_SUMMARIES`

Return Query Statistic Summaries. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since` | integer | No | Date and time from which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). - If you don't specify the **until** parameter, the endpoint returns data covering from the **since** value and the current time. - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours. |
| `until` | integer | No | Date and time up until which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). - If you specify the **until** parameter, you must specify the **since** parameter. - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `series` | array | No | Query shape statistics data series to retrieve. A series represents a specific metric about query execution. To include multiple series, pass the parameter multiple times delimited with an ampersand (`&`) between each series. Omit this parameter to return results for all available series. The `P50_EXECUTION_TIME`, `P90_EXECUTION_TIME`, and `P99_EXECUTION_TIME` series are deprecated as the values they report may be inaccurate. They will be removed in a future release. |
| `commands` | array | No | Retrieve query shape statistics matching specified MongoDB commands. To include multiple commands, pass the parameter multiple times delimited with an ampersand (`&`) between each command. The currently supported parameters are: find, distinct, aggregate, count, insert, update, and delete. The insert, update, and delete commands return results only for clusters running MongoDB 9.0 or later with write query shape statistics enabled for the project. Omit this parameter to return results for all supported commands. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `namespaces` | array | No | Namespaces from which to retrieve query shape statistics. A namespace consists of one database and one collection resource written as `.`: `<database>.<collection>`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. |
| `n_summaries` | integer | No | Maximum number of query statistic summaries to return. |
| `process_ids` | array | No | Process IDs from which to retrieve query shape statistics. A `processId` is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple `processId`, pass the parameter multiple times delimited with an ampersand (`&`) between each `processId`. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `query_shape_hashes` | array | No | A list of SHA256 hashes of desired query shapes, output by MongoDB commands like `$queryStats` and $explain or slow query logs. To include multiple series, pass the parameter multiple times delimited with an ampersand (`&`) between each series. Omit this parameter to return results for all available series. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Query Shapes

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_QUERY_SHAPES`

Return a Page of Query Shapes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `status` | string | No | The status of query shapes to retrieve. Only REJECTED status is supported. If omitted, defaults to REJECTED. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Clusters

**Slug:** `MONGODB_LIST_GROUP_CLUSTERS`

Return a Page of Clusters in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor returned by the previous page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `use_effective_instance_fields` | boolean | No | Controls how hardware specification fields are returned in the response. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Primarily used for autoscaling compatibility. |
| `include_deleted_with_retained_backups` | boolean | No | Flag that indicates whether to return Clusters with retain backups. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Search Index

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_SEARCH_INDEX`

Return All Atlas Search Indexes for One Collection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Read Only, Project Data Access Read Write, Project Search Index Editor, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Name of the cluster that contains the collection with one or more Atlas Search indexes. |
| `database_name` | string | Yes | Label that identifies the database that contains the collection with one or more Atlas Search indexes. |
| `collection_name` | string | Yes | Name of the collection that contains one or more Atlas Search indexes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Cluster Search Indexes

**Slug:** `MONGODB_LIST_GROUP_CLUSTER_SEARCH_INDEXES`

Return All Atlas Search Indexes for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Read Only, Project Data Access Read Write, Project Search Index Editor, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Name of the cluster that contains the collection with one or more Atlas Search indexes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Coll Stat Metrics

**Slug:** `MONGODB_LIST_GROUP_COLL_STAT_METRICS`

Return All Metric Names. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Container All

**Slug:** `MONGODB_LIST_GROUP_CONTAINER_ALL`

Return a Page of Network Peering Containers in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Containers

**Slug:** `MONGODB_LIST_GROUP_CONTAINERS`

Return a Page of Network Peering Containers in One Project for One Cloud Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `provider_name` | string ("AWS" | "AZURE" | "GCP") | Yes | Cloud service provider that serves the desired network peering containers. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Custom Db Role Roles

**Slug:** `MONGODB_LIST_GROUP_CUSTOM_DB_ROLE_ROLES`

Return All Custom Roles in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Database User Certs

**Slug:** `MONGODB_LIST_GROUP_DATABASE_USER_CERTS`

Return a Page of X.509 Certificates Assigned to One Database User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `username` | string | Yes | Human-readable label that represents the MongoDB database user account whose certificates you want to return. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Database Users

**Slug:** `MONGODB_LIST_GROUP_DATABASE_USERS`

Return a Page of Database Users in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Data Federation

**Slug:** `MONGODB_LIST_GROUP_DATA_FEDERATION`

Return All Federated Database Instances in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("USER" | "ONLINE_ARCHIVE") | No | Type of Federated Database Instances to return. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Data Federation Limits

**Slug:** `MONGODB_LIST_GROUP_DATA_FEDERATION_LIMITS`

Return All Query Limits for One Federated Database Instance. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Human-readable label that identifies the federated database instance for which you want to retrieve query limits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Encryption At Rest Private Endpoints

**Slug:** `MONGODB_LIST_GROUP_ENCRYPTION_AT_REST_PRIVATE_ENDPOINTS`

Return Private Endpoints for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `cloud_provider` | string ("AZURE" | "AWS") | Yes | Human-readable label that identifies the cloud provider for the private endpoints to return. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Events

**Slug:** `MONGODB_LIST_GROUP_EVENTS`

Return Events from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor returned by the previous page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `max_date` | string | No | Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC. |
| `min_date` | string | No | Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC. |
| `event_type` | array | No | Category of incident recorded at this moment in time. **IMPORTANT**: The complete list of event type values changes frequently. |
| `include_raw` | boolean | No | Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. |
| `cluster_names` | array | No | Human-readable label that identifies the cluster. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `excluded_event_type` | array | No | Category of event that you would like to exclude from query results, such as `CLUSTER_CREATED`. **IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Flex Cluster Backup Restore Jobs

**Slug:** `MONGODB_LIST_GROUP_FLEX_CLUSTER_BACKUP_RESTORE_JOBS`

Return a Page of Restore Jobs for One Flex Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable label that identifies the flex cluster. |
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Flex Cluster Backup Snapshots

**Slug:** `MONGODB_LIST_GROUP_FLEX_CLUSTER_BACKUP_SNAPSHOTS`

Return a Page of Snapshots for One Flex Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable label that identifies the flex cluster. |
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Flex Clusters

**Slug:** `MONGODB_LIST_GROUP_FLEX_CLUSTERS`

Return a Page of Flex Clusters from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Host Fts Metric Index Measurements

**Slug:** `MONGODB_LIST_GROUP_HOST_FTS_METRIC_INDEX_MEASUREMENTS`

Return All Atlas Search Index Metrics for One Namespace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `start` | string | No | Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `period` | string | No | Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. |
| `metrics` | array | Yes | List that contains the measurements that MongoDB Atlas reports for the associated data series. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `process_id` | string | Yes | Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. |
| `granularity` | string | Yes | Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. |
| `database_name` | string | Yes | Human-readable label that identifies the database. |
| `collection_name` | string | Yes | Human-readable label that identifies the collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Host Fts Metric Measurements

**Slug:** `MONGODB_LIST_GROUP_HOST_FTS_METRIC_MEASUREMENTS`

Return Atlas Search Hardware and Status Metrics. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `start` | string | No | Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `period` | string | No | Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. |
| `metrics` | array | Yes | List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `process_id` | string | Yes | Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. |
| `granularity` | string | Yes | Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Host Fts Metrics

**Slug:** `MONGODB_LIST_GROUP_HOST_FTS_METRICS`

Return All Atlas Search Metric Types for One Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `process_id` | string | Yes | Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Integrations

**Slug:** `MONGODB_LIST_GROUP_INTEGRATIONS`

Return a Page of Active Third-Party Service Integrations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Limits

**Slug:** `MONGODB_LIST_GROUP_LIMITS`

Return All Limits for One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Log Integrations

**Slug:** `MONGODB_LIST_GROUP_LOG_INTEGRATIONS`

Return a Page of Active Log Integrations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `integration_type` | string | No | Optional filter by integration type (e.g., `S3_LOG_EXPORT`). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group MCP Configs

**Slug:** `MONGODB_LIST_GROUP_MCP_CONFIGS`

Return a Page of MCP Configurations for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group MCP Config Secrets

**Slug:** `MONGODB_LIST_GROUP_MCP_CONFIG_SECRETS`

Return a Page of Secrets for One Project MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `mcp_config_id` | string | Yes | Unique identifier of the MCP configuration. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Metric Integrations

**Slug:** `MONGODB_LIST_GROUP_METRIC_INTEGRATIONS`

Return a Page of Active Metric Integrations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `provider_type` | string | No | Optional filter by provider type (e.g., `CUSTOM`). When specified, `integrationType` must also be specified. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `integration_type` | string | No | Optional filter by integration type (e.g., `OTEL`). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Peers

**Slug:** `MONGODB_LIST_GROUP_PEERS`

Return a Page of Network Peering Connections in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `provider_name` | string ("AWS" | "AZURE" | "GCP") | No | Cloud service provider to use for this VPC peering connection. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Private Endpoint Endpoint Service

**Slug:** `MONGODB_LIST_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICE`

Return All Private Endpoint Services for One Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cloud_provider` | string ("AWS" | "AZURE" | "GCP") | Yes | Cloud service provider that manages this private endpoint service. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Private Network Setting Endpoint Ids

**Slug:** `MONGODB_LIST_GROUP_PRIVATE_NETWORK_SETTING_ENDPOINT_IDS`

Return a Page of Federated Database Instance and Online Archive Private Endpoints in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Process Coll Stat Measurements

**Slug:** `MONGODB_LIST_GROUP_PROCESS_COLL_STAT_MEASUREMENTS`

Return Host-Level Query Latency. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `start` | string | No | Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. |
| `period` | string | No | Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. |
| `metrics` | array | No | List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `process_id` | string | Yes | Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. |
| `database_name` | string | Yes | Human-readable label that identifies the database. |
| `collection_name` | string | Yes | Human-readable label that identifies the collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Process Databases

**Slug:** `MONGODB_LIST_GROUP_PROCESS_DATABASES`

Return Available Databases for One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `process_id` | string | Yes | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod`). The port must be the IANA port on which the MongoDB process listens for requests. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Process Disks

**Slug:** `MONGODB_LIST_GROUP_PROCESS_DISKS`

Return Available Disks for One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `process_id` | string | Yes | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Processes

**Slug:** `MONGODB_LIST_GROUP_PROCESSES`

Return a Page of MongoDB Processes in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Process Performance Advisor Namespaces

**Slug:** `MONGODB_LIST_GROUP_PROCESS_PERFORMANCE_ADVISOR_NAMESPACES`

Return All Namespaces for One Host. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since` | integer | No | Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). - If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time. - If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `duration` | integer | No | Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. - If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `process_id` | string | Yes | Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Process Performance Advisor Slow Query Logs

**Slug:** `MONGODB_LIST_GROUP_PROCESS_PERFORMANCE_ADVISOR_SLOW_QUERY_LOGS`

Return Slow Queries. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Observability Viewer, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since` | integer | No | Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). - If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time. - If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours. |
| `n_logs` | integer | No | Maximum number of lines from the log to return. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `duration` | integer | No | Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. - If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `namespaces` | array | No | Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as `.`: `<database>.<collection>`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. |
| `process_id` | string | Yes | Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. |
| `include_metrics` | boolean | No | Whether or not to include metrics extracted from the slow query log as separate fields. |
| `include_op_type` | boolean | No | Whether or not to include the operation type (read/write/command) extracted from the slow query log as a separate field. |
| `include_replica_state` | boolean | No | Whether or not to include the replica state of the host when the slow query log was generated as a separate field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Process Performance Advisor Suggested Indexes

**Slug:** `MONGODB_LIST_GROUP_PROCESS_PERFORMANCE_ADVISOR_SUGGESTED_INDEXES`

Return a Page of Suggested Indexes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since` | integer | No | Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). - If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time. - If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours. |
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `duration` | integer | No | Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. - If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `n_indexes` | integer | No | Number that indicates the maximum indexes to suggest. |
| `n_examples` | integer | No | Maximum number of example queries that benefit from the suggested index. |
| `namespaces` | array | No | Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `<database>.<collection>`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. |
| `process_id` | string | Yes | Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Groups

**Slug:** `MONGODB_LIST_GROUPS`

Return a Page of Projects. Uses the MongoDB Atlas Administration API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Service Account Access List

**Slug:** `MONGODB_LIST_GROUP_SERVICE_ACCOUNT_ACCESS_LIST`

Return a Page of Access List Entries for One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `client_id` | string | Yes | The Client ID of the Service Account. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Service Accounts

**Slug:** `MONGODB_LIST_GROUP_SERVICE_ACCOUNTS`

Return a Page of Project Service Accounts. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `include_system_managed` | boolean | No | Flag that indicates whether system-managed Service Accounts (such as those used for MCP ingress/egress integrations) are included in the response. When false, only user-managed Service Accounts are returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Standby Link Failovers

**Slug:** `MONGODB_LIST_GROUP_STANDBY_LINK_FAILOVERS`

Return a Page of Standby Link Failovers. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the project. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `standby_link_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the standby link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Standby Links

**Slug:** `MONGODB_LIST_GROUP_STANDBY_LINKS`

Return a Page of Standby Links for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the project. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Stream Active Vpc Peering Connections

**Slug:** `MONGODB_LIST_GROUP_STREAM_ACTIVE_VPC_PEERING_CONNECTIONS`

Return a Page of Active Incoming VPC Peering Connections. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Stream Connection Failover Connections

**Slug:** `MONGODB_LIST_GROUP_STREAM_CONNECTION_FAILOVER_CONNECTIONS`

Return a Page of Stream Failover Connections. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `connection_name` | string | Yes | Label that identifies the stream connection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Stream Connections

**Slug:** `MONGODB_LIST_GROUP_STREAM_CONNECTIONS`

Return a Page of Connections of the Stream Workspaces. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Stream Private Link Connections

**Slug:** `MONGODB_LIST_GROUP_STREAM_PRIVATE_LINK_CONNECTIONS`

Return a Page of Private Link Connections. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Streams Workspace Private Endpoints

**Slug:** `MONGODB_LIST_GROUP_STREAMS_WORKSPACE_PRIVATE_ENDPOINTS`

Return a Page of Workspace Private Endpoints for Atlas Stream Processing. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Stream Vpc Peering Connections

**Slug:** `MONGODB_LIST_GROUP_STREAM_VPC_PEERING_CONNECTIONS`

Return a Page of VPC Peering Connections. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `requester_account_id` | string | Yes | The Account ID of the VPC Peering connection/s. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Stream Workspaces

**Slug:** `MONGODB_LIST_GROUP_STREAM_WORKSPACES`

Return a Page of Stream Workspaces in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Teams

**Slug:** `MONGODB_LIST_GROUP_TEAMS`

Return a Page of Teams in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Users

**Slug:** `MONGODB_LIST_GROUP_USERS`

Return a Page of MongoDB Cloud Users in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `username` | string | No | Email address to filter users by. Not supported in deprecated versions. |
| `flatten_teams` | boolean | No | Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If `"flattenTeams" : false`, this resource returns only users with a role in the project. If `"flattenTeams" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `include_org_users` | boolean | No | Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If `"includeOrgUsers": false`, this resource returns only users with a role in the project. If `"includeOrgUsers": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role. |
| `org_membership_status` | string | No | Deprecated: Use `orgMembershipStatuses` instead. Organization membership status to filter users by. Allowed values: `ACTIVE`, `PENDING`, `INVITATION_EXPIRED`, `INVITATION_REJECTED`. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Not supported in deprecated versions. |
| `org_membership_statuses` | array | No | Organization membership status to filter users by. You can supply this parameter multiple times. Allowed values: `ACTIVE`, `PENDING`, `INVITATION_EXPIRED`, `INVITATION_REJECTED`. Replaces the deprecated `orgMembershipStatus` parameter. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Cannot be combined with `orgMembershipStatus`. Not supported in deprecated versions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org Ai Model API Keys

**Slug:** `MONGODB_LIST_ORG_AI_MODEL_API_KEYS`

Return AI Model API Keys for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org API Key Access List Entries

**Slug:** `MONGODB_LIST_ORG_API_KEY_ACCESS_LIST_ENTRIES`

Return a Page of Access List Entries for One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `api_user_id` | string | Yes | Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org API Keys

**Slug:** `MONGODB_LIST_ORG_API_KEYS`

Return a Page of Organization API Keys. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org Events

**Slug:** `MONGODB_LIST_ORG_EVENTS`

Return Events from One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor returned by the previous page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `max_date` | string | No | Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC. |
| `min_date` | string | No | Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC. |
| `event_type` | array | No | Category of incident recorded at this moment in time. **IMPORTANT**: The complete list of event type values changes frequently. |
| `include_raw` | boolean | No | Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org Invoice Pending

**Slug:** `MONGODB_LIST_ORG_INVOICE_PENDING`

Return All Pending Invoices for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org Invoice Reports

**Slug:** `MONGODB_LIST_ORG_INVOICE_REPORTS`

Return a Page of Invoice Reports for One Invoice. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `invoice_id` | string | Yes | Unique string that identifies the invoice to list reports for. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org Invoices

**Slug:** `MONGODB_LIST_ORG_INVOICES`

Return a Page of Invoices for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `sort_by` | string ("START_DATE" | "END_DATE") | No | Field used to sort the returned invoices by. Use in combination with `orderBy` parameter to control the order of the result. |
| `to_date` | string | No | Retrieve the invoices the `endDates` of which are smaller than or equal to the `toDate`. If omit, the invoices return will go further to latest `endDate`. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `order_by` | string ("desc" | "asc") | No | Field used to order the returned invoices by. Use in combination of `sortBy` parameter to control the order of the result. |
| `from_date` | string | No | Retrieve the invoices the `startDates` of which are greater than or equal to the `fromDate`. If omit, the invoices return will go back to earliest `startDate`. |
| `status_names` | array | No | Statuses of the invoice to be retrieved. Omit to return invoices of all statuses. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `view_linked_invoices` | boolean | No | Flag that indicates whether to return linked invoices in the `linkedInvoices` field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org Live Migration Available Projects

**Slug:** `MONGODB_LIST_ORG_LIVE_MIGRATION_AVAILABLE_PROJECTS`

Return All Projects Available for Migration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org Log Integrations

**Slug:** `MONGODB_LIST_ORG_LOG_INTEGRATIONS`

Return a Page of Organization Log Integrations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org MCP Configs

**Slug:** `MONGODB_LIST_ORG_MCP_CONFIGS`

Return a Page of MCP Configurations for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org MCP Config Secrets

**Slug:** `MONGODB_LIST_ORG_MCP_CONFIG_SECRETS`

Return a Page of Secrets for One Organization MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `mcp_config_id` | string | Yes | Unique identifier of the MCP configuration. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org Resource Policies

**Slug:** `MONGODB_LIST_ORG_RESOURCE_POLICIES`

Return All Atlas Resource Policies. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Orgs

**Slug:** `MONGODB_LIST_ORGS`

Return a Page of Organizations. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name. |
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org Sandbox Config

**Slug:** `MONGODB_LIST_ORG_SANDBOX_CONFIG`

Return Sandbox Configuration IDs for an Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Project Creator.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org Service Account Access List

**Slug:** `MONGODB_LIST_ORG_SERVICE_ACCOUNT_ACCESS_LIST`

Return a Page of Access List Entries for One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `client_id` | string | Yes | The Client ID of the Service Account. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org Service Accounts

**Slug:** `MONGODB_LIST_ORG_SERVICE_ACCOUNTS`

Return a Page of Organization Service Accounts. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `include_system_managed` | boolean | No | Flag that indicates whether system-managed Service Accounts (such as those used for MCP ingress/egress integrations) are included in the response. When false, only user-managed Service Accounts are returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org Teams

**Slug:** `MONGODB_LIST_ORG_TEAMS`

Return a Page of Teams in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org Team Users

**Slug:** `MONGODB_LIST_ORG_TEAM_USERS`

Return a Page of MongoDB Cloud Users Assigned to One Team. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `team_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the team whose application users you want to return. |
| `user_id` | string | No | Unique 24-hexadecimal digit string to filter users by. Not supported in deprecated versions. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `username` | string | No | Email address to filter users by. Not supported in deprecated versions. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `org_membership_status` | string | No | Deprecated: Use `orgMembershipStatuses` instead. Organization membership status to filter users by. Allowed values: `ACTIVE`, `PENDING`, `INVITATION_EXPIRED`, `INVITATION_REJECTED`. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Not supported in deprecated versions. |
| `org_membership_statuses` | array | No | Organization membership status to filter users by. You can supply this parameter multiple times. Allowed values: `ACTIVE`, `PENDING`, `INVITATION_EXPIRED`, `INVITATION_REJECTED`. Replaces the deprecated `orgMembershipStatus` parameter. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Cannot be combined with `orgMembershipStatus`. Not supported in deprecated versions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Org Users

**Slug:** `MONGODB_LIST_ORG_USERS`

Return a Page of MongoDB Cloud Users in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `username` | string | No | Email address to filter users by. Not supported in deprecated versions. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `org_membership_status` | string | No | Deprecated: Use `orgMembershipStatuses` instead. Organization membership status to filter users by. Allowed values: `ACTIVE`, `PENDING`, `INVITATION_EXPIRED`, `INVITATION_REJECTED`. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Not supported in deprecated versions. |
| `org_membership_statuses` | array | No | Organization membership status to filter users by. You can supply this parameter multiple times. Allowed values: `ACTIVE`, `PENDING`, `INVITATION_EXPIRED`, `INVITATION_REJECTED`. Replaces the deprecated `orgMembershipStatus` parameter. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Cannot be combined with `orgMembershipStatus`. Not supported in deprecated versions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Rate Limits

**Slug:** `MONGODB_LIST_RATE_LIMITS`

Return a Page of Rate Limits. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Filters the returned endpoint sets by the provided endpoint set name. Multiple names may be provided, for example `/rateLimits?name=Name1&name=Name2`. For names that use spaces, replace the space with its URL-encoded value (`%20`). |
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | No | Unique 24-hexadecimal digit string that identifies the Atlas Organization to request rate limits for. When this parameter is provided, only organization scoped endpoint sets are returned and the limits returned are applicable to the specified organization. The requesting user must have the Organization Read Only role for the specified organization. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `user_id` | string | No | A string that identifies the Atlas user to request rate limits for. The ID can for example be the Service Account Client ID or the API Public Key. When this parameter is provided, only user scoped endpoint sets are returned and the limits returned are applicable to the specified user. The requesting user must be the same as the specified user. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | No | Unique 24-hexadecimal digit string that identifies the Atlas Project to request rate limits for. When this parameter is provided, only group scoped endpoint sets are returned and the limits returned are applicable to the specified project. The requesting user must have the Project Read Only role for the specified project. |
| `ip_address` | string | No | An IP address to request rate limits for. When this parameter is provided, only IP scoped endpoint sets are returned and the limits returned are applicable to the specified IP address. The requesting user must have the same IP address as the one provided in the request. |
| `endpoint_path` | string | No | Filters the returned endpoint sets by the provided endpoint path. Multiple paths may be provided, for example `/rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters&endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F`. Replace `/`, `{` and `}` with their URL-encoded values (`%2F`, `%7B` and `%7D` respectively). |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Skus

**Slug:** `MONGODB_LIST_SKUS`

Return a Page of Stock Keeping Units. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member, Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Migrate Group

**Slug:** `MONGODB_MIGRATE_GROUP`

Migrate One Project to Another Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Migrates a project from its current organization to another organization. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pin Group Cluster Coll Stat Pinned Namespaces

**Slug:** `MONGODB_PIN_GROUP_CLUSTER_COLL_STAT_PINNED_NAMESPACES`

Pin Namespaces. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster to pin namespaces to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pin Group Cluster Feature Compatibility Version

**Slug:** `MONGODB_PIN_GROUP_CLUSTER_FEATURE_COMPATIBILITY_VERSION`

Pin Feature Compatibility Version for One Cluster in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | No | Documented request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies this cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reject Group Stream Vpc Peering Connection

**Slug:** `MONGODB_REJECT_GROUP_STREAM_VPC_PEERING_CONNECTION`

Reject One Incoming VPC Peering Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The VPC Peering Connection id. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Federation Setting Connected Org Config

**Slug:** `MONGODB_REMOVE_FEDERATION_SETTING_CONNECTED_ORG_CONFIG`

Remove One Organization Configuration from One Federation. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Group API Key

**Slug:** `MONGODB_REMOVE_GROUP_API_KEY`

Unassign One Organization API Key from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `api_user_id` | string | Yes | Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Group Team

**Slug:** `MONGODB_REMOVE_GROUP_TEAM`

Remove One Team from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Group User

**Slug:** `MONGODB_REMOVE_GROUP_USER`

Remove One MongoDB Cloud User from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `user_id` | string | Yes | 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](#tag/MongoDB-Cloud-Users/operation/listProjectUsers) resource and filter by `username`. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Group User Role

**Slug:** `MONGODB_REMOVE_GROUP_USER_ROLE`

Remove One Project Role from One MongoDB Cloud User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `user_id` | string | Yes | 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`. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Org Team User

**Slug:** `MONGODB_REMOVE_ORG_TEAM_USER`

Remove One MongoDB Cloud User from One Team. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `team_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the team to remove the MongoDB user from. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Org User

**Slug:** `MONGODB_REMOVE_ORG_USER`

Remove One MongoDB Cloud User from One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `user_id` | string | Yes | 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](#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers) resource and filter by `username`. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Org User Role

**Slug:** `MONGODB_REMOVE_ORG_USER_ROLE`

Remove One Organization Role from One MongoDB Cloud User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `user_id` | string | Yes | 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`. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rename Org Team

**Slug:** `MONGODB_RENAME_ORG_TEAM`

Rename One Team. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `team_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the team that you want to rename. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Request Group Encryption At Rest Private Endpoint Deletion

**Slug:** `MONGODB_REQUEST_GROUP_ENCRYPTION_AT_REST_PRIVATE_ENDPOINT_DELETION`

Delete One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `endpoint_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the private endpoint to delete. |
| `cloud_provider` | string ("AZURE" | "AWS") | Yes | Human-readable label that identifies the cloud provider of the private endpoint to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Request Group Sample Dataset Load

**Slug:** `MONGODB_REQUEST_GROUP_SAMPLE_DATASET_LOAD`

Load Sample Dataset into One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable label that identifies the cluster into which you load the sample dataset. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reset Group Ai Model API Cloud Geography Model Group Name Rate Limits

**Slug:** `MONGODB_RESET_GROUP_AI_MODEL_API_CLOUD_GEOGRAPHY_MODEL_GROUP_NAME_RATE_LIMITS`

Reset AI Model Rate Limit for One Model Group. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Model Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cloud` | string | Yes | Cloud provider scope. Must be "ANY". Additional values will be supported in future API versions. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `geography` | string | Yes | Geography scope. Must be "ANY". Additional values will be supported in future API versions. |
| `model_group_name` | string | Yes | The name of the model group to be reset to default rate limits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reset Group Ai Model API Rate Limits

**Slug:** `MONGODB_RESET_GROUP_AI_MODEL_API_RATE_LIMITS`

Reset AI Model Rate Limits for Group. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Model Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reset Group Maintenance Window

**Slug:** `MONGODB_RESET_GROUP_MAINTENANCE_WINDOW`

Reset One Maintenance Window for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reset Org Maintenance Settings

**Slug:** `MONGODB_RESET_ORG_MAINTENANCE_SETTINGS`

Reset Maintenance Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restart Group Cluster Primaries

**Slug:** `MONGODB_RESTART_GROUP_CLUSTER_PRIMARIES`

Test Failover for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke Federation Setting Identity Provider Jwks

**Slug:** `MONGODB_REVOKE_FEDERATION_SETTING_IDENTITY_PROVIDER_JWKS`

Revoke JWKS from One OIDC Identity Provider. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `identity_provider_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the identity provider to connect. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke Group Cluster Mongo Db Employee Access

**Slug:** `MONGODB_REVOKE_GROUP_CLUSTER_MONGO_DB_EMPLOYEE_ACCESS`

Revoke MongoDB Employee Cluster Access for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Support Access Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies this cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Org Invoice Line Items

**Slug:** `MONGODB_SEARCH_ORG_INVOICE_LINE_ITEMS`

Return a Page of Line Items for One Invoice by Invoice ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body for an Invoice Usage Details query with filtering, pagination, and sort. |
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `org_id` | string | Yes | 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. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `invoice_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Group Data Federation Limit

**Slug:** `MONGODB_SET_GROUP_DATA_FEDERATION_LIMIT`

Configure One Query Limit for One Federated Database Instance. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Details of a tenant-level query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `limit_name` | string ("bytesProcessed.query" | "bytesProcessed.daily" | "bytesProcessed.weekly" | "bytesProcessed.monthly") | Yes | Human-readable label that identifies this data federation instance limit. &#124; Limit Name &#124; Description &#124; Default &#124; &#124; --- &#124; --- &#124; --- &#124; &#124; `bytesProcessed.query` &#124; Limit on the number of bytes processed during a single data federation query &#124; N/A &#124; &#124; `bytesProcessed.daily` &#124; Limit on the number of bytes processed for the data federation instance for the current day &#124; N/A &#124; &#124; `bytesProcessed.weekly` &#124; Limit on the number of bytes processed for the data federation instance for the current week &#124; N/A &#124; &#124; `bytesProcessed.monthly` &#124; Limit on the number of bytes processed for the data federation instance for the current month &#124; N/A &#124;. |
| `tenant_name` | string | Yes | Human-readable label that identifies the federated database instance to which the query limit applies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Group Limit

**Slug:** `MONGODB_SET_GROUP_LIMIT`

Set One Project Limit. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Limit to update. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `limit_name` | string ("atlas.project.security.databaseAccess.users" | "atlas.project.deployment.clusters" | "atlas.project.deployment.serverlessMTMs" | "atlas.project.security.databaseAccess.customRoles" | "atlas.project.security.networkAccess.entries" | "atlas.project.security.networkAccess.crossRegionEntries" | "atlas.project.deployment.nodesPerPrivateLinkRegion" | "dataFederation.bytesProcessed.query" | "dataFederation.bytesProcessed.daily" | "dataFederation.bytesProcessed.weekly" | "dataFederation.bytesProcessed.monthly" | "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" | "atlas.project.deployment.privateServiceConnectionsSubnetMask") | Yes | Human-readable label that identifies this project limit. &#124; Limit Name &#124; Description &#124; Default &#124; API Override Limit &#124; &#124; --- &#124; --- &#124; --- &#124; --- &#124; &#124; `atlas.project.deployment.clusters` &#124; Limit on the number of clusters in this project &#124; 25 &#124; 100 &#124; &#124; `atlas.project.deployment.nodesPerPrivateLinkRegion` &#124; Limit on AWS PrivateLink addressable target nodes per region in this project. For sharded clusters using optimized (load-balanced) connection strings, `currentUsage` doesn't grow with the number of `mongos` — the load balancer is counted as a single addressable target regardless of how many `mongos` sit behind it. &#124; 50 &#124; 90 &#124; &#124; `atlas.project.security.databaseAccess.customRoles` &#124; Limit on the number of custom roles in this project &#124; 100 &#124; 1400 &#124; &#124; `atlas.project.security.databaseAccess.users` &#124; Limit on the number of database users in this project &#124; 100 &#124; 900 &#124; &#124; `atlas.project.security.networkAccess.crossRegionEntries` &#124; Limit on the number of cross-region network access entries in this project &#124; 40 &#124; 220 &#124; &#124; `atlas.project.security.networkAccess.entries` &#124; Limit on the number of network access entries in this project &#124; 200 &#124; 20 &#124; &#124; `dataFederation.bytesProcessed.query` &#124; Limit on the number of bytes processed during a single Data Federation query &#124; N/A &#124; N/A &#124; &#124; `dataFederation.bytesProcessed.daily` &#124; Limit on the number of bytes processed across all Data Federation tenants for the current day &#124; N/A &#124; N/A &#124; &#124; `dataFederation.bytesProcessed.weekly` &#124; Limit on the number of bytes processed across all Data Federation tenants for the current week &#124; N/A &#124; N/A &#124; &#124; `dataFederation.bytesProcessed.monthly` &#124; Limit on the number of bytes processed across all Data Federation tenants for the current month &#124; N/A &#124; N/A &#124; &#124; `atlas.project.deployment.privateServiceConnectionsPerRegionGroup` &#124; Number of Private Service Connections per Region Group &#124; 50 &#124; 100&#124; &#124; `atlas.project.deployment.privateServiceConnectionsSubnetMask` &#124; Subnet mask for GCP PSC Networks. Has lower limit of 20. &#124; 27 &#124; 27&#124;. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Group Cluster Outage Simulation

**Slug:** `MONGODB_START_GROUP_CLUSTER_OUTAGE_SIMULATION`

Start One Outage Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager, Project Cluster Resilience Tester, Project Replica Set Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster to undergo an outage simulation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Group Stream Processor

**Slug:** `MONGODB_START_GROUP_STREAM_PROCESSOR`

Start One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |
| `processor_name` | string | Yes | Label that identifies the stream processor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Group Stream Processor With

**Slug:** `MONGODB_START_GROUP_STREAM_PROCESSOR_WITH`

Start One Stream Processor With Options. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | No | A request to start a stream processor. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |
| `processor_name` | string | Yes | Label that identifies the stream processor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stop Group Stream Processor

**Slug:** `MONGODB_STOP_GROUP_STREAM_PROCESSOR`

Stop One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |
| `processor_name` | string | Yes | Label that identifies the stream processor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Take Group Cluster Backup Snapshots

**Slug:** `MONGODB_TAKE_GROUP_CLUSTER_BACKUP_SNAPSHOTS`

Take One On-Demand Snapshot. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Creator

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Takes one on-demand snapshot. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tenant Group Flex Cluster Upgrade

**Slug:** `MONGODB_TENANT_GROUP_FLEX_CLUSTER_UPGRADE`

Upgrade One Flex Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Toggle Group Alert Config

**Slug:** `MONGODB_TOGGLE_GROUP_ALERT_CONFIG`

Toggle State of One Alert Configuration in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Alerts Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `alert_config_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Toggle Group AWS Custom DNS

**Slug:** `MONGODB_TOGGLE_GROUP_AWS_CUSTOM_DNS`

Update State of One Custom DNS Configuration for Atlas Clusters on AWS. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Toggle Group Maintenance Window Auto Defer

**Slug:** `MONGODB_TOGGLE_GROUP_MAINTENANCE_WINDOW_AUTO_DEFER`

Toggle Automatic Deferral of Maintenance for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Toggle Group Private Endpoint Regional Mode

**Slug:** `MONGODB_TOGGLE_GROUP_PRIVATE_ENDPOINT_REGIONAL_MODE`

Toggle Regionalized Private Endpoint Status. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unpin Group Cluster Coll Stat Unpin Namespaces

**Slug:** `MONGODB_UNPIN_GROUP_CLUSTER_COLL_STAT_UNPIN_NAMESPACES`

Unpin Namespaces. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster to unpin namespaces from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unpin Group Cluster Feature Compatibility Version

**Slug:** `MONGODB_UNPIN_GROUP_CLUSTER_FEATURE_COMPATIBILITY_VERSION`

Unpin Feature Compatibility Version for One Cluster in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies this cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Federation Setting Connected Org Config

**Slug:** `MONGODB_UPDATE_FEDERATION_SETTING_CONNECTED_ORG_CONFIG`

Update One Organization Configuration in One Federation. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The connected organization configuration that you want to update. |
| `org_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the connected organization configuration to update. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Federation Setting Connected Org Config Role Mapping

**Slug:** `MONGODB_UPDATE_FEDERATION_SETTING_CONNECTED_ORG_CONFIG_ROLE_MAPPING`

Update One Role Mapping in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique 24-hexadecimal digit string that identifies the role mapping that you want to update. |
| `body` | object | Yes | The role mapping that you want to update. |
| `org_id` | string | Yes | 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. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Federation Setting Identity Provider

**Slug:** `MONGODB_UPDATE_FEDERATION_SETTING_IDENTITY_PROVIDER`

Update One Identity Provider. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | The identity provider that you want to update. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `identity_provider_id` | string | Yes | Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. 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. For all other versions, use the 24-hexadecimal digit id. |
| `federation_settings_id` | string | Yes | Unique 24-hexadecimal digit string that identifies your federation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group

**Slug:** `MONGODB_UPDATE_GROUP`

Update One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Project to update. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Ai Model API Cloud Geography Model Group Name Rate Limits

**Slug:** `MONGODB_UPDATE_GROUP_AI_MODEL_API_CLOUD_GEOGRAPHY_MODEL_GROUP_NAME_RATE_LIMITS`

Update AI Model Rate Limit. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Model Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | A request containing the new rate limits for the given model group. |
| `cloud` | string | Yes | Cloud provider scope. Must be "ANY". Additional values will be supported in future API versions. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `geography` | string | Yes | Geography scope. Must be "ANY". Additional values will be supported in future API versions. |
| `model_group_name` | string | Yes | The name of the model group to be updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Ai Model API Key

**Slug:** `MONGODB_UPDATE_GROUP_AI_MODEL_API_KEY`

Update Existing AI Model API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Model Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `api_key_id` | string | Yes | The id of the API key to be updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Alert Config

**Slug:** `MONGODB_UPDATE_GROUP_ALERT_CONFIG`

Update One Alert Configuration in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Alerts Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Documented request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `alert_config_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the alert configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group API Key Roles

**Slug:** `MONGODB_UPDATE_GROUP_API_KEY_ROLES`

Update Organization API Key Roles for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `api_user_id` | string | Yes | Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Audit Log

**Slug:** `MONGODB_UPDATE_GROUP_AUDIT_LOG`

Update Auditing Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Backup Compliance Policy

**Slug:** `MONGODB_UPDATE_GROUP_BACKUP_COMPLIANCE_POLICY`

Update Backup Compliance Policy Settings. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The new Backup Compliance Policy settings. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `overwrite_backup_policies` | boolean | No | Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Backup Export Bucket

**Slug:** `MONGODB_UPDATE_GROUP_BACKUP_EXPORT_BUCKET`

Update One Export Bucket Private Networking Settings. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Updates the private networking requirement for the snapshot export bucket. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `export_bucket_id` | string | Yes | Unique 24-hexadecimal character string that identifies the snapshot export bucket. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Cluster

**Slug:** `MONGODB_UPDATE_GROUP_CLUSTER`

Update One Cluster in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager, Project Cluster Resilience Tester, Project Replica Set Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `use_effective_instance_fields` | boolean | No | Controls how hardware specification fields are returned in the response after cluster updates. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Note: When using this header with autoscaling enabled, MongoDB ignores `replicationSpecs` changes during updates. To intentionally override the `replicationSpecs`, disable this header. |
| `use_effective_fields_replication_specs` | boolean | No | Controls how `replicationSpecs` fields are returned in the response. When set to `true`, stores the client's view of `replicationSpecs` and returns it in `replicationSpecs`, while the actual cluster state (including auto-scaled hardware and auto-added shards) is returned in `effectiveReplicationSpecs`. When `false` (default), `replicationSpecs` contains the actual cluster state. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Cluster Adaptive Settings

**Slug:** `MONGODB_UPDATE_GROUP_CLUSTER_ADAPTIVE_SETTINGS`

Update Adaptive Settings for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Cluster Backup Schedule

**Slug:** `MONGODB_UPDATE_GROUP_CLUSTER_BACKUP_SCHEDULE`

Update Cloud Backup Schedule for One Cluster. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Cluster Backup Snapshot

**Slug:** `MONGODB_UPDATE_GROUP_CLUSTER_BACKUP_SNAPSHOT`

Update Expiration Date for One Cloud Backup. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `snapshot_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Cluster Coll Stat Pinned Namespaces

**Slug:** `MONGODB_UPDATE_GROUP_CLUSTER_COLL_STAT_PINNED_NAMESPACES`

Add Pinned Namespaces. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster to pin namespaces to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Cluster Online Archive

**Slug:** `MONGODB_UPDATE_GROUP_CLUSTER_ONLINE_ARCHIVE`

Update One Online Archive. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `archive_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the online archive to update. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Cluster Process Args

**Slug:** `MONGODB_UPDATE_GROUP_CLUSTER_PROCESS_ARGS`

Update Advanced Configuration Options for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Cluster Query Shape

**Slug:** `MONGODB_UPDATE_GROUP_CLUSTER_QUERY_SHAPE`

Update Query Shape Rejection Status. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin, Project Real Time Performance Operator

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body for modifying the rejection status of a query shape. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |
| `query_shape_hash` | string | Yes | A SHA256 hash of a query shape, output by MongoDB commands like `$queryStats` and `$explain` or slow query logs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Cluster Search Deployment

**Slug:** `MONGODB_UPDATE_GROUP_CLUSTER_SEARCH_DEPLOYMENT`

Update Search Nodes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Label that identifies the cluster to update the Search Nodes for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Cluster Search Index

**Slug:** `MONGODB_UPDATE_GROUP_CLUSTER_SEARCH_INDEX`

Update One Atlas Search Index by ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Search Index Editor

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `index_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes. |
| `cluster_name` | string | Yes | Name of the cluster that contains the collection whose Atlas Search index you want to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Cluster Search Index By Name

**Slug:** `MONGODB_UPDATE_GROUP_CLUSTER_SEARCH_INDEX_BY_NAME`

Update One Atlas Search Index by Name. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Search Index Editor

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `index_name` | string | Yes | Name of the Atlas Search index to update. |
| `cluster_name` | string | Yes | Name of the cluster that contains the collection whose Atlas Search index you want to update. |
| `database_name` | string | Yes | Label that identifies the database that contains the collection with one or more Atlas Search indexes. |
| `collection_name` | string | Yes | Name of the collection that contains one or more Atlas Search indexes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Cluster SQL Interface

**Slug:** `MONGODB_UPDATE_GROUP_CLUSTER_SQL_INTERFACE`

Update SQL Interface Status. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager, Project Replica Set Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `cluster_name` | string | Yes | Human-readable label that identifies the cluster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Container

**Slug:** `MONGODB_UPDATE_GROUP_CONTAINER`

Update One Network Peering Container. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `container_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Custom Db Role Role

**Slug:** `MONGODB_UPDATE_GROUP_CUSTOM_DB_ROLE_ROLE`

Update One Custom Role in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Database Access Admin, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `role_name` | string | Yes | Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Database User

**Slug:** `MONGODB_UPDATE_GROUP_DATABASE_USER`

Update One Database User in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Database Access Admin, Project Stream Processing Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `username` | string | Yes | Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: &#124; Authentication Method &#124; Parameter Needed &#124; Parameter Value &#124; username Format &#124; &#124;---&#124;---&#124;---&#124;---&#124; &#124; AWS IAM &#124; `awsIAMType` &#124; `ROLE` &#124; <abbr title="Amazon Resource Name">ARN</abbr> &#124; &#124; AWS IAM &#124; `awsIAMType` &#124; `USER` &#124; <abbr title="Amazon Resource Name">ARN</abbr> &#124; &#124; x.509 &#124; `x509Type` &#124; `CUSTOMER` &#124; [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name &#124; &#124; x.509 &#124; `x509Type` &#124; `MANAGED` &#124; [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name &#124; &#124; LDAP &#124; `ldapAuthType` &#124; `USER` &#124; [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name &#124; &#124; LDAP &#124; `ldapAuthType` &#124; `GROUP` &#124; [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name &#124; &#124; OIDC Workforce &#124; `oidcAuthType` &#124; `IDP_GROUP` &#124; Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name &#124; &#124; OIDC Workload &#124; `oidcAuthType` &#124; `USER` &#124; Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name &#124; &#124; SCRAM-SHA &#124; `awsIAMType`, `x509Type`, `ldapAuthType`, `oidcAuthType` &#124; `NONE` &#124; Alphanumeric string &#124;. |
| `database_name` | string | Yes | The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS 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`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Data Federation

**Slug:** `MONGODB_UPDATE_GROUP_DATA_FEDERATION`

Update One Federated Database Instance in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Human-readable label that identifies the federated database instance to update. |
| `skip_role_validation` | boolean | Yes | Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Encryption At Rest

**Slug:** `MONGODB_UPDATE_GROUP_ENCRYPTION_AT_REST`

Update Encryption at Rest Configuration in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Flex Cluster

**Slug:** `MONGODB_UPDATE_GROUP_FLEX_CLUSTER`

Update One Flex Cluster in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Settings that you can specify when you update a flex cluster. |
| `name` | string | Yes | Human-readable label that identifies the flex cluster. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Integration

**Slug:** `MONGODB_UPDATE_GROUP_INTEGRATION`

Update One Third-Party Service Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Collection of settings that describe third-party integrations. |
| `cursor` | string | No | Opaque continuation cursor from the preceding page; omit for the first page. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `include_count` | boolean | No | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may skip an additional count operation. The response may still include `totalCount` when the count is available without additional calculation. |
| `items_per_page` | integer | No | Number of items that the response returns per page. |
| `integration_type` | string ("PAGER_DUTY" | "SLACK" | "DATADOG" | "NEW_RELIC" | "OPS_GENIE" | "VICTOR_OPS" | "WEBHOOK" | "HIP_CHAT" | "PROMETHEUS" | "MICROSOFT_TEAMS") | Yes | Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Log Integration

**Slug:** `MONGODB_UPDATE_GROUP_LOG_INTEGRATION`

Update One Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the log integration configuration. |
| `body` | string | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Maintenance Window

**Slug:** `MONGODB_UPDATE_GROUP_MAINTENANCE_WINDOW`

Update One Maintenance Window for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group MCP Config

**Slug:** `MONGODB_UPDATE_GROUP_MCP_CONFIG`

Update One MCP Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `group_id` | string | Yes | 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. |
| `mcp_config_id` | string | Yes | Unique identifier of the MCP configuration to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Metric Integration

**Slug:** `MONGODB_UPDATE_GROUP_METRIC_INTEGRATION`

Update One Metric Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Updated metric integration configuration. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `metric_integration_id` | string | Yes | Unique identifier of the metric integration configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Peer

**Slug:** `MONGODB_UPDATE_GROUP_PEER`

Update One Network Peering Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Network Access Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `peer_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Private Endpoint Endpoint Service

**Slug:** `MONGODB_UPDATE_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICE`

Update One Private Endpoint Service for One Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Updates to apply to the private endpoint service. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `endpoint_service_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Service Account

**Slug:** `MONGODB_UPDATE_GROUP_SERVICE_ACCOUNT`

Update One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The new details for the Service Account. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `client_id` | string | Yes | The Client ID of the Service Account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Settings

**Slug:** `MONGODB_UPDATE_GROUP_SETTINGS`

Update Project Settings. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Stream Connection

**Slug:** `MONGODB_UPDATE_GROUP_STREAM_CONNECTION`

Update One Stream Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Settings that define a connection to an external data store. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |
| `connection_name` | string | Yes | Label that identifies the stream connection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Stream Connection Failover Connection

**Slug:** `MONGODB_UPDATE_GROUP_STREAM_CONNECTION_FAILOVER_CONNECTION`

Update One Stream Failover Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |
| `connection_name` | string | Yes | Label that identifies the stream connection. |
| `failover_connection_id` | string | Yes | Label that identifies the stream failover connection id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Stream Private Link Connection

**Slug:** `MONGODB_UPDATE_GROUP_STREAM_PRIVATE_LINK_CONNECTION`

Update One Private Link Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body for updating a Private Link connection. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `connection_id` | string | Yes | Unique ID that identifies the Private Link connection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Stream Processor

**Slug:** `MONGODB_UPDATE_GROUP_STREAM_PROCESSOR`

Update One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | A request to modify an existing stream processor. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace. |
| `processor_name` | string | Yes | Label that identifies the stream processor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Stream Workspace

**Slug:** `MONGODB_UPDATE_GROUP_STREAM_WORKSPACE`

Update One Stream Workspace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Details to update a stream tenant, optionally accompanied by a processor status change (for example, triggering bulk regional failover). |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |
| `tenant_name` | string | Yes | Label that identifies the stream workspace to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Team

**Slug:** `MONGODB_UPDATE_GROUP_TEAM`

Update Team Roles in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `team_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the team for which you want to update roles. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group User Security

**Slug:** `MONGODB_UPDATE_GROUP_USER_SECURITY`

Update LDAP or X.509 Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Org

**Slug:** `MONGODB_UPDATE_ORG`

Update One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Details that describe the organization. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Org API Key

**Slug:** `MONGODB_UPDATE_ORG_API_KEY`

Update One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `api_user_id` | string | Yes | Unique 24-hexadecimal digit string that identifies this organization API key you want to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Org Delegation Settings

**Slug:** `MONGODB_UPDATE_ORG_DELEGATION_SETTINGS`

Update Delegation Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Org Log Integration

**Slug:** `MONGODB_UPDATE_ORG_LOG_INTEGRATION`

Update One Organization Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `log_integration_id` | string | Yes | Unique identifier of the log integration configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Org Maintenance Settings

**Slug:** `MONGODB_UPDATE_ORG_MAINTENANCE_SETTINGS`

Update Maintenance Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Org MCP Config

**Slug:** `MONGODB_UPDATE_ORG_MCP_CONFIG`

Update One MCP Configuration for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `mcp_config_id` | string | Yes | Unique identifier of the MCP configuration to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Org Resource Policy

**Slug:** `MONGODB_UPDATE_ORG_RESOURCE_POLICY`

Update One Atlas Resource Policy. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `resource_policy_id` | string | Yes | Unique 24-hexadecimal digit string that identifies an atlas resource policy. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Org Sandbox Config

**Slug:** `MONGODB_UPDATE_ORG_SANDBOX_CONFIG`

Update an Existing Sandbox Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Settings to update the sandbox configuration for an organization. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `sandbox_config_id` | string | Yes | Unique 24-hexadecimal digit string that identifies the sandbox configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Org Service Account

**Slug:** `MONGODB_UPDATE_ORG_SERVICE_ACCOUNT`

Update One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The new details for the Service Account. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `client_id` | string | Yes | The Client ID of the Service Account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Org Settings

**Slug:** `MONGODB_UPDATE_ORG_SETTINGS`

Update Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Collection of settings that configures the organization. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Org User

**Slug:** `MONGODB_UPDATE_ORG_USER`

Update One MongoDB Cloud User in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `user_id` | string | Yes | 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`. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upgrade Group Cluster Tenant Upgrade

**Slug:** `MONGODB_UPGRADE_GROUP_CLUSTER_TENANT_UPGRADE`

Upgrade One Shared-Tier Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Group Live Migrations

**Slug:** `MONGODB_VALIDATE_GROUP_LIVE_MIGRATIONS`

Validate One Migration Request. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Org Resource Policies

**Slug:** `MONGODB_VALIDATE_ORG_RESOURCE_POLICIES`

Validate One Atlas Resource Policy. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `org_id` | string | Yes | 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. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify Group User Security LDAP

**Slug:** `MONGODB_VERIFY_GROUP_USER_SECURITY_LDAP`

Verify LDAP Configuration in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request information needed to verify an Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response does not return the `bindPassword`. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### With Group Stream Sample Connections

**Slug:** `MONGODB_WITH_GROUP_STREAM_SAMPLE_CONNECTIONS`

Create One Stream Workspace with Sample Connections. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Stream Processing Manager

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Operation-specific request body. |
| `pretty` | boolean | No | Flag that indicates whether the response body should be in the prettyprint format. |
| `envelope` | boolean | No | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
| `group_id` | string | Yes | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |