# MongoDB Atlas Administration API API > MongoDB Atlas Administration API API on Apizie: 400 endpoints (Return the Status of This MongoDB Application, Return All Alert Configuration Matchers Field Names, Return All Authorized Clusters in All Projects, Return Descriptions of User-Configurable Project Limits, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:mongodb-atlas/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:mongodb-atlas` - Category: Cloud - Status: byok - Source: https://mongodb.com - Page: https://apizie.tech/api/cloud/mongodb-atlas - OpenAPI: https://apizie.tech/api/cloud/mongodb-atlas/openapi.json The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas. The Atlas Administration API supports OAuth2 Service Accounts and HTTP Digest-based API keys. Service accounts are the… ## Endpoints ### Return the Status of This MongoDB Application `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-system-status` (byok) | 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Return All Alert Configuration Matchers Field Names `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-alert-config-matcher-field-names` (byok) | 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Return All Authorized Clusters in All Projects `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-cluster-details` (byok) | 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… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Return Descriptions of User-Configurable Project Limits `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-default-group-limits` (byok) | 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… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Return One User-Configurable Project Limit and Description `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-default-group-limit` (byok) | 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | limitName | string | yes | Identifies the user-managed limit. | ### Return All Event Types `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-event-types` (byok) | 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… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Delete One Federation Settings Instance `POST https://apizie.tech/v1/cloud:mongodb-atlas/delete-federation-setting` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | ### Return All Organization Configurations from One Federation `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-federation-setting-connected-org-configs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | ### Return One Organization Configuration from One Federation `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-federation-setting-connected-org-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | orgId | string | yes | Unique 24-hexadecimal digit string that identifies the connected organization configuration to return. | ### Update One Organization Configuration in One Federation `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-federation-setting-connected-org-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | orgId | string | yes | Unique 24-hexadecimal digit string that identifies the connected organization configuration to update. | | body | object | yes | JSON request body | ### Remove One Organization Configuration from One Federation `POST https://apizie.tech/v1/cloud:mongodb-atlas/remove-federation-setting-connected-org-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | orgId | string | yes | Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove. | ### Return All Role Mappings from One Organization `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-federation-setting-connected-org-config-role-mappings` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | orgId | string | yes | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the… | ### Create One Role Mapping in One Organization Configuration `POST https://apizie.tech/v1/cloud:mongodb-atlas/create-federation-setting-connected-org-config-role-mapping` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | orgId | string | yes | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the… | | body | object | yes | JSON request body | ### Return One Role Mapping from One Organization `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-federation-setting-connected-org-config-role-mapping` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | id | string | yes | Unique 24-hexadecimal digit string that identifies the role mapping that 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… | | orgId | string | yes | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the… | ### Update One Role Mapping in One Organization `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-federation-setting-connected-org-config-role-mapping` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | id | string | yes | Unique 24-hexadecimal digit string that identifies the role mapping 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… | | orgId | string | yes | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the… | | body | object | yes | JSON request body | ### Remove One Role Mapping from One Organization `POST https://apizie.tech/v1/cloud:mongodb-atlas/delete-federation-setting-connected-org-config-role-mapping` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | id | string | yes | Unique 24-hexadecimal digit string that identifies the role mapping that you want 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… | | orgId | string | yes | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the… | ### Return All Identity Providers in One Federation `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-federation-setting-identity-providers` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | protocol | array | no | The protocols of the target identity providers. | | idpType | array | no | The types of the target identity providers. | ### Create One Identity Provider `POST https://apizie.tech/v1/cloud:mongodb-atlas/create-federation-setting-identity-provider` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | body | object | yes | JSON request body | ### Return One Identity Provider by ID `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-federation-setting-identity-provider` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | identityProviderId | 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… | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | ### Update One Identity Provider `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-federation-setting-identity-provider` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | identityProviderId | 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… | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | body | object | yes | JSON request body | ### Delete One Identity Provider `POST https://apizie.tech/v1/cloud:mongodb-atlas/delete-federation-setting-identity-provider` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | identityProviderId | string | yes | Unique 24-hexadecimal digit string that identifies the identity provider to connect. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | ### Revoke JWKS from One OIDC Identity Provider `POST https://apizie.tech/v1/cloud:mongodb-atlas/revoke-federation-setting-identity-provider-jwks` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | identityProviderId | string | yes | Unique 24-hexadecimal digit string that identifies the identity provider to connect. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | ### Return Metadata of One Identity Provider `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-federation-setting-identity-provider-metadata` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | federationSettingsId | string | yes | Unique 24-hexadecimal digit string that identifies your federation. | | identityProviderId | string | yes | Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console >… | ### Return All Projects `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-groups` (byok) | 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… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Create One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/create-group` (byok) | 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | projectOwnerId | string | no | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified… | | body | object | yes | JSON request body | ### Return One Project by Name `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-by-name` (byok) | 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | groupName | string | yes | Human-readable label that identifies this project. | ### Return One Project `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Update One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-group` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | body | object | yes | JSON request body | ### Remove One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/delete-group` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Return All Project IP Access List Entries `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-access-list-entries` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Add Entries to Project IP Access List `POST https://apizie.tech/v1/cloud:mongodb-atlas/create-group-access-list-entry` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | body | object | yes | JSON request body | ### Return One Project IP Access List Entry `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-access-list-entry` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | entryValue | 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… | ### Remove One Entry from One Project IP Access List `POST https://apizie.tech/v1/cloud:mongodb-atlas/delete-group-access-list-entry` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | entryValue | 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… | ### Return Status of One Project IP Access List Entry `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-access-list-status` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | entryValue | string | yes | Network address or cloud provider security construct that identifies which project access list entry to be verified. | ### Return Pre-Filtered Activity Feed Link for One Project `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-activity-feed` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | eventType | array | no | Category of incident recorded at this moment in time. **IMPORTANT**: The complete list of event type values changes frequently. | | maxDate | string | no | End date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC. | | minDate | string | no | Start date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC. | | clusterName | array | no | Human-readable label that identifies the cluster. | ### Return Single AI Model Rate Limit for One Group `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-ai-model-api-cloud-geography-model-group-name-rate` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | cloud | string | yes | Cloud provider scope. Must be "ANY". Additional values will be supported in future API versions. | | geography | string | yes | Geography scope. Must be "ANY". Additional values will be supported in future API versions. | | modelGroupName | string | yes | The name of the model group to be retrieved. | ### Update AI Model Rate Limit `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-group-ai-model-api-cloud-geography-model-group-name-r` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | cloud | string | yes | Cloud provider scope. Must be "ANY". Additional values will be supported in future API versions. | | geography | string | yes | Geography scope. Must be "ANY". Additional values will be supported in future API versions. | | modelGroupName | string | yes | The name of the model group to be updated. | | body | object | yes | JSON request body | ### Reset AI Model Rate Limit for One Model Group `POST https://apizie.tech/v1/cloud:mongodb-atlas/reset-group-ai-model-api-cloud-geography-model-group-name-ra` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | cloud | string | yes | Cloud provider scope. Must be "ANY". Additional values will be supported in future API versions. | | geography | string | yes | Geography scope. Must be "ANY". Additional values will be supported in future API versions. | | modelGroupName | string | yes | The name of the model group to be reset to default rate limits. | ### Return AI Model API Keys for One Group `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-ai-model-api-keys` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Create New AI Model API Key `POST https://apizie.tech/v1/cloud:mongodb-atlas/create-group-ai-model-api-key` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | body | object | yes | JSON request body | ### Return Single AI Model API Key for One Group `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-ai-model-api-key` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | apiKeyId | string | yes | The id of the API key to be retrieved. | ### Update Existing AI Model API Key `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-group-ai-model-api-key` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | apiKeyId | string | yes | The id of the API key to be updated. | | body | object | yes | JSON request body | ### Delete Existing AI Model API Key `POST https://apizie.tech/v1/cloud:mongodb-atlas/delete-group-ai-model-api-key` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | apiKeyId | string | yes | The id of the API key to be deleted. | ### Return AI Model Rate Limits for One Group `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-ai-model-api-rate-limits` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Reset AI Model Rate Limits for Group `POST https://apizie.tech/v1/cloud:mongodb-atlas/reset-group-ai-model-api-rate-limits` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Return All Alert Configurations in One Project `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-alert-configs` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Create One Alert Configuration in One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/create-group-alert-config` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | body | object | yes | JSON request body | ### Return One Alert Configuration from One Project `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-alert-config` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | alertConfigId | string | yes | Unique 24-hexadecimal digit string that identifies the alert configuration. | ### Update One Alert Configuration in One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-group-alert-config` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | alertConfigId | string | yes | Unique 24-hexadecimal digit string that identifies the alert configuration. | | body | object | yes | JSON request body | ### Toggle State of One Alert Configuration in One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/toggle-group-alert-config` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | alertConfigId | string | yes | Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. | | body | object | yes | JSON request body | ### Remove One Alert Configuration from One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/delete-group-alert-config` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | alertConfigId | string | yes | Unique 24-hexadecimal digit string that identifies the alert configuration. | ### Return All Open Alerts for One Alert Configuration `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-alert-config-alerts` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | alertConfigId | string | yes | Unique 24-hexadecimal digit string that identifies the alert configuration. | ### Return All Alerts from One Project `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-alerts` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | status | string | no | Status of the alerts to return. Omit this parameter to return all alerts in all statuses. TRACKING indicates the alert condition exists… | ### Return One Alert from One Project `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-alert` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | alertId | string | yes | Unique 24-hexadecimal digit string that identifies the alert. | ### Acknowledge One Alert from One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/acknowledge-group-alert` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | alertId | string | yes | Unique 24-hexadecimal digit string that identifies the alert. | | body | object | yes | JSON request body | ### Return All Alert Configurations Set for One Alert `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-alert-alert-configs` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | alertId | string | yes | Unique 24-hexadecimal digit string that identifies the alert. | ### Return All Organization API Keys Assigned to One Project `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-api-keys` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Create and Assign One Organization API Key to One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/create-group-api-key` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | body | object | yes | JSON request body | ### Assign One Organization API Key to One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/add-group-api-key` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | apiUserId | string | yes | Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | body | object | yes | JSON request body | ### Update Organization API Key Roles for One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-group-api-key-roles` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | itemsPerPage | integer | no | Number of items that the response returns per page. | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | apiUserId | string | yes | Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project. | | body | object | yes | JSON request body | ### Unassign One Organization API Key from One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/remove-group-api-key` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | apiUserId | string | yes | Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Return Auditing Configuration for One Project `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-audit-log` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Update Auditing Configuration for One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-group-audit-log` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | body | object | yes | JSON request body | ### Return One Custom DNS Configuration for Atlas Clusters on AWS `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-aws-custom-dns` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Update State of One Custom DNS Configuration for Atlas Clusters on AWS `POST https://apizie.tech/v1/cloud:mongodb-atlas/toggle-group-aws-custom-dns` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | body | object | yes | JSON request body | ### Return All Snapshot Export Buckets `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-backup-export-buckets` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Create One Snapshot Export Bucket `POST https://apizie.tech/v1/cloud:mongodb-atlas/create-group-backup-export-bucket` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | body | object | yes | JSON request body | ### Return One Snapshot Export Bucket `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-backup-export-bucket` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | exportBucketId | string | yes | Unique 24-hexadecimal character string that identifies the Export Bucket. | ### Update One Export Bucket Private Networking Settings `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-group-backup-export-bucket` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | exportBucketId | string | yes | Unique 24-hexadecimal character string that identifies the snapshot export bucket. | | body | object | yes | JSON request body | ### Delete One Snapshot Export Bucket `POST https://apizie.tech/v1/cloud:mongodb-atlas/delete-group-backup-export-bucket` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | exportBucketId | string | yes | Unique 24-hexadecimal character string that identifies the Export Bucket. | ### Return Object Storage Private Endpoints for Cloud Backups for One Cloud Provider in One Project `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-backup-private-endpoints` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | cloudProvider | string | yes | Human-readable label that identifies the cloud provider for the private endpoints to return. | ### Create One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider in One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/create-group-backup-private-endpoint` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | cloudProvider | string | yes | Human-readable label that identifies the cloud provider for the private endpoint to create. | | body | object | yes | JSON request body | ### Return One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider in One Project `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-backup-private-endpoint` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | cloudProvider | string | yes | Human-readable label that identifies the cloud provider of the private endpoint. | | endpointId | string | yes | Unique 24-hexadecimal digit string that identifies the private endpoint. | ### Delete One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider from One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/delete-group-backup-private-endpoint` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | envelope | boolean | no | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response… | | cloudProvider | string | yes | Human-readable label that identifies the cloud provider of the private endpoint to delete. | | endpointId | string | yes | Unique 24-hexadecimal digit string that identifies the private endpoint to delete. | ### Return Backup Compliance Policy Settings `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-backup-compliance-policy` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Update Backup Compliance Policy Settings `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-group-backup-compliance-policy` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | overwriteBackupPolicies | boolean | no | Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | body | object | yes | JSON request body | ### Disable Backup Compliance Policy Settings `POST https://apizie.tech/v1/cloud:mongodb-atlas/disable-group-backup-compliance-policy` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Return All Cloud Provider Access Roles `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-cloud-provider-access` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | ### Create One Cloud Provider Access Role `POST https://apizie.tech/v1/cloud:mongodb-atlas/create-group-cloud-provider-access` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | body | object | yes | JSON request body | ### Deauthorize One Cloud Provider Access Role `POST https://apizie.tech/v1/cloud:mongodb-atlas/deauthorize-group-cloud-provider-access-role` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | cloudProvider | string | yes | Human-readable label that identifies the cloud provider of the role to deauthorize. | | roleId | string | yes | Unique 24-hexadecimal digit string that identifies the role. Amazon Web Services (AWS) IAM roles and Google Service Accounts return this… | ### Return One Cloud Provider Access Role `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-cloud-provider-access` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | roleId | string | yes | Unique 24-hexadecimal digit string that identifies the role. Amazon Web Services (AWS) IAM roles and Google Service Accounts return this… | ### Authorize One Cloud Provider Access Role `POST https://apizie.tech/v1/cloud:mongodb-atlas/authorize-group-cloud-provider-access-role` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | roleId | string | yes | Unique 24-hexadecimal digit string that identifies the role. Amazon Web Services (AWS) IAM roles and Google Service Accounts return this… | | body | object | yes | JSON request body | ### Return All Clusters in One Project `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-clusters` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | includeDeletedWithRetainedBackups | boolean | no | Flag that indicates whether to return Clusters with retain backups. | | 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… | ### Create One Cluster in One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/create-group-cluster` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | 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… | | 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`… | | body | object | yes | JSON request body | ### Return All Cloud Provider Regions `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-cluster-provider-regions` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | providers | array | no | Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that… | | tier | string | no | Cluster tier for which to retrieve the regions. | ### Upgrade One Shared-Tier Cluster `POST https://apizie.tech/v1/cloud:mongodb-atlas/upgrade-group-cluster-tenant-upgrade` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | body | object | yes | JSON request body | ### Return One Cluster from One Project `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-cluster` (byok) | 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | clusterName | 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… | | 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`… | ### Update One Cluster in One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-group-cluster` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | 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… | | 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`… | | body | object | yes | JSON request body | ### Remove One Cluster from One Project `POST https://apizie.tech/v1/cloud:mongodb-atlas/delete-group-cluster` (byok) | 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | clusterName | string | yes | Human-readable label that identifies the cluster. | | retainBackups | boolean | no | Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. | ### Return Adaptive Settings for One Cluster `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-cluster-adaptive-settings` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster. | ### Update Adaptive Settings for One Cluster `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-group-cluster-adaptive-settings` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster. | | body | object | yes | JSON request body | ### Return the Auto-Embedding Inference Scope for One Cluster `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-cluster-auto-embedding-inference` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Name of the cluster for which to return the inference scope. | ### Update the Auto-Embedding Inference Scope for One Cluster `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-group-cluster-auto-embedding-inference` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Name of the cluster for which to update the inference scope. | | body | object | yes | JSON request body | ### Return Auto-Embedding Inference Scope Operations for One Cluster `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-cluster-auto-embedding-inference-operations` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Name of the cluster for which to return operations. | ### Return One Auto-Embedding Inference Scope Operation `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-cluster-auto-embedding-inference-operation` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Name of the cluster for which to return an operation. | | operationId | string | yes | Unique identifier of the operation. | ### Reset the Auto-Embedding Inference Scope for One Cluster `POST https://apizie.tech/v1/cloud:mongodb-atlas/reset-group-cluster-auto-embedding-inference` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Name of the cluster for which to reset the inference scope. | ### Return All Snapshot Export Jobs `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-cluster-backup-exports` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | clusterName | string | yes | Human-readable label that identifies the cluster. | ### Create One Snapshot Export Job `POST https://apizie.tech/v1/cloud:mongodb-atlas/create-group-cluster-backup-export` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | clusterName | string | yes | Human-readable label that identifies the cluster. | | body | object | yes | JSON request body | ### Return One Snapshot Export Job `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-cluster-backup-export` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | clusterName | string | yes | Human-readable label that identifies the cluster. | | exportId | string | yes | Unique 24-hexadecimal character string that identifies the Export Job. | ### Return All Restore Jobs for One Cluster `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-cluster-backup-restore-jobs` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster with the restore jobs you want to return. | ### Create One Restore Job of One Cluster `POST https://apizie.tech/v1/cloud:mongodb-atlas/create-group-cluster-backup-restore-job` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster. | | body | object | yes | JSON request body | ### Return One Restore Job for One Cluster `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-cluster-backup-restore-job` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster with the restore jobs you want to return. | | restoreJobId | string | yes | Unique 24-hexadecimal digit string that identifies the restore job to return. | ### Cancel One Restore Job for One Cluster `POST https://apizie.tech/v1/cloud:mongodb-atlas/cancel-group-cluster-backup-restore-job` (byok) | 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | clusterName | string | yes | Human-readable label that identifies the cluster. | | restoreJobId | string | yes | Unique 24-hexadecimal digit string that identifies the restore job to remove. | ### Return One Cloud Backup Schedule `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-cluster-backup-schedule` (byok) | 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | clusterName | string | yes | Human-readable label that identifies the cluster. | ### Update Cloud Backup Schedule for One Cluster `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-group-cluster-backup-schedule` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster. | | body | object | yes | JSON request body | ### Remove All Cloud Backup Schedules `POST https://apizie.tech/v1/cloud:mongodb-atlas/delete-group-cluster-backup-schedule` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | clusterName | string | yes | Human-readable label that identifies the cluster. | ### Return All Replica Set Cloud Backups `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-cluster-backup-snapshots` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster. | | pointInTimeUtcSeconds | integer | no | Desired point in time, expressed as the number of seconds that have elapsed since the UNIX epoch. If specified, returns the closest… | | oplogTs | 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`.… | | oplogInc | 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… | ### Take One On-Demand Snapshot `POST https://apizie.tech/v1/cloud:mongodb-atlas/take-group-cluster-backup-snapshots` (byok) | 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… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | clusterName | string | yes | Human-readable label that identifies the cluster. | | body | object | yes | JSON request body | ### Return One Sharded Cluster Cloud Backup `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-cluster-backup-snapshot-sharded-cluster` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster. | | snapshotId | string | yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. | ### Remove One Sharded Cluster Cloud Backup `POST https://apizie.tech/v1/cloud:mongodb-atlas/delete-group-cluster-backup-snapshot-sharded-cluster` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster. | | snapshotId | string | yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. | ### Return All Sharded Cluster Cloud Backups `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-cluster-backup-snapshot-sharded-clusters` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster. | ### Return One Replica Set Cloud Backup `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-cluster-backup-snapshot` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster. | | snapshotId | string | yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. | ### Update Expiration Date for One Cloud Backup `POST https://apizie.tech/v1/cloud:mongodb-atlas/update-group-cluster-backup-snapshot` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster. | | snapshotId | string | yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. | | body | object | yes | JSON request body | ### Remove One Replica Set Cloud Backup `POST https://apizie.tech/v1/cloud:mongodb-atlas/delete-group-cluster-backup-snapshot` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster. | | snapshotId | string | yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. | ### Return Databases in One Snapshot `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-cluster-backup-snapshot-databases` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster. | | snapshotId | string | yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. | ### Return One Database in One Snapshot `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-cluster-backup-snapshot-database` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster. | | snapshotId | string | yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. | | databaseName | string | yes | Human-readable label that identifies the database. | ### Return Collections in One Database in One Snapshot `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-cluster-backup-snapshot-database-collections` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | includeCount | boolean | no | Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to `false`, MongoDB Cloud may… | | itemsPerPage | integer | no | Number of items that the response returns per page. | | pageNum | integer | no | Number of the page that displays the current set of the total objects that the response returns. | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster. | | snapshotId | string | yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. | | databaseName | string | yes | Human-readable label that identifies the database. | ### Return One Collection in One Database in One Snapshot `GET https://apizie.tech/v1/cloud:mongodb-atlas/get-group-cluster-backup-snapshot-database-collection` (byok) | 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… | | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to… | | pretty | boolean | no | Flag that indicates whether the response body should be in the prettyprint format. | | clusterName | string | yes | Human-readable label that identifies the cluster. | | snapshotId | string | yes | Unique 24-hexadecimal digit string that identifies the desired snapshot. | | databaseName | string | yes | Human-readable label that identifies the database. | | collectionName | string | yes | Human-readable label that identifies the collection. | ### Return Pinned Namespaces `GET https://apizie.tech/v1/cloud:mongodb-atlas/list-group-cluster-coll-stat-pinned-namespaces` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint 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… | | clusterName | string | yes | Human-readable label that identifies the cluster to retrieve pinned namespaces for. | ### Pin Namespaces `POST https://apizie.tech/v1/cloud:mongodb-atlas/pin-group-cluster-coll-stat-pinned-namespaces` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | groupId | string | yes | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint 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… | | clusterName | string | yes | Human-readable label that identifies the cluster to pin namespaces to. | | body | object | yes | JSON request body | …and 280 more. See the OpenAPI spec. ## Example ``` curl "https://apizie.tech/v1/cloud:mongodb-atlas/get-system-status" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the MongoDB Atlas Administration API API? Create a free Apizie key, then send GET https://apizie.tech/v1/cloud:mongodb-atlas/get-system-status with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the MongoDB Atlas Administration API API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. MongoDB Atlas Administration API itself also needs your own key from mongodb.com. ### Can AI agents use the MongoDB Atlas Administration API API? Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:mongodb-atlas. ### What is the status of the MongoDB Atlas Administration API API? Needs your own provider key (bring your own key)