{"note":"OpenAPI conversion -- returning structured metadata","name":"mongodb-atlas","description":"MongoDB Atlas Administration API","version":"2.0","base_url":"https://cloud.mongodb.com","endpoints":505,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api MongoDB Atlas Administration API\n@base https://cloud.mongodb.com\n@version 2.0\n@auth Bearer digest | OAuth2\n@common_fields {envelope: bool=false # Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.}\n@endpoints 505\n@hint download_for_search\n@toc api(505)\n\n@endpoint GET /api/atlas/v2\n@desc Return the Status of This MongoDB Application\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/alertConfigs/matchers/fieldNames\n@desc Return All Alert Configuration Matchers Field Names\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/clusters\n@desc Return All Authorized Clusters in All Projects\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/defaultGroupLimits\n@desc Return Descriptions of User-Configurable Project Limits\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/defaultGroupLimits/{limitName}\n@desc Return One User-Configurable Project Limit and Description\n@required {limitName: str # Human-readable label that identifies the user-managed limit whose description you want to retrieve.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/eventTypes\n@desc Return All Event Types\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/federationSettings/{federationSettingsId}\n@desc Delete One Federation Settings Instance\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation.}\n@returns(204) No Content\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs\n@desc Return All Organization Configurations from One Federation\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\n@desc Remove One Organization Configuration from One Federation\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation., orgId: str # Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\n@desc Return One Organization Configuration from One Federation\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation., orgId: str # Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\n@desc Update One Organization Configuration in One Federation\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation., orgId: str # Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\n@desc Return All Role Mappings from One Organization\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation., orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\n@desc Create One Role Mapping in One Organization Configuration\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation., orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\n@desc Remove One Role Mapping from One Organization\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation., id: str # Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove., orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@returns(204) No Content\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\n@desc Return One Role Mapping from One Organization\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation., id: str # Unique 24-hexadecimal digit string that identifies the role mapping that you want to return., orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PUT /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\n@desc Update One Role Mapping in One Organization\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation., id: str # Unique 24-hexadecimal digit string that identifies the role mapping that you want to update., orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\n@desc Return All Identity Providers in One Federation\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., protocol: [str] # The protocols of the target identity providers., idpType: [str] # The types of the target identity providers.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\n@desc Create One Identity Provider\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\n@desc Delete One Identity Provider\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation., identityProviderId: str # Unique 24-hexadecimal digit string that identifies the identity provider to connect.}\n@returns(204) No Response\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\n@desc Return One Identity Provider by ID\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation., identityProviderId: str # Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\n@desc Update One Identity Provider\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation., identityProviderId: str # Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 405: Method Not Allowed., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks\n@desc Revoke JWKS from One OIDC Identity Provider\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation., identityProviderId: str # Unique 24-hexadecimal digit string that identifies the identity provider to connect.}\n@returns(204) No Response\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml\n@desc Return Metadata of One Identity Provider\n@required {federationSettingsId: str # Unique 24-hexadecimal digit string that identifies your federation., identityProviderId: str # Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 405: Method Not Allowed., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups\n@desc Return All Projects\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups\n@desc Create One Project\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., projectOwnerId: str # Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}\n@desc Remove One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}\n@desc Return One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}\n@desc Update One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/access\n@desc Add One MongoDB Cloud User to One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@returns(204) No Content\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/accessList\n@desc Return All Project IP Access List Entries\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/accessList\n@desc Add Entries to Project IP Access List\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/accessList/{entryValue}\n@desc Remove One Entry from One Project IP Access List\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., entryValue: str # Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including:  - how your application established the connection, - how MongoDB Cloud or the driver using the address behaves, and - which protocol (like TCP or UDP) the connection uses.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/accessList/{entryValue}\n@desc Return One Project IP Access List Entry\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., entryValue: str # Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`).}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status\n@desc Return Status of One Project IP Access List Entry\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., entryValue: str # Network address or cloud provider security construct that identifies which project access list entry to be verified.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/activityFeed\n@desc Return Pre-Filtered Activity Feed Link for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., eventType: [map] # Category of incident recorded at this moment in time.  **IMPORTANT**: The complete list of event type values changes frequently., maxDate: str(date-time) # End date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC., minDate: str(date-time) # Start date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC., clusterName: [str] # Human-readable label that identifies the cluster.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/aiModelApiKeys\n@desc Return AI Model API Keys for One Group\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/aiModelApiKeys\n@desc Create New AI Model API Key\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/aiModelApiKeys/{apiKeyId}\n@desc Delete Existing AI Model API Key\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., apiKeyId: str # The id of the API key to be deleted.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/aiModelApiKeys/{apiKeyId}\n@desc Return Single AI Model API Key for One Group\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., apiKeyId: str # The id of the API key to be retrieved.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/aiModelApiKeys/{apiKeyId}\n@desc Update Existing AI Model API Key\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., apiKeyId: str # The id of the API key to be updated.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/aiModelRateLimits\n@desc Return AI Model Rate Limits for One Group\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/aiModelRateLimits/{modelGroupName}\n@desc Return Single AI Model Rate Limit for One Group\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., modelGroupName: str # The name of the model group to be retrieved.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/aiModelRateLimits/{modelGroupName}\n@desc Update AI Model Rate Limit\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., modelGroupName: str # The name of the model group to be updated.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/aiModelRateLimits/{modelGroupName}:reset\n@desc Reset AI Model Rate Limit for One Model Group\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., modelGroupName: str # The name of the model group to be reset to default rate limits.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/aiModelRateLimits:reset\n@desc Reset AI Model Rate Limits for Group\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/alertConfigs\n@desc Return All Alert Configurations in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/alertConfigs\n@desc Create One Alert Configuration in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\n@desc Remove One Alert Configuration from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., alertConfigId: str # Unique 24-hexadecimal digit string that identifies the alert configuration.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) No Content\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\n@desc Return One Alert Configuration from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., alertConfigId: str # Unique 24-hexadecimal digit string that identifies the alert configuration.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\n@desc Toggle State of One Alert Configuration in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., alertConfigId: str # Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\n@desc Update One Alert Configuration in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., alertConfigId: str # Unique 24-hexadecimal digit string that identifies the alert configuration.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts\n@desc Return All Open Alerts for One Alert Configuration\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., alertConfigId: str # Unique 24-hexadecimal digit string that identifies the alert configuration.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/alerts\n@desc Return All Alerts from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., status: str(OPEN/TRACKING/CLOSED) # Status of the alerts to return. Omit this parameter to return all alerts in all statuses. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/alerts/{alertId}\n@desc Return One Alert from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., alertId: str # Unique 24-hexadecimal digit string that identifies the alert.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId}\n@desc Acknowledge One Alert from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., alertId: str # Unique 24-hexadecimal digit string that identifies the alert.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs\n@desc Return All Alert Configurations Set for One Alert\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., alertId: str # Unique 24-hexadecimal digit string that identifies the alert.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/apiKeys\n@desc Return All Organization API Keys Assigned to One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/apiKeys\n@desc Create and Assign One Organization API Key to One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\n@desc Unassign One Organization API Key from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., apiUserId: str # Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\n@desc Update Organization API Key Roles for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., apiUserId: str # Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.}\n@optional {pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., itemsPerPage: int=100 # Number of items that the response returns per page., includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\n@desc Assign One Organization API Key to One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., apiUserId: str # Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/auditLog\n@desc Return Auditing Configuration for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/auditLog\n@desc Update Auditing Configuration for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/awsCustomDNS\n@desc Return One Custom DNS Configuration for Atlas Clusters on AWS\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/awsCustomDNS\n@desc Update State of One Custom DNS Configuration for Atlas Clusters on AWS\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints\n@desc Return Object Storage Private Endpoints for Cloud Backups for One Cloud Provider in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str # Human-readable label that identifies the cloud provider for the private endpoints to return.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints\n@desc Create One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str # Human-readable label that identifies the cloud provider for the private endpoint to create.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId}\n@desc Delete One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str # Human-readable label that identifies the cloud provider of the private endpoint to delete., endpointId: str # Unique 24-hexadecimal digit string that identifies the private endpoint to delete.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId}\n@desc Return One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str # Human-readable label that identifies the cloud provider of the private endpoint., endpointId: str # Unique 24-hexadecimal digit string that identifies the private endpoint.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/backup/exportBuckets\n@desc Return All Snapshot Export Buckets\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets\n@desc Create One Snapshot Export Bucket\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\n@desc Delete One Snapshot Export Bucket\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., exportBucketId: str # Unique 24-hexadecimal character string that identifies the Export Bucket.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\n@desc Return One Snapshot Export Bucket\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., exportBucketId: str # Unique 24-hexadecimal character string that identifies the Export Bucket.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\n@desc Update One Export Bucket Private Networking Settings\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., exportBucketId: str # Unique 24-hexadecimal character string that identifies the snapshot export bucket.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/backupCompliancePolicy\n@desc Disable Backup Compliance Policy Settings\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/backupCompliancePolicy\n@desc Return Backup Compliance Policy Settings\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PUT /api/atlas/v2/groups/{groupId}/backupCompliancePolicy\n@desc Update Backup Compliance Policy Settings\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {overwriteBackupPolicies: bool=true # Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/cloudProviderAccess\n@desc Return All Cloud Provider Access Roles\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/cloudProviderAccess\n@desc Create One Cloud Provider Access Role\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\n@desc Deauthorize One Cloud Provider Access Role\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str(AWS/AZURE/GCP) # Human-readable label that identifies the cloud provider of the role to deauthorize., roleId: str # Unique 24-hexadecimal digit string that identifies the role.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) No Content\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\n@desc Return One Cloud Provider Access Role\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., roleId: str # Unique 24-hexadecimal digit string that identifies the role.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\n@desc Authorize One Cloud Provider Access Role\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., roleId: str # Unique 24-hexadecimal digit string that identifies the role.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters\n@desc Return All Clusters in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., includeDeletedWithRetainedBackups: bool=false # Flag that indicates whether to return Clusters with retain backups., Use-Effective-Instance-Fields: bool=false # Controls how hardware specification fields are returned in the response. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Primarily used for autoscaling compatibility.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters\n@desc Create One Cluster in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., Use-Effective-Instance-Fields: bool=false # Controls how hardware specification fields are returned in the response after cluster creation. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Primarily used for autoscaling compatibility., Use-Effective-Fields-Replication-Specs: bool=false # Controls how `replicationSpecs` fields are returned in the response. When set to `true`, stores the client's view of `replicationSpecs` and returns it in `replicationSpecs`, while the actual cluster state (including auto-scaled hardware and auto-added shards) is returned in `effectiveReplicationSpecs`. When `false` (default), `replicationSpecs` contains the actual cluster state.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 402: Payment Required., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}\n@desc Remove One Cluster from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., retainBackups: bool # Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.}\n@returns(202) Accepted\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}\n@desc Return One Cluster from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies this cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., Use-Effective-Instance-Fields: bool=false # Controls how hardware specification fields are returned in the response. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Primarily used for autoscaling compatibility., Use-Effective-Fields-Replication-Specs: bool=false # Controls how `replicationSpecs` are returned in the response. When set to `true`, returns the client-specified view in `replicationSpecs` and the actual cluster state in `effectiveReplicationSpecs`. When `false` (default), `replicationSpecs` contains the actual cluster state.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}\n@desc Update One Cluster in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., Use-Effective-Instance-Fields: bool=false # Controls how hardware specification fields are returned in the response after cluster updates. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Note: When using this header with autoscaling enabled, MongoDB ignores `replicationSpecs` changes during updates. To intentionally override the `replicationSpecs`, disable this header., Use-Effective-Fields-Replication-Specs: bool=false # Controls how `replicationSpecs` fields are returned in the response. When set to `true`, stores the client's view of `replicationSpecs` and returns it in `replicationSpecs`, while the actual cluster state (including auto-scaled hardware and auto-added shards) is returned in `effectiveReplicationSpecs`. When `false` (default), `replicationSpecs` contains the actual cluster state.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements\n@desc Return Cluster-Level Query Latency\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster to retrieve metrics for., clusterView: str(PRIMARY/SECONDARY/INDIVIDUAL_PROCESS) # Human-readable label that identifies the cluster topology to retrieve metrics for., databaseName: str # Human-readable label that identifies the database., collectionName: str # Human-readable label that identifies the collection.}\n@optional {metrics: [str] # List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics., start: str(date-time) # Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**., end: str(date-time) # Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**., period: str # Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.}\n@returns(200) Succeeded\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces\n@desc Return Ranked Namespaces from One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster to pin namespaces to., clusterView: str(PRIMARY/SECONDARY/INDIVIDUAL_PROCESS) # Human-readable label that identifies the cluster topology to retrieve metrics for.}\n@optional {start: str(date-time) # Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**., end: str(date-time) # Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**., period: str # Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.}\n@returns(200) Succeeded\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration\n@desc Return Auto Scaling Configuration for One Sharded Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies this cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\n@desc Return All Snapshot Export Jobs\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\n@desc Create One Snapshot Export Job\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}\n@desc Return One Snapshot Export Job\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster., exportId: str # Unique 24-hexadecimal character string that identifies the Export Job.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\n@desc Return All Restore Jobs for One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster with the restore jobs you want to return.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\n@desc Create One Restore Job of One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\n@desc Cancel One Restore Job for One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster., restoreJobId: str # Unique 24-hexadecimal digit string that identifies the restore job to remove.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 405: Method Not Allowed., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\n@desc Return One Restore Job for One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster with the restore jobs you want to return., restoreJobId: str # Unique 24-hexadecimal digit string that identifies the restore job to return.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\n@desc Remove All Cloud Backup Schedules\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\n@desc Return One Cloud Backup Schedule\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\n@desc Update Cloud Backup Schedule for One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\n@desc Return All Replica Set Cloud Backups\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\n@desc Take One On-Demand Snapshot\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\n@desc Remove One Replica Set Cloud Backup\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster., snapshotId: str # Unique 24-hexadecimal digit string that identifies the desired snapshot.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\n@desc Return One Replica Set Cloud Backup\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster., snapshotId: str # Unique 24-hexadecimal digit string that identifies the desired snapshot.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\n@desc Update Expiration Date for One Cloud Backup\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster., snapshotId: str # Unique 24-hexadecimal digit string that identifies the desired snapshot.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\n@desc Remove One Sharded Cluster Cloud Backup\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster., snapshotId: str # Unique 24-hexadecimal digit string that identifies the desired snapshot.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\n@desc Return One Sharded Cluster Cloud Backup\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster., snapshotId: str # Unique 24-hexadecimal digit string that identifies the desired snapshot.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters\n@desc Return All Sharded Cluster Cloud Backups\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints\n@desc Return All Legacy Backup Checkpoints\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster that contains the checkpoints that you want to return.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}\n@desc Return One Legacy Backup Checkpoint\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., checkpointId: str # Unique 24-hexadecimal digit string that identifies the checkpoint., clusterName: str # Human-readable label that identifies the cluster that contains the checkpoints that you want to return.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\n@desc Return Pinned Namespaces\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster to retrieve pinned namespaces for.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\n@desc Add Pinned Namespaces\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster to pin namespaces to.}\n@returns(200) OK\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PUT /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\n@desc Pin Namespaces\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster to pin namespaces to.}\n@returns(200) OK\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin\n@desc Unpin Namespaces\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster to unpin namespaces from.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\n@desc Create One Atlas Search Index\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Name of the cluster that contains the collection on which to create an Atlas Search index.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}\n@desc Return All Atlas Search Indexes for One Collection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Name of the cluster that contains the collection with one or more Atlas Search indexes., collectionName: str # Name of the collection that contains one or more Atlas Search indexes., databaseName: str # Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\n@desc Remove One Atlas Search Index\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Name of the cluster that contains the database and collection with one or more Application Search indexes., indexId: str # Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\n@desc Return One Atlas Search Index\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Name of the cluster that contains the collection with one or more Atlas Search indexes., indexId: str # Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\n@desc Update One Atlas Search Index\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Name of the cluster that contains the collection whose Atlas Search index to update., indexId: str # Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites\n@desc Return One Managed Namespace in One Global Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies this cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\n@desc Remove All Custom Zone Mappings from One Global Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies this cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\n@desc Add One Custom Zone Mapping to One Global Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies this cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\n@desc Remove One Managed Namespace from One Global Cluster\n@required {clusterName: str # Human-readable label that identifies this cluster., groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., db: str # Human-readable label that identifies the database that contains the collection., collection: str # Human-readable label that identifies the collection associated with the managed namespace.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\n@desc Create One Managed Namespace in One Global Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies this cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 405: Method Not Allowed., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\n@desc Create One Rolling Index\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(202) Accepted\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/lifecycleManagementPolicies\n@desc Return All Lifecycle Management Policies for One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies the project., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/lifecycleManagementPolicies\n@desc Create One Lifecycle Management Policy\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies the project., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/lifecycleManagementPolicies/{policyId}\n@desc Delete One Lifecycle Management Policy\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies the project., clusterName: str # Human-readable label that identifies the cluster., policyId: str # Unique 24-hexadecimal digit string that identifies the policy.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) No Content\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/lifecycleManagementPolicies/{policyId}\n@desc Return One Lifecycle Management Policy\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies the project., clusterName: str # Human-readable label that identifies the cluster., policyId: str # Unique 24-hexadecimal digit string that identifies the policy.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/lifecycleManagementPolicies/{policyId}\n@desc Update One Lifecycle Management Policy\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies the project., clusterName: str # Human-readable label that identifies the cluster., policyId: str # Unique 24-hexadecimal digit string that identifies the policy.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\n@desc Return All Online Archives for One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\n@desc Create One Online Archive\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\n@desc Remove One Online Archive\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., archiveId: str # Unique 24-hexadecimal digit string that identifies the online archive to delete., clusterName: str # Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\n@desc Return One Online Archive\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., archiveId: str # Unique 24-hexadecimal digit string that identifies the online archive to return., clusterName: str # Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\n@desc Update One Online Archive\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., archiveId: str # Unique 24-hexadecimal digit string that identifies the online archive to update., clusterName: str # Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz\n@desc Download Online Archive Query Logs\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.}\n@optional {startDate: int(int64) # Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time)., endDate: int(int64) # Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time)., archiveOnly: bool=false # Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\n@desc End One Outage Simulation\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster that is undergoing outage simulation.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\n@desc Return One Outage Simulation\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster that is undergoing outage simulation.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\n@desc Start One Outage Simulation\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster to undergo an outage simulation.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions\n@desc Return All Suggested Indexes to Drop\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice\n@desc Return Schema Advice\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes\n@desc Return All Suggested Indexes\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {processIds: [str] # Process IDs from which to retrieve suggested indexes. A `processId` is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple `processIds`, pass the parameter multiple times delimited with an ampersand (`&`) between each `processId`., namespaces: [str] # Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces., since: int(int64) # Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).  - If you don't specify the **until** parameter, the endpoint returns data covering from the **since** value and the current time. - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours., until: int(int64) # Date and time up until which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).  - If you specify the **until** parameter, you must specify the **since** parameter. - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\n@desc Return Advanced Configuration Options for One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\n@desc Update Advanced Configuration Options for One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/{queryShapeHash}/details\n@desc Return Query Shape Details\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster., queryShapeHash: str # A SHA256 hash of a query shape, output by MongoDB commands like `$queryStats` and `$explain` or slow query logs.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., since: int(int64) # Date and time from which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).  - If you don't specify the **until** parameter, the endpoint returns data covering from the **since** value and the current time. - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours., until: int(int64) # Date and time up until which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).  - If you specify the **until** parameter, you must specify the **since** parameter. - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours., processIds: [str] # Process IDs from which to retrieve query shape statistics. A `processId` is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple `processIds`, pass the parameter multiple times delimited with an ampersand (`&`) between each `processId`.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/summaries\n@desc Return Query Statistic Summaries\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {since: int(int64) # Date and time from which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).  - If you don't specify the **until** parameter, the endpoint returns data covering from the **since** value and the current time. - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours., until: int(int64) # Date and time up until which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).  - If you specify the **until** parameter, you must specify the **since** parameter. - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours., processIds: [str] # Process IDs from which to retrieve query shape statistics. A `processId` is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple `processId`, pass the parameter multiple times delimited with an ampersand (`&`) between each `processId`., namespaces: [str] # Namespaces from which to retrieve query shape statistics. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces., commands: [str] # Retrieve query shape statistics matching specified MongoDB commands. To include multiple commands, pass the parameter multiple times delimited with an ampersand (`&`) between each command. The currently supported parameters are find, distinct, and aggregate. Omit this parameter to return results for all supported commands., nSummaries: int(int64)=100 # Maximum number of query statistic summaries to return., series: [str] # Query shape statistics data series to retrieve. A series represents a specific metric about query execution. To include multiple series, pass the parameter multiple times delimited with an ampersand (`&`) between each series. Omit this parameter to return results for all available series., queryShapeHashes: [str] # A list of SHA256 hashes of desired query shapes, output by MongoDB commands like `$queryStats` and $explain or slow query logs. To include multiple series, pass the parameter multiple times delimited with an ampersand (`&`) between each series. Omit this parameter to return results for all available series., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapes\n@desc Return All Query Shapes\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {status: str=REJECTED # The status of query shapes to retrieve. Only REJECTED status is supported. If omitted, defaults to REJECTED., includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapes/{queryShapeHash}\n@desc Return One Query Shape\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster., queryShapeHash: str # A SHA256 hash of a query shape, output by MongoDB commands like `$queryStats` and `$explain` or slow query logs.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapes/{queryShapeHash}\n@desc Update Query Shape Rejection Status\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster., queryShapeHash: str # A SHA256 hash of a query shape, output by MongoDB commands like `$queryStats` and `$explain` or slow query logs.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\n@desc Test Failover for One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\n@desc Return All Legacy Backup Restore Jobs\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster with the snapshot you want to return.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., batchId: str # Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\n@desc Create One Legacy Backup Restore Job\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster with the snapshot you want to return.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}\n@desc Return One Legacy Backup Restore Job\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster with the snapshot you want to return., jobId: str # Unique 24-hexadecimal digit string that identifies the restore job.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\n@desc Delete Search Nodes\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Label that identifies the cluster to delete.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\n@desc Return All Search Nodes\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Label that identifies the cluster to return the Search Nodes for.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\n@desc Update Search Nodes\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Label that identifies the cluster to update the Search Nodes for.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\n@desc Create Search Nodes\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Label that identifies the cluster to create Search Nodes for.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes\n@desc Return All Atlas Search Indexes for One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Name of the cluster that contains the collection with one or more Atlas Search indexes.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error., 503: Service Unavailable.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes\n@desc Create One Atlas Search Index\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Name of the cluster that contains the collection on which to create an Atlas Search index.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}\n@desc Return All Atlas Search Indexes for One Collection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Name of the cluster that contains the collection with one or more Atlas Search indexes., collectionName: str # Name of the collection that contains one or more Atlas Search indexes., databaseName: str # Label that identifies the database that contains the collection with one or more Atlas Search indexes.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error., 503: Service Unavailable.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\n@desc Remove One Atlas Search Index by Name\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Name of the cluster that contains the database and collection with one or more Application Search indexes., collectionName: str # Name of the collection that contains one or more Atlas Search indexes., databaseName: str # Label that identifies the database that contains the collection with one or more Atlas Search indexes., indexName: str # Name of the Atlas Search index to delete.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\n@desc Return One Atlas Search Index by Name\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Name of the cluster that contains the collection with one or more Atlas Search indexes., collectionName: str # Name of the collection that contains one or more Atlas Search indexes., databaseName: str # Label that identifies the database that contains the collection with one or more Atlas Search indexes., indexName: str # Name of the Atlas Search index to return.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\n@desc Update One Atlas Search Index by Name\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Name of the cluster that contains the collection whose Atlas Search index you want to update., collectionName: str # Name of the collection that contains one or more Atlas Search indexes., databaseName: str # Label that identifies the database that contains the collection with one or more Atlas Search indexes., indexName: str # Name of the Atlas Search index to update.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\n@desc Remove One Atlas Search Index by ID\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Name of the cluster that contains the database and collection with one or more Application Search indexes., indexId: str # Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\n@desc Return One Atlas Search Index by ID\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Name of the cluster that contains the collection with one or more Atlas Search indexes., indexId: str # Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error., 503: Service Unavailable.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\n@desc Update One Atlas Search Index by ID\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Name of the cluster that contains the collection whose Atlas Search index you want to update., indexId: str # Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\n@desc Return One Snapshot Schedule\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster with the snapshot you want to return.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\n@desc Update Snapshot Schedule for One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster with the snapshot you want to return.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots\n@desc Return All Legacy Backup Snapshots\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., completed: str(all/true/false)=true # Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\n@desc Remove One Legacy Backup Snapshot\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster., snapshotId: str # Unique 24-hexadecimal digit string that identifies the desired snapshot.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\n@desc Return One Legacy Backup Snapshot\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster., snapshotId: str # Unique 24-hexadecimal digit string that identifies the desired snapshot.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\n@desc Update Expiration Date for One Legacy Backup Snapshot\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster., snapshotId: str # Unique 24-hexadecimal digit string that identifies the desired snapshot.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status\n@desc Return Status of All Cluster Operations\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess\n@desc Grant MongoDB Employee Cluster Access for One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies this cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion\n@desc Pin Feature Compatibility Version for One Cluster in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies this cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess\n@desc Revoke MongoDB Employee Cluster Access for One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies this cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion\n@desc Unpin Feature Compatibility Version for One Cluster in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies this cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 402: Payment Required., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz\n@desc Download Logs for One Cluster Host in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., hostName: str # Human-readable label that identifies the host that stores the log files that you want to download., logName: str(mongodb/mongos/mongodb-audit-log/mongos-audit-log) # Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.}\n@optional {endDate: int(int64) # Specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours after the start date. If the start date is also unspecified, the value will default to the time of the request., startDate: int(int64) # Specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/clusters/provider/regions\n@desc Return All Cloud Provider Regions\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., providers: [str] # Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters., tier: str # Cluster tier for which to retrieve the regions.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\n@desc Upgrade One Shared-Tier Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 402: Payment Required., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\n@desc Upgrade One Shared-Tier Cluster to One Serverless Instance\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 402: Payment Required., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/collStats/metrics\n@desc Return All Metric Names\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@returns(200) Succeeded\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/containers\n@desc Return All Network Peering Containers in One Project for One Cloud Provider\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., providerName: str(AWS/AZURE/GCP)=AWS # Cloud service provider that serves the desired network peering containers.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/containers\n@desc Create One Network Peering Container\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/containers/{containerId}\n@desc Remove One Network Peering Container\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., containerId: str # Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/containers/{containerId}\n@desc Return One Network Peering Container\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., containerId: str # Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/containers/{containerId}\n@desc Update One Network Peering Container\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., containerId: str # Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/containers/all\n@desc Return All Network Peering Containers in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/customDBRoles/roles\n@desc Return All Custom Roles in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/customDBRoles/roles\n@desc Create One Custom Role\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(202) Accepted\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\n@desc Remove One Custom Role from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., roleName: str # Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) No Content\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\n@desc Return One Custom Role in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., roleName: str # Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\n@desc Update One Custom Role in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., roleName: str # Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/dataFederation\n@desc Return All Federated Database Instances in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., type: str(USER/ONLINE_ARCHIVE)=USER # Type of Federated Database Instances to return.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/dataFederation\n@desc Create One Federated Database Instance in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., skipRoleValidation: bool=false # Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\n@desc Remove One Federated Database Instance from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Human-readable label that identifies the federated database instance to remove.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\n@desc Return One Federated Database Instance in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Human-readable label that identifies the Federated Database to return.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\n@desc Update One Federated Database Instance in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Human-readable label that identifies the federated database instance to update., skipRoleValidation: bool # Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits\n@desc Return All Query Limits for One Federated Database Instance\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Human-readable label that identifies the federated database instance for which you want to retrieve query limits.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\n@desc Delete One Query Limit for One Federated Database Instance\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Human-readable label that identifies the federated database instance to which the query limit applies., limitName: str(bytesProcessed.query/bytesProcessed.daily/bytesProcessed.weekly/bytesProcessed.monthly) # Human-readable label that identifies this data federation instance limit.  | Limit Name | Description | Default | | --- | --- | --- | | `bytesProcessed.query` | Limit on the number of bytes processed during a single data federation query | N/A | | `bytesProcessed.daily` | Limit on the number of bytes processed for the data federation instance for the current day | N/A | | `bytesProcessed.weekly` | Limit on the number of bytes processed for the data federation instance for the current week | N/A | | `bytesProcessed.monthly` | Limit on the number of bytes processed for the data federation instance for the current month | N/A |}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\n@desc Return One Federated Database Instance Query Limit for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Human-readable label that identifies the federated database instance to which the query limit applies., limitName: str(bytesProcessed.query/bytesProcessed.daily/bytesProcessed.weekly/bytesProcessed.monthly) # Human-readable label that identifies this data federation instance limit.  | Limit Name | Description | Default | | --- | --- | --- | | `bytesProcessed.query` | Limit on the number of bytes processed during a single data federation query | N/A | | `bytesProcessed.daily` | Limit on the number of bytes processed for the data federation instance for the current day | N/A | | `bytesProcessed.weekly` | Limit on the number of bytes processed for the data federation instance for the current week | N/A | | `bytesProcessed.monthly` | Limit on the number of bytes processed for the data federation instance for the current month | N/A |}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\n@desc Configure One Query Limit for One Federated Database Instance\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Human-readable label that identifies the federated database instance to which the query limit applies., limitName: str(bytesProcessed.query/bytesProcessed.daily/bytesProcessed.weekly/bytesProcessed.monthly) # Human-readable label that identifies this data federation instance limit.  | Limit Name | Description | Default | | --- | --- | --- | | `bytesProcessed.query` | Limit on the number of bytes processed during a single data federation query | N/A | | `bytesProcessed.daily` | Limit on the number of bytes processed for the data federation instance for the current day | N/A | | `bytesProcessed.weekly` | Limit on the number of bytes processed for the data federation instance for the current week | N/A | | `bytesProcessed.monthly` | Limit on the number of bytes processed for the data federation instance for the current month | N/A |}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz\n@desc Download Query Logs for One Federated Database Instance\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Human-readable label that identifies the federated database instance for which you want to download query logs.}\n@optional {endDate: int(int64) # Timestamp that specifies the end point for the range of log messages to download.  MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch., startDate: int(int64) # Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/databaseUsers\n@desc Return All Database Users in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/databaseUsers\n@desc Create One Database User in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\n@desc Remove One Database User from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., databaseName: str # The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`., username: str # Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:  | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | `awsIAMType` | `ROLE` | ARN | | AWS IAM | `awsIAMType` | `USER` | ARN | | x.509 | `x509Type` | `CUSTOMER` | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | `x509Type` | `MANAGED` | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | `ldapAuthType` | `USER` | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | `ldapAuthType` | `GROUP` | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | OIDC Workforce | `oidcAuthType` | `IDP_GROUP` | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name | | OIDC Workload | `oidcAuthType` | `USER` | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name | | SCRAM-SHA | `awsIAMType`, `x509Type`, `ldapAuthType`, `oidcAuthType` | `NONE` | Alphanumeric string |}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\n@desc Return One Database User from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., databaseName: str # The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`., username: str # Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:  | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | `awsIAMType` | `ROLE` | ARN | | AWS IAM | `awsIAMType` | `USER` | ARN | | x.509 | `x509Type` | `CUSTOMER` | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | `x509Type` | `MANAGED` | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | `ldapAuthType` | `USER` | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | `ldapAuthType` | `GROUP` | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | OIDC Workforce | `oidcAuthType` | `IDP_GROUP` | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name | | OIDC Workload | `oidcAuthType` | `USER` | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name | | SCRAM-SHA | `awsIAMType`, `x509Type`, `ldapAuthType`, `oidcAuthType` | `NONE` | Alphanumeric string |}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\n@desc Update One Database User in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., databaseName: str # The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`., username: str # Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:  | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | `awsIAMType` | `ROLE` | ARN | | AWS IAM | `awsIAMType` | `USER` | ARN | | x.509 | `x509Type` | `CUSTOMER` | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | `x509Type` | `MANAGED` | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | `ldapAuthType` | `USER` | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | `ldapAuthType` | `GROUP` | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | OIDC Workforce | `oidcAuthType` | `IDP_GROUP` | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name | | OIDC Workload | `oidcAuthType` | `USER` | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name | | SCRAM-SHA | `awsIAMType`, `x509Type`, `ldapAuthType`, `oidcAuthType` | `NONE` | Alphanumeric string |}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\n@desc Return All X.509 Certificates Assigned to One Database User\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., username: str # Human-readable label that represents the MongoDB database user account whose certificates you want to return.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\n@desc Create One X.509 Certificate for One Database User\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., username: str # Human-readable label that represents the MongoDB database user account for whom to create a certificate.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) This endpoint returns a PEM file with the certificate and private key.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}\n@desc Return Database Access History for One Cluster by Cluster Name\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., authResult: bool # Flag that indicates whether the response returns the successful authentication attempts only., end: int(int64) # Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds., ipAddress: str # One Internet Protocol address that attempted to authenticate with the database., nLogs: int(int32)=20000 # Maximum number of lines from the log to return., start: int(int64) # Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}\n@desc Return Database Access History for One Cluster by Hostname\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., hostname: str # Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., authResult: bool # Flag that indicates whether the response returns the successful authentication attempts only., end: int(int64) # Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds., ipAddress: str # One Internet Protocol address that attempted to authenticate with the database., nLogs: int(int32)=20000 # Maximum number of lines from the log to return., start: int(int64) # Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/encryptionAtRest\n@desc Return One Configuration for Encryption at Rest Using Customer-Managed Keys for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/encryptionAtRest\n@desc Update Encryption at Rest Configuration in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\n@desc Return Private Endpoints for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str(AZURE/AWS) # Human-readable label that identifies the cloud provider for the private endpoints to return.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\n@desc Create One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str(AZURE/AWS) # Human-readable label that identifies the cloud provider for the private endpoint to create.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(202) Accepted\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\n@desc Delete One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str(AZURE/AWS) # Human-readable label that identifies the cloud provider of the private endpoint to delete., endpointId: str # Unique 24-hexadecimal digit string that identifies the private endpoint to delete.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\n@desc Return One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str(AZURE/AWS) # Human-readable label that identifies the cloud provider of the private endpoint., endpointId: str # Unique 24-hexadecimal digit string that identifies the private endpoint.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/events\n@desc Return Events from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., clusterNames: [str] # Human-readable label that identifies the cluster., eventType: [map] # Category of incident recorded at this moment in time.  **IMPORTANT**: The complete list of event type values changes frequently., excludedEventType: [map] # Category of event that you would like to exclude from query results, such as `CLUSTER_CREATED`.  **IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types., includeRaw: bool=false # Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event., maxDate: str(date-time) # Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC., minDate: str(date-time) # Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/events/{eventId}\n@desc Return One Event from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., eventId: str # Unique 24-hexadecimal digit string that identifies the event that you want to return.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., includeRaw: bool=false # Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/flexClusters\n@desc Return All Flex Clusters from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/flexClusters\n@desc Create One Flex Cluster in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 402: Payment Required., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/flexClusters/{name}\n@desc Remove One Flex Cluster from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., name: str # Human-readable label that identifies the flex cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/flexClusters/{name}\n@desc Return One Flex Cluster from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., name: str # Human-readable label that identifies the flex cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/flexClusters/{name}\n@desc Update One Flex Cluster in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., name: str # Human-readable label that identifies the flex cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 402: Payment Required., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download\n@desc Download One Flex Cluster Snapshot\n@required {name: str # Human-readable label that identifies the flex cluster., groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs\n@desc Return All Restore Jobs for One Flex Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., name: str # Human-readable label that identifies the flex cluster.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs\n@desc Create One Restore Job for One Flex Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., name: str # Human-readable label that identifies the flex cluster whose snapshot you want to restore.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}\n@desc Return One Restore Job for One Flex Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., name: str # Human-readable label that identifies the flex cluster., restoreJobId: str # Unique 24-hexadecimal digit string that identifies the restore job to return.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots\n@desc Return All Snapshots for One Flex Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., name: str # Human-readable label that identifies the flex cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}\n@desc Return One Snapshot for One Flex Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., name: str # Human-readable label that identifies the flex cluster., snapshotId: str # Unique 24-hexadecimal digit string that identifies the desired snapshot.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade\n@desc Upgrade One Flex Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 402: Payment Required., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics\n@desc Return All Atlas Search Metric Types for One Process\n@required {processId: str # Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests., groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements\n@desc Return Atlas Search Metrics for One Index in One Namespace\n@required {processId: str # Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests., indexName: str # Human-readable label that identifies the index., databaseName: str # Human-readable label that identifies the database., collectionName: str # Human-readable label that identifies the collection., groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., granularity: str # Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC., metrics: [str] # List that contains the measurements that MongoDB Atlas reports for the associated data series.}\n@optional {period: str # Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**., start: str(date-time) # Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**., end: str(date-time) # Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements\n@desc Return All Atlas Search Index Metrics for One Namespace\n@required {processId: str # Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests., databaseName: str # Human-readable label that identifies the database., collectionName: str # Human-readable label that identifies the collection., groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., granularity: str # Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC., metrics: [str] # List that contains the measurements that MongoDB Atlas reports for the associated data series.}\n@optional {period: str # Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**., start: str(date-time) # Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**., end: str(date-time) # Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements\n@desc Return Atlas Search Hardware and Status Metrics\n@required {processId: str # Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests., groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., granularity: str # Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC., metrics: [str] # List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.}\n@optional {period: str # Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**., start: str(date-time) # Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**., end: str(date-time) # Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/integrations\n@desc Return All Active Third-Party Service Integrations\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/integrations/{integrationType}\n@desc Remove One Third-Party Service Integration\n@required {integrationType: str(PAGER_DUTY/SLACK/DATADOG/NEW_RELIC/OPS_GENIE/VICTOR_OPS/WEBHOOK/HIP_CHAT/PROMETHEUS/MICROSOFT_TEAMS) # Human-readable label that identifies the service which you want to integrate with MongoDB Cloud., groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/integrations/{integrationType}\n@desc Return One Third-Party Service Integration\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., integrationType: str(PAGER_DUTY/SLACK/DATADOG/NEW_RELIC/OPS_GENIE/VICTOR_OPS/WEBHOOK/HIP_CHAT/PROMETHEUS/MICROSOFT_TEAMS) # Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType}\n@desc Create One Third-Party Service Integration\n@required {integrationType: str(PAGER_DUTY/SLACK/DATADOG/NEW_RELIC/OPS_GENIE/VICTOR_OPS/WEBHOOK/HIP_CHAT/PROMETHEUS/MICROSOFT_TEAMS) # Human-readable label that identifies the service which you want to integrate with MongoDB Cloud., groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType}\n@desc Update One Third-Party Service Integration\n@required {integrationType: str(PAGER_DUTY/SLACK/DATADOG/NEW_RELIC/OPS_GENIE/VICTOR_OPS/WEBHOOK/HIP_CHAT/PROMETHEUS/MICROSOFT_TEAMS) # Human-readable label that identifies the service which you want to integrate with MongoDB Cloud., groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/invites\n@desc Return All Invitations in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., username: str(email) # Email address of the user account invited to this project.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/invites\n@desc Update One Invitation in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/invites\n@desc Create Invitation for One MongoDB Cloud User in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/invites/{invitationId}\n@desc Remove One Invitation from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., invitationId: str # Unique 24-hexadecimal digit string that identifies the invitation.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/invites/{invitationId}\n@desc Return One Invitation in One Project by Invitation ID\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., invitationId: str # Unique 24-hexadecimal digit string that identifies the invitation.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/invites/{invitationId}\n@desc Update One Invitation in One Project by Invitation ID\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., invitationId: str # Unique 24-hexadecimal digit string that identifies the invitation.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/ipAddresses\n@desc Return All IP Addresses for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/limits\n@desc Return All Limits for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/limits/{limitName}\n@desc Remove One Project Limit\n@required {limitName: str(atlas.project.security.databaseAccess.users/atlas.project.deployment.clusters/atlas.project.deployment.serverlessMTMs/atlas.project.security.databaseAccess.customRoles/atlas.project.security.networkAccess.entries/atlas.project.security.networkAccess.crossRegionEntries/atlas.project.deployment.nodesPerPrivateLinkRegion/dataFederation.bytesProcessed.query/dataFederation.bytesProcessed.daily/dataFederation.bytesProcessed.weekly/dataFederation.bytesProcessed.monthly/atlas.project.deployment.privateServiceConnectionsPerRegionGroup/atlas.project.deployment.privateServiceConnectionsSubnetMask) # Human-readable label that identifies this project limit.  | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | | `atlas.project.deployment.clusters` | Limit on the number of clusters in this project | 25 | 100 | | `atlas.project.deployment.nodesPerPrivateLinkRegion` | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | `atlas.project.security.databaseAccess.customRoles` | Limit on the number of custom roles in this project | 100 | 1400 | | `atlas.project.security.databaseAccess.users` | Limit on the number of database users in this project | 100 | 100 | | `atlas.project.security.networkAccess.crossRegionEntries` | Limit on the number of cross-region network access entries in this project | 40 | 220 | | `atlas.project.security.networkAccess.entries` | Limit on the number of network access entries in this project | 200 | 20 | | `dataFederation.bytesProcessed.query` | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | | `dataFederation.bytesProcessed.daily` | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | | `dataFederation.bytesProcessed.weekly` | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | | `dataFederation.bytesProcessed.monthly` | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | `atlas.project.deployment.privateServiceConnectionsPerRegionGroup` | Number of Private Service Connections per Region Group | 50 | 100| | `atlas.project.deployment.privateServiceConnectionsSubnetMask` | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|, groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/limits/{limitName}\n@desc Return One Limit for One Project\n@required {limitName: str(atlas.project.security.databaseAccess.users/atlas.project.deployment.clusters/atlas.project.deployment.serverlessMTMs/atlas.project.security.databaseAccess.customRoles/atlas.project.security.networkAccess.entries/atlas.project.security.networkAccess.crossRegionEntries/atlas.project.deployment.nodesPerPrivateLinkRegion/dataFederation.bytesProcessed.query/dataFederation.bytesProcessed.daily/dataFederation.bytesProcessed.weekly/dataFederation.bytesProcessed.monthly/atlas.project.deployment.privateServiceConnectionsPerRegionGroup/atlas.project.deployment.privateServiceConnectionsSubnetMask) # Human-readable label that identifies this project limit.  | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | | `atlas.project.deployment.clusters` | Limit on the number of clusters in this project | 25 | 100 | | `atlas.project.deployment.nodesPerPrivateLinkRegion` | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | `atlas.project.security.databaseAccess.customRoles` | Limit on the number of custom roles in this project | 100 | 1400 | | `atlas.project.security.databaseAccess.users` | Limit on the number of database users in this project | 100 | 100 | | `atlas.project.security.networkAccess.crossRegionEntries` | Limit on the number of cross-region network access entries in this project | 40 | 220 | | `atlas.project.security.networkAccess.entries` | Limit on the number of network access entries in this project | 200 | 20 | | `dataFederation.bytesProcessed.query` | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | | `dataFederation.bytesProcessed.daily` | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | | `dataFederation.bytesProcessed.weekly` | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | | `dataFederation.bytesProcessed.monthly` | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | `atlas.project.deployment.privateServiceConnectionsPerRegionGroup` | Number of Private Service Connections per Region Group | 50 | 100| | `atlas.project.deployment.privateServiceConnectionsSubnetMask` | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|, groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/limits/{limitName}\n@desc Set One Project Limit\n@required {limitName: str(atlas.project.security.databaseAccess.users/atlas.project.deployment.clusters/atlas.project.deployment.serverlessMTMs/atlas.project.security.databaseAccess.customRoles/atlas.project.security.networkAccess.entries/atlas.project.security.networkAccess.crossRegionEntries/atlas.project.deployment.nodesPerPrivateLinkRegion/dataFederation.bytesProcessed.query/dataFederation.bytesProcessed.daily/dataFederation.bytesProcessed.weekly/dataFederation.bytesProcessed.monthly/atlas.project.deployment.privateServiceConnectionsPerRegionGroup/atlas.project.deployment.privateServiceConnectionsSubnetMask) # Human-readable label that identifies this project limit.  | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | | `atlas.project.deployment.clusters` | Limit on the number of clusters in this project | 25 | 100 | | `atlas.project.deployment.nodesPerPrivateLinkRegion` | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | `atlas.project.security.databaseAccess.customRoles` | Limit on the number of custom roles in this project | 100 | 1400 | | `atlas.project.security.databaseAccess.users` | Limit on the number of database users in this project | 100 | 100 | | `atlas.project.security.networkAccess.crossRegionEntries` | Limit on the number of cross-region network access entries in this project | 40 | 220 | | `atlas.project.security.networkAccess.entries` | Limit on the number of network access entries in this project | 200 | 20 | | `dataFederation.bytesProcessed.query` | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | | `dataFederation.bytesProcessed.daily` | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | | `dataFederation.bytesProcessed.weekly` | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | | `dataFederation.bytesProcessed.monthly` | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | `atlas.project.deployment.privateServiceConnectionsPerRegionGroup` | Number of Private Service Connections per Region Group | 50 | 100| | `atlas.project.deployment.privateServiceConnectionsSubnetMask` | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|, groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/liveMigrations\n@desc Create One Migration for One Local Managed Cluster to MongoDB Atlas\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}\n@desc Return One Migration Job\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., liveMigrationId: str # Unique 24-hexadecimal digit string that identifies the migration.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PUT /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\n@desc Cut Over One Migrated Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., liveMigrationId: str # Unique 24-hexadecimal digit string that identifies the migration.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(202) Accepted.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/liveMigrations/validate\n@desc Validate One Migration Request\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}\n@desc Return One Migration Validation Job\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., validationId: str # Unique 24-hexadecimal digit string that identifies the validation job.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/logIntegrations\n@desc Return All Active Log Integrations\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., integrationType: str # Optional filter by integration type (e.g., `S3_LOG_EXPORT`).}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/logIntegrations\n@desc Create One Log Integration\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/logIntegrations/{id}\n@desc Remove One Log Integration\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., id: str # Unique identifier of the log integration configuration.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/logIntegrations/{id}\n@desc Return One Log Integration\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., id: str # Unique identifier of the log integration configuration.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PUT /api/atlas/v2/groups/{groupId}/logIntegrations/{id}\n@desc Update One Log Integration\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., id: str # Unique identifier of the log integration configuration.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/maintenanceWindow\n@desc Reset One Maintenance Window for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/maintenanceWindow\n@desc Return One Maintenance Window for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/maintenanceWindow\n@desc Update One Maintenance Window for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\n@desc Toggle Automatic Deferral of Maintenance for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\n@desc Defer One Maintenance Window for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/managedSlowMs\n@desc Return Managed Slow Operation Threshold Status\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/managedSlowMs/disable\n@desc Disable Managed Slow Operation Threshold\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/managedSlowMs/enable\n@desc Enable Managed Slow Operation Threshold\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/mongoDBVersions\n@desc Return All Available MongoDB LTS Versions for Clusters in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., cloudProvider: str(AWS/AZURE/GCP/TENANT) # Filter results to only one cloud provider., instanceSize: str # Filter results to only one instance size., defaultStatus: str # Filter results to only the default values per tier. This value must be DEFAULT., itemsPerPage: int(int64)=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/peers\n@desc Return All Network Peering Connections in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., providerName: str(AWS/AZURE/GCP)=AWS # Cloud service provider to use for this VPC peering connection.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/peers\n@desc Create One Network Peering Connection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/peers/{peerId}\n@desc Remove One Network Peering Connection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., peerId: str # Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(202) Accepted\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/peers/{peerId}\n@desc Return One Network Peering Connection in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., peerId: str # Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/peers/{peerId}\n@desc Update One Network Peering Connection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., peerId: str # Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/pipelines\n@desc Return All Data Lake Pipelines in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/pipelines\n@desc Create One Data Lake Pipeline\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\n@desc Remove One Data Lake Pipeline\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., pipelineName: str # Human-readable label that identifies the Data Lake Pipeline.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\n@desc Return One Data Lake Pipeline\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., pipelineName: str # Human-readable label that identifies the Data Lake Pipeline.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\n@desc Update One Data Lake Pipeline\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., pipelineName: str # Human-readable label that identifies the Data Lake Pipeline.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules\n@desc Return All Ingestion Schedules for One Data Lake Pipeline\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., pipelineName: str # Human-readable label that identifies the Data Lake Pipeline.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots\n@desc Return All Backup Snapshots for One Data Lake Pipeline\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., pipelineName: str # Human-readable label that identifies the Data Lake Pipeline.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., completedAfter: str(date-time) # Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\n@desc Pause One Data Lake Pipeline\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., pipelineName: str # Human-readable label that identifies the Data Lake Pipeline.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\n@desc Resume One Data Lake Pipeline\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., pipelineName: str # Human-readable label that identifies the Data Lake Pipeline.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs\n@desc Return All Data Lake Pipeline Runs in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., pipelineName: str # Human-readable label that identifies the Data Lake Pipeline.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., createdBefore: str(date-time) # If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\n@desc Delete One Pipeline Run Dataset\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., pipelineName: str # Human-readable label that identifies the Data Lake Pipeline., pipelineRunId: str # Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(202) Accepted\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\n@desc Return One Data Lake Pipeline Run\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., pipelineName: str # Human-readable label that identifies the Data Lake Pipeline., pipelineRunId: str # Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\n@desc Trigger On-Demand Snapshot Ingestion\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., pipelineName: str # Human-readable label that identifies the Data Lake Pipeline.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService\n@desc Return All Private Endpoint Services for One Provider\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str(AWS/AZURE/GCP)=AWS # Cloud service provider that manages this private endpoint service.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\n@desc Remove One Private Endpoint Service for One Provider\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str(AWS/AZURE/GCP)=AWS # Cloud service provider that manages this private endpoint service., endpointServiceId: str # Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\n@desc Return One Private Endpoint Service for One Provider\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str(AWS/AZURE/GCP)=AWS # Cloud service provider that manages this private endpoint service., endpointServiceId: str # Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\n@desc Create One Private Endpoint for One Provider\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str(AWS/AZURE/GCP)=AWS # Cloud service provider that manages this private endpoint., endpointServiceId: str # Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 402: Payment Required., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\n@desc Remove One Private Endpoint for One Provider\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str(AWS/AZURE/GCP)=AWS # Cloud service provider that manages this private endpoint., endpointId: str # Unique string that identifies the private endpoint you want to delete. The format of the `endpointId` parameter differs for AWS and Azure. You must URL encode the `endpointId` for Azure private endpoints., endpointServiceId: str # Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\n@desc Return One Private Endpoint for One Provider\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str(AWS/AZURE/GCP)=AWS # Cloud service provider that manages this private endpoint., endpointId: str # Unique string that identifies the private endpoint you want to return. The format of the `endpointId` parameter differs for AWS and Azure. You must URL encode the `endpointId` for Azure private endpoints., endpointServiceId: str # Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\n@desc Create One Private Endpoint Service for One Provider\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService/{endpointServiceId}\n@desc Update One Private Endpoint Service for One Provider\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., endpointServiceId: str # Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to update.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\n@desc Return Regionalized Private Endpoint Status\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\n@desc Toggle Regionalized Private Endpoint Status\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\n@desc Return All Private Endpoints for One Serverless Instance\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., instanceName: str # Human-readable label that identifies the serverless instance associated with the tenant endpoint.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\n@desc Create One Private Endpoint for One Serverless Instance\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., instanceName: str # Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\n@desc Remove One Private Endpoint for One Serverless Instance\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., instanceName: str # Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed., endpointId: str # Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\n@desc Return One Private Endpoint for One Serverless Instance\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., instanceName: str # Human-readable label that identifies the serverless instance associated with the tenant endpoint., endpointId: str # Unique 24-hexadecimal digit string that identifies the tenant endpoint.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\n@desc Update One Private Endpoint for One Serverless Instance\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., instanceName: str # Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated., endpointId: str # Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/privateIpMode\n@desc Verify Connect via Peering-Only Mode for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/privateIpMode\n@desc Disable Connect via Peering-Only Mode for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\n@desc Return All Federated Database Instance and Online Archive Private Endpoints in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\n@desc Create One Federated Database Instance and Online Archive Private Endpoint for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\n@desc Remove One Federated Database Instance and Online Archive Private Endpoint from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., endpointId: str # Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\n@desc Return One Federated Database Instance and Online Archive Private Endpoint in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., endpointId: str # Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/processes\n@desc Return All MongoDB Processes in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/processes/{processId}\n@desc Return One MongoDB Process by ID\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., processId: str # Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements\n@desc Return Host-Level Query Latency\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., processId: str # Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests., databaseName: str # Human-readable label that identifies the database., collectionName: str # Human-readable label that identifies the collection.}\n@optional {metrics: [str] # List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics., start: str(date-time) # Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**., end: str(date-time) # Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**., period: str # Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.}\n@returns(200) Succeeded\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces\n@desc Return Ranked Namespaces from One Host\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., processId: str # Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.}\n@optional {start: str(date-time) # Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**., end: str(date-time) # Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**., period: str # Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.}\n@returns(200) Succeeded\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/processes/{processId}/databases\n@desc Return Available Databases for One MongoDB Process\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., processId: str # Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod`). The port must be the IANA port on which the MongoDB process listens for requests.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}\n@desc Return One Database for One MongoDB Process\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., databaseName: str # Human-readable label that identifies the database that the specified MongoDB process serves., processId: str # Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements\n@desc Return Measurements for One Database in One MongoDB Process\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., databaseName: str # Human-readable label that identifies the database that the specified MongoDB process serves., processId: str # Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests., granularity: str # Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., m: [str] # One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements., period: str # Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**., start: str(date-time) # Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**., end: str(date-time) # Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/processes/{processId}/disks\n@desc Return Available Disks for One MongoDB Process\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., processId: str # Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}\n@desc Return Measurements for One Disk\n@required {partitionName: str # Human-readable label of the disk or partition to which the measurements apply., groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., processId: str # Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements\n@desc Return Measurements of One Disk for One MongoDB Process\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., partitionName: str # Human-readable label of the disk or partition to which the measurements apply., processId: str # Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests., granularity: str # Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., m: [str] # One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements., period: str # Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**., start: str(date-time) # Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**., end: str(date-time) # Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements\n@desc Return Measurements for One MongoDB Process\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., processId: str # Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests., granularity: str # Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., m: [str] # One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements., period: str # Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**., start: str(date-time) # Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**., end: str(date-time) # Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces\n@desc Return All Namespaces for One Host\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., processId: str # Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., duration: int(int64) # Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.  - If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. - If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours., since: int(int64) # Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).  - If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time. - If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs\n@desc Return Slow Queries\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., processId: str # Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., duration: int(int64) # Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.  - If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. - If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours., namespaces: [str] # Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces., nLogs: int(int64)=20000 # Maximum number of lines from the log to return., since: int(int64) # Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).  - If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time. - If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours., includeMetrics: bool=false # Whether or not to include metrics extracted from the slow query log as separate fields., includeReplicaState: bool=false # Whether or not to include the replica state of the host when the slow query log was generated as a separate field., includeOpType: bool=false # Whether or not to include the operation type (read/write/command) extracted from the slow query log as a separate field.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes\n@desc Return All Suggested Indexes\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., processId: str # Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., duration: int(int64) # Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.  - If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. - If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours., namespaces: [str] # Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces., nExamples: int(int64)=5 # Maximum number of example queries that benefit from the suggested index., nIndexes: int(int64) # Number that indicates the maximum indexes to suggest., since: int(int64) # Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).  - If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time. - If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/pushBasedLogExport\n@desc Disable Push-Based Log Export for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/pushBasedLogExport\n@desc Return One Push-Based Log Export Configuration in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/pushBasedLogExport\n@desc Update One Push-Based Log Export Configuration in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/pushBasedLogExport\n@desc Create One Push-Based Log Export Configuration in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\n@desc Load Sample Dataset into One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., name: str # Human-readable label that identifies the cluster into which you load the sample dataset.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}\n@desc Return Status of Sample Dataset Load for One Cluster\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., sampleDatasetId: str # Unique 24-hexadecimal digit string that identifies the loaded sample dataset.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/sandbox/{sandboxConfigId}:generateClusterDescription\n@desc Return Cluster Description from Sandbox Template Configuration\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., sandboxConfigId: str # Unique 24-hexadecimal digit string that identifies the sandbox configuration.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/serverless\n@desc Return All Serverless Instances in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\n@desc Return All Restore Jobs for One Serverless Instance\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the serverless instance.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\n@desc Create One Restore Job for One Serverless Instance\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the serverless instance whose snapshot you want to restore.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}\n@desc Return One Restore Job for One Serverless Instance\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the serverless instance., restoreJobId: str # Unique 24-hexadecimal digit string that identifies the restore job to return.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots\n@desc Return All Snapshots of One Serverless Instance\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the serverless instance.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}\n@desc Return One Snapshot of One Serverless Instance\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the serverless instance., snapshotId: str # Unique 24-hexadecimal digit string that identifies the desired snapshot.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\n@desc Return Serverless Auto-Indexing Status\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\n@desc Set Serverless Auto-Indexing Status\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clusterName: str # Human-readable label that identifies the cluster., enable: bool # Value that we want to set for the Serverless Auto Indexing toggle.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/serverless/{name}\n@desc Return One Serverless Instance from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., name: str # Human-readable label that identifies the serverless instance.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/serviceAccounts\n@desc Return All Project Service Accounts\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/serviceAccounts\n@desc Create One Project Service Account\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}\n@desc Remove One Project Service Account\n@required {clientId: str # The Client ID of the Service Account., groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}\n@desc Return One Project Service Account\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clientId: str # The Client ID of the Service Account.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}\n@desc Update One Project Service Account\n@required {clientId: str # The Client ID of the Service Account., groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList\n@desc Return All Access List Entries for One Project Service Account\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clientId: str # The Client ID of the Service Account.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList\n@desc Add Access List Entries for One Project Service Account\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clientId: str # The Client ID of the Service Account.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}\n@desc Remove One Access List Entry from One Project Service Account\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clientId: str # The Client ID of the Service Account., ipAddress: str # One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets\n@desc Create One Project Service Account Secret\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., clientId: str # The Client ID of the Service Account.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}\n@desc Delete One Project Service Account Secret\n@required {clientId: str # The Client ID of the Service Account., secretId: str # Unique 24-hexadecimal digit string that identifies the secret., groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite\n@desc Assign One Service Account to One Project\n@required {clientId: str # The Client ID of the Service Account., groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/settings\n@desc Return Project Settings\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/settings\n@desc Update Project Settings\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/standbyLinks\n@desc Return All Standby Links for One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies the project.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/standbyLinks\n@desc Create Standby Link\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies the project containing the clusters.}\n@returns(201) Standby link created successfully.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/standbyLinks/{standbyLinkId}\n@desc Delete Standby Link\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies the project., standbyLinkId: str # Unique 24-hexadecimal digit string that identifies the standby link.}\n@returns(204) Standby link deleted successfully.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/standbyLinks/{standbyLinkId}\n@desc Return One Standby Link\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies the project., standbyLinkId: str # Unique 24-hexadecimal digit string that identifies the standby link.}\n@returns(200) Standby link retrieved successfully.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/standbyLinks/{standbyLinkId}/failovers\n@desc Return All Standby Link Failovers\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies the project., standbyLinkId: str # Unique 24-hexadecimal digit string that identifies the standby link.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/standbyLinks/{standbyLinkId}/failovers\n@desc Create Standby Link Failover\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies the project., standbyLinkId: str # Unique 24-hexadecimal digit string that identifies the standby link.}\n@returns(201) Failover operation created successfully.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/standbyLinks/{standbyLinkId}/failovers/{failoverId}\n@desc Return One Standby Link Failover\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies the project., standbyLinkId: str # Unique 24-hexadecimal digit string that identifies the standby link., failoverId: str # Unique 24-hexadecimal digit string that identifies the failover operation.}\n@returns(200) Failover operation retrieved successfully.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/streams\n@desc Return All Stream Workspaces in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/streams\n@desc Create One Stream Workspace\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/streams/{tenantName}\n@desc Delete One Stream Workspace\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace to delete.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(202) Accepted\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/streams/{tenantName}\n@desc Return One Stream Workspace\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace to return.}\n@optional {includeConnections: bool # Flag to indicate whether connections information should be included in the stream workspace.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName}\n@desc Update One Stream Workspace\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace to update.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs\n@desc Download Audit Logs for One Atlas Stream Processing Workspace\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace.}\n@optional {endDate: int(int64) # Timestamp that specifies the end point for the range of log messages to download.  MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch., startDate: int(int64) # Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch., spName: str # Name of the stream processor to download logs for. An empty string will download logs for all stream processors in the workspace.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\n@desc Return All Connections of the Stream Workspaces\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\n@desc Create One Stream Connection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Unauthorized., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\n@desc Delete One Stream Connection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace., connectionName: str # Label that identifies the stream connection.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(202) Accepted\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\n@desc Return One Stream Connection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace to return., connectionName: str # Label that identifies the stream connection to return.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\n@desc Update One Stream Connection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace., connectionName: str # Label that identifies the stream connection.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}/failoverConnections\n@desc Create One Failover Stream Connection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace., connectionName: str # Label that identifies the stream connection name.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor\n@desc Create One Stream Processor\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Unauthorized., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\n@desc Delete One Stream Processor\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace., processorName: str # Label that identifies the stream processor.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\n@desc Return One Stream Processor\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace., processorName: str # Label that identifies the stream processor.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\n@desc Update One Stream Processor\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace., processorName: str # Label that identifies the stream processor.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start\n@desc Start One Stream Processor\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace., processorName: str # Label that identifies the stream processor.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:startWith\n@desc Start One Stream Processor With Options\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace., processorName: str # Label that identifies the stream processor.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop\n@desc Stop One Stream Processor\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace., processorName: str # Label that identifies the stream processor.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors\n@desc Return All Stream Processors in One Stream Workspace\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/streams/{tenantName}:downloadOperationalLogs\n@desc Download Operational Logs for One Atlas Stream Processing Workspace\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., tenantName: str # Label that identifies the stream workspace.}\n@optional {endDate: int(int64) # Timestamp that specifies the end point for the range of log messages to download.  MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch., startDate: int(int64) # Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch., spName: str # Name of the stream processor to download logs for. An empty string will download logs for all stream processors in the workspace.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/streams/accountDetails\n@desc Return Account ID and VPC ID for One Project and Region\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., cloudProvider: str # One of \"aws\", \"azure\" or \"gcp\"., regionName: str # The cloud provider specific region name, i.e. \"US_EAST_1\" for cloud provider \"aws\".}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections\n@desc Return All Active Incoming VPC Peering Connections\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections\n@desc Return All Private Link Connections\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections\n@desc Create One Private Link Connection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Unauthorized., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}\n@desc Delete One Private Link Connection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., connectionId: str # Unique ID that identifies the Private Link connection.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(202) Accepted\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}\n@desc Return One Private Link Connection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., connectionId: str # Unique ID that identifies the Private Link connection.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections\n@desc Return All VPC Peering Connections\n@required {requesterAccountId: str # The Account ID of the VPC Peering connection/s., groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}\n@desc Delete One VPC Peering Connection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., id: str # The VPC Peering Connection id.}\n@returns(202) Accepted\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept\n@desc Accept One Incoming VPC Peering Connection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., id: str # The VPC Peering Connection id.}\n@returns(202) Accepted\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject\n@desc Reject One Incoming VPC Peering Connection\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., id: str # The VPC Peering Connection id.}\n@returns(202) Accepted\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/streams:withSampleConnections\n@desc Create One Stream Workspace with Sample Connections\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/teams\n@desc Return All Teams in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/teams\n@desc Add Multiple Teams to One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/teams/{teamId}\n@desc Remove One Team from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., teamId: str # Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/teams/{teamId}\n@desc Return One Team in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., teamId: str # Unique 24-hexadecimal digit string that identifies the team for which you want to get.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/teams/{teamId}\n@desc Update Team Roles in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., teamId: str # Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/userSecurity\n@desc Return LDAP or X.509 Configuration\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/groups/{groupId}/userSecurity\n@desc Update LDAP or X.509 Configuration\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(202) Accepted\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/userSecurity/customerX509\n@desc Disable Customer-Managed X.509\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@returns(202) Accepted\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\n@desc Remove LDAP User to DN Mapping\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(202) Accepted\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\n@desc Verify LDAP Configuration in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}\n@desc Return Status of LDAP Configuration Verification in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., requestId: str # Unique string that identifies the request to verify an Lightweight Directory Access Protocol (LDAP) configuration.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/users\n@desc Return All MongoDB Cloud Users in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., flattenTeams: bool=false # Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If `\"flattenTeams\" : false`, this resource returns only users with a role in the project.  If `\"flattenTeams\" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project., includeOrgUsers: bool=false # Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If `\"includeOrgUsers\": false`, this resource returns only users with a role in the project. If `\"includeOrgUsers\": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role., orgMembershipStatus: str # Flag that indicates whether to filter the returned list by users organization membership status. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions., username: str(email) # Email address to filter users by. Not supported in deprecated versions.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/users\n@desc Add One MongoDB Cloud User to One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/groups/{groupId}/users/{userId}\n@desc Remove One MongoDB Cloud User from One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., userId: str # Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's `userId` or verify a user's status in the organization, use the [Return All MongoDB Cloud Users in One Project](#tag/MongoDB-Cloud-Users/operation/listProjectUsers) resource and filter by `username`.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/{groupId}/users/{userId}\n@desc Return One MongoDB Cloud User in One Project\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., userId: str # Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's `userId` or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by `username`.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PUT /api/atlas/v2/groups/{groupId}/users/{userId}/roles\n@desc Update Project Roles for One MongoDB Cloud User\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., userId: str # Unique 24-hexadecimal digit string that identifies the user to modify.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/users/{userId}:addRole\n@desc Add One Project Role to One MongoDB Cloud User\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., userId: str # Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's `userId` or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by `username`.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}/users/{userId}:removeRole\n@desc Remove One Project Role from One MongoDB Cloud User\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups., userId: str # Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's `userId` or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by `username`.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/groups/{groupId}:migrate\n@desc Migrate One Project to Another Organization\n@required {groupId: str # Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.}\n@returns(200) OK\n@errors {401: Unauthorized., 402: Payment Required., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/groups/byName/{groupName}\n@desc Return One Project by Name\n@required {groupName: str # Human-readable label that identifies this project.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs\n@desc Return All Organizations\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., name: str # Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs\n@desc Create One Organization\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/orgs/{orgId}\n@desc Remove One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 402: Payment Required., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}\n@desc Return One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/orgs/{orgId}\n@desc Update One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/activityFeed\n@desc Return Pre-Filtered Activity Feed Link for One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., eventType: [map] # Category of incident recorded at this moment in time.  **IMPORTANT**: The complete list of event type values changes frequently., maxDate: str(date-time) # End date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC., minDate: str(date-time) # Start date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/aiModelApiKeys\n@desc Return AI Model API Keys for One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/aiModelApiKeys/{apiKeyId}\n@desc Return Single AI Model API Key for One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., apiKeyId: str # The id of the API key to be retrieved.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/aiModelRateLimits\n@desc Return AI Model Rate Limits for One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/aiModelRateLimits/{modelGroupName}\n@desc Return Single AI Model Rate Limit for One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., modelGroupName: str # The name of the model group to be retrieved.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/apiKeys\n@desc Return All Organization API Keys\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/apiKeys\n@desc Create One Organization API Key\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\n@desc Remove One Organization API Key\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., apiUserId: str # Unique 24-hexadecimal digit string that identifies this organization API key.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\n@desc Return One Organization API Key\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., apiUserId: str # Unique 24-hexadecimal digit string that identifies this organization API key that  you want to update.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\n@desc Update One Organization API Key\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., apiUserId: str # Unique 24-hexadecimal digit string that identifies this organization API key you  want to update.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\n@desc Return All Access List Entries for One Organization API Key\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., apiUserId: str # Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\n@desc Create One Access List Entry for One Organization API Key\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., apiUserId: str # Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\n@desc Remove One Access List Entry for One Organization API Key\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., apiUserId: str # Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries., ipAddress: str # One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\n@desc Return One Access List Entry for One Organization API Key\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., ipAddress: str # One IP address or multiple IP addresses represented as one CIDR block to limit  requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as  192.0.2.0/24, use the URL-encoded value %2F for the forward slash /., apiUserId: str # Unique 24-hexadecimal digit string that identifies this organization API key for  which you want to return access list entries.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/associatedInvoices\n@desc Return Associated Invoices\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {month: int(int64) # The month for which to retrieve invoices (1-12). Defaults to current month., year: int(int64) # The year for which to retrieve invoices. Defaults to current year., includeLinkedOrgs: bool # Whether to include invoices from linked organizations. Defaults to false.}\n@returns(200) Associated invoices retrieved successfully\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\n@desc Create One Cost Explorer Query Process\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@returns(202) Accepted\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}\n@desc Return Usage Details for One Cost Explorer Query\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., token: str # Unique 64 digit string that identifies the Cost Explorer query.}\n@returns(200) OK\n@errors {102: Processing, 400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/events\n@desc Return Events from One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., eventType: [map] # Category of incident recorded at this moment in time.  **IMPORTANT**: The complete list of event type values changes frequently., includeRaw: bool=false # Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event., maxDate: str(date-time) # Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC., minDate: str(date-time) # Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/events/{eventId}\n@desc Return One Event from One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., eventId: str # Unique 24-hexadecimal digit string that identifies the event that you want to return.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., includeRaw: bool=false # Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/federationSettings\n@desc Return Federation Settings for One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/groups\n@desc Return All Projects in One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., name: str # Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/invites\n@desc Return All Invitations in One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., username: str(email) # Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/orgs/{orgId}/invites\n@desc Update One Invitation in One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/invites\n@desc Create Invitation for One MongoDB Cloud User in One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/orgs/{orgId}/invites/{invitationId}\n@desc Remove One Invitation from One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., invitationId: str # Unique 24-hexadecimal digit string that identifies the invitation.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/invites/{invitationId}\n@desc Return One Invitation in One Organization by Invitation ID\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., invitationId: str # Unique 24-hexadecimal digit string that identifies the invitation.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/orgs/{orgId}/invites/{invitationId}\n@desc Update One Invitation in One Organization by Invitation ID\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., invitationId: str # Unique 24-hexadecimal digit string that identifies the invitation.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/invoices\n@desc Return All Invoices for One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., viewLinkedInvoices: bool=true # Flag that indicates whether to return linked invoices in the `linkedInvoices` field., statusNames: [str] # Statuses of the invoice to be retrieved. Omit to return invoices of all statuses., fromDate: str(date) # Retrieve the invoices the `startDates` of which are greater than or equal to the `fromDate`. If omit, the invoices return will go back to earliest `startDate`., toDate: str(date) # Retrieve the invoices the `endDates` of which are smaller than or equal to the `toDate`. If omit, the invoices return will go further to latest `endDate`., sortBy: str(START_DATE/END_DATE)=END_DATE # Field used to sort the returned invoices by. Use in combination with `orderBy` parameter to control the order of the result., orderBy: str(desc/asc)=desc # Field used to order the returned invoices by. Use in combination of `sortBy` parameter to control the order of the result.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}\n@desc Return One Invoice for One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., invoiceId: str # Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv\n@desc Return One Invoice as CSV for One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., invoiceId: str # Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search\n@desc Return All Line Items for One Invoice by Invoice ID\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., invoiceId: str # Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}:generateAndDownloadReport\n@desc Generate and Download Invoice Report\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., invoiceId: str # Unique string that identifies the invoice for which to generate the report.}\n@returns(200) Report generated successfully\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/invoices/pending\n@desc Return All Pending Invoices for One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects\n@desc Return All Projects Available for Migration\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\n@desc Remove One Link-Token\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\n@desc Create One Link-Token\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/nonCompliantResources\n@desc Return All Non-Compliant Resources\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/resourcePolicies\n@desc Return All Atlas Resource Policies\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/resourcePolicies\n@desc Create One Atlas Resource Policy\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}\n@desc Delete One Atlas Resource Policy\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., resourcePolicyId: str # Unique 24-hexadecimal digit string that identifies an atlas resource policy.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}\n@desc Return One Atlas Resource Policy\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., resourcePolicyId: str # Unique 24-hexadecimal digit string that identifies an atlas resource policy.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}\n@desc Update One Atlas Resource Policy\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., resourcePolicyId: str # Unique 24-hexadecimal digit string that identifies an atlas resource policy.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) Ok\n@errors {400: Bad request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/resourcePolicies:validate\n@desc Validate One Atlas Resource Policy\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) Ok\n@errors {400: Bad request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/sandboxConfig\n@desc Return Sandbox Configuration IDs for an Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/sandboxConfig\n@desc Create One Sandbox Configuration for an Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/orgs/{orgId}/sandboxConfig/{sandboxConfigId}\n@desc Delete the Default Sandbox Configuration and Disable Sandbox\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., sandboxConfigId: str # Unique 24-hexadecimal digit string that identifies the sandbox configuration.}\n@returns(204) No Content\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/sandboxConfig/{sandboxConfigId}\n@desc Return Default Sandbox Configuration for One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., sandboxConfigId: str # Unique 24-hexadecimal digit string that identifies the sandbox configuration.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/orgs/{orgId}/sandboxConfig/{sandboxConfigId}\n@desc Update an Existing Sandbox Configuration\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., sandboxConfigId: str # Unique 24-hexadecimal digit string that identifies the sandbox configuration.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/serviceAccounts\n@desc Return All Organization Service Accounts\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/serviceAccounts\n@desc Create One Organization Service Account\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}\n@desc Delete One Organization Service Account\n@required {clientId: str # The Client ID of the Service Account., orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}\n@desc Return One Organization Service Account\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., clientId: str # The Client ID of the Service Account.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}\n@desc Update One Organization Service Account\n@required {clientId: str # The Client ID of the Service Account., orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList\n@desc Return All Access List Entries for One Organization Service Account\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., clientId: str # The Client ID of the Service Account.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList\n@desc Add Access List Entries for One Organization Service Account\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., clientId: str # The Client ID of the Service Account.}\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}\n@desc Remove One Access List Entry from One Organization Service Account\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., clientId: str # The Client ID of the Service Account., ipAddress: str # One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups\n@desc Return All Service Account Project Assignments\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., clientId: str # The Client ID of the Service Account.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets\n@desc Create One Organization Service Account Secret\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., clientId: str # The Client ID of the Service Account.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}\n@desc Delete One Organization Service Account Secret\n@required {clientId: str # The Client ID of the Service Account., secretId: str # Unique 24-hexadecimal digit string that identifies the secret., orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/settings\n@desc Return Settings for One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/orgs/{orgId}/settings\n@desc Update Settings for One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/teams\n@desc Return All Teams in One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/teams\n@desc Create One Team in One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/orgs/{orgId}/teams/{teamId}\n@desc Remove One Team from One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., teamId: str # Unique 24-hexadecimal digit string that identifies the team that you want to delete.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/teams/{teamId}\n@desc Return One Team by ID\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., teamId: str # Unique 24-hexadecimal digit string that identifies the team whose information you want to return.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/orgs/{orgId}/teams/{teamId}\n@desc Rename One Team\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., teamId: str # Unique 24-hexadecimal digit string that identifies the team that you want to rename.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\n@desc Return All MongoDB Cloud Users Assigned to One Team\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., teamId: str # Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.}\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., username: str(email) # Email address to filter users by. Not supported in deprecated versions., orgMembershipStatus: str # Organization membership status to filter users by. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions., userId: str # Unique 24-hexadecimal digit string to filter users by. Not supported in deprecated versions.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\n@desc Assign MongoDB Cloud Users in One Organization to One Team\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., teamId: str # Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\n@desc Remove One MongoDB Cloud User from One Team\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., teamId: str # Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user., userId: str # Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser\n@desc Add One MongoDB Cloud User to One Team\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., teamId: str # Unique 24-hexadecimal digit string that identifies the team to add the MongoDB Cloud user to.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser\n@desc Remove One MongoDB Cloud User from One Team\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., teamId: str # Unique 24-hexadecimal digit string that identifies the team to remove the MongoDB user from.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}\n@desc Return One Team by Name\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., teamName: str # Name of the team whose information you want to return.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/users\n@desc Return All MongoDB Cloud Users in One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., username: str(email) # Email address to filter users by. Not supported in deprecated versions., orgMembershipStatus: str # Organization membership status to filter users by. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/users\n@desc Add One MongoDB Cloud User to One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(201) Created\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint DELETE /api/atlas/v2/orgs/{orgId}/users/{userId}\n@desc Remove One MongoDB Cloud User from One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., userId: str # Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's `userId` or verify a user's status in the organization, use the [Return All MongoDB Cloud Users in One Organization](#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers) resource and filter by `username`.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(204) This endpoint does not return a response body.\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/orgs/{orgId}/users/{userId}\n@desc Return One MongoDB Cloud User in One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., userId: str # Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's `userId` or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by `username`.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PATCH /api/atlas/v2/orgs/{orgId}/users/{userId}\n@desc Update One MongoDB Cloud User in One Organization\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., userId: str # Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's `userId` or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by `username`.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint PUT /api/atlas/v2/orgs/{orgId}/users/{userId}/roles\n@desc Update Organization Roles for One MongoDB Cloud User\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., userId: str # Unique 24-hexadecimal digit string that identifies the user to modify.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/users/{userId}:addRole\n@desc Add One Organization Role to One MongoDB Cloud User\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., userId: str # Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's `userId` or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by `username`.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 409: Conflict., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole\n@desc Remove One Organization Role from One MongoDB Cloud User\n@required {orgId: str # Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access., userId: str # Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's `userId` or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by `username`.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/rateLimits\n@desc Return All Rate Limits\n@optional {itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., groupId: str # Unique 24-hexadecimal digit string that identifies the Atlas Project to request rate limits for. When this parameter is provided, only group scoped endpoint sets are returned and the limits returned are applicable to the specified project. The requesting user must have the Project Read Only role for the specified project., orgId: str # Unique 24-hexadecimal digit string that identifies the Atlas Organization to request rate limits for. When this parameter is provided, only organization scoped endpoint sets are returned and the limits returned are applicable to the specified organization. The requesting user must have the Organization Read Only role for the specified organization., userId: str # A string that identifies the Atlas user to request rate limits for. The ID can for example be the Service Account Client ID or the API Public Key. When this parameter is provided, only user scoped endpoint sets are returned and the limits returned are applicable to the specified user. The requesting user must be the same as the specified user., ipAddress: str # An IP address to request rate limits for. When this parameter is provided, only IP scoped endpoint sets are returned and the limits returned are applicable to the specified IP address. The requesting user must have the same IP address as the one provided in the request., name: str # Filters the returned endpoint sets by the provided endpoint set name. Multiple names may be provided, for example `/rateLimits?name=Name1&name=Name2`. For names that use spaces, replace the space with its URL-encoded value (`%20`)., endpointPath: str # Filters the returned endpoint sets by the provided endpoint path. Multiple paths may be provided, for example `/rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters&endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F`. Replace `/`, `{` and `}` with their URL-encoded values (`%2F`, `%7B` and `%7D` respectively).}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/rateLimits/{endpointSetId}\n@desc Return One Rate Limit\n@required {endpointSetId: str # The ID of the rate limit endpoint set.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format., groupId: str # Unique 24-hexadecimal digit string that identifies the Atlas Project to request rate limits for. When this parameter is provided, the limits returned are applicable to the specified project. The requesting user must have the Project Read Only role for the specified project., orgId: str # Unique 24-hexadecimal digit string that identifies the Atlas Organization to request rate limits for. When this parameter is provided, the limits returned are applicable to the specified organization. The requesting user must have the Organization Read Only role for the specified organization., userId: str # A string that identifies the Atlas user to request rate limits for. The ID can for example be the Service Account Client ID or the API Public Key. When this parameter is provided, the limits returned are applicable to the specified  user. The requesting user must be the same as the specified user., ipAddress: str # An IP address to request rate limits for. When this parameter is provided, the limits returned are applicable to the specified IP address. The requesting user must have the same IP address as the one provided in the request.}\n@returns(200) OK\n@errors {400: Bad Request., 401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/skus\n@desc Return All Stock Keeping Units\n@optional {includeCount: bool=true # Flag that indicates whether the response returns the total number of items (`totalCount`) in the response., itemsPerPage: int=100 # Number of items that the response returns per page., pageNum: int=1 # Number of the page that displays the current set of the total objects that the response returns., pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/skus/{skuId}\n@desc Return One Stock Keeping Unit\n@required {skuId: str # Unique identifier of the SKU to retrieve.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/unauth/controlPlaneIPAddresses\n@desc Return All Control Plane IP Addresses\n@returns(200) OK\n@errors {429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint POST /api/atlas/v2/users\n@desc Create One MongoDB Cloud User\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/users/{userId}\n@desc Return One MongoDB Cloud User by ID\n@required {userId: str # Unique 24-hexadecimal digit string that identifies this user.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@endpoint GET /api/atlas/v2/users/byName/{userName}\n@desc Return One MongoDB Cloud User by Username\n@required {userName: str # Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.}\n@optional {pretty: bool=false # Flag that indicates whether the response body should be in the prettyprint format.}\n@returns(200) OK\n@errors {401: Unauthorized., 403: Forbidden., 404: Not Found., 429: Too Many Requests., 500: Internal Server Error.}\n\n@end\n"}